メインコンテンツまでスキップ
バージョン: v4.1

Docker を使用する

プリビルドされているDockerイメージ を使用して簡単にボットを実行できます。

必要な環境​

このボットを Docker で利用するためには、以下の環境が必要です。

  • Dockerを利用できること
  • CPUのアーキテクチャがAMD64またはARM64

設定の手順​

1. イメージをPull​

イメージをPullします。

docker pull ghcr.io/mtripg6666tdr/discord-music-bot:latest
メモ

バージョンを指定してPullすることもできます。
docker pull ghcr.io/mtripg6666tdr/discord-music-bot:3.4.0
イメージが用意されているのは、v3.4.0以降です。

危険

GitHub Packagesに公開されているパッケージのうち、3.4.0のようなバージョンの文字列でタグ付けされていないバージョンは、開発段階のイメージですので、使用しないでください。

メモ

イメージは、リリースノートが公開されてから、約30～40分後にビルドが完了し公開されます。

2. ボットの設定​

ボットを実行するには、ボットのトークンを含む各種設定が必要です。「ボットの設定について」を参考に、設定を行ってください。
設定ファイルは適当な場所に配置します。その際はファイルのパスを控えておいてください。 .envの内容は.envを使用せずとも、コマンドラインで指定することもできます。

3. 各種フォルダの準備​

  • config.jsonでdebugをtrueにした場合は、ログ用のフォルダを用意して、パスを控えておいてください。
  • config.jsonでcacheLevelをpersistentにした場合は、キャッシュファイルを保存する用のフォルダを用意して、パスを控えておいてください。

4. 実行​

基本のコマンドの形式は以下のようになります。

docker container run --mount type=bind,source="<config.jsonのパス>",target=/app/config.json --mount type=bind,source="<ログ用のフォルダのパス>",target=/app/logs --mount type=bind,source="<キャッシュフォルダのパス>",target=/app/cache --env-file "<.envのパス>" --name <インスタンスの名前> --detach ghcr.io/mtripg6666tdr/discord-music-bot
  • <.envのパス>などは、適宜読みかえてください。
  • debugがfalseの場合は、--mount type=bind,source="<ログ用のフォルダのパス>",target=/app/logsは不要です。
  • cacheLevelがmemoryの場合は--mount type=bind,source="<キャッシュフォルダのパス>",target=/app/cacheは不要です。
  • .envの内容をコマンドラインで渡す場合
docker container run --mount type=bind,source="<config.jsonのパス>",target=/app/config.json --env TOKEN=<Discordのトークン> --name <インスタンスの名前> --detach ghcr.io/mtripg6666tdr/discord-music-bot

コマンドの使用方法に関する詳細はDockerの公式ドキュメントを参照してください。

起動と停止​

  • 起動するには以下のコマンドを使用します。

    docker container start <インスタンスの名前>

    コマンドの使用方法に関する詳細はDockerの公式ドキュメントを参照してください。

  • 停止するには以下のコマンドを使用します。

    docker container stop <インスタンスの名前>

    コマンドの使用方法に関する詳細はDockerの公式ドキュメントを参照してください。

更新​

ボットを更新するには、コンテナを削除してから、上の手順にしたがって再度コンテナを作成します。

# 稼働している場合は、停止します。
docker container stop <インスタンスの名前>
# コンテナの削除
docker container rm <インスタンスの名前>