diff --git a/wiki/Home.md b/wiki/Home.md index 2a67a3d..93f15cf 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -1,3 +1,37 @@ +# Setup + +## Discord Bot + +- Go to https://discord.com/developers/applications and create your application +- Go to "Bot" in your newly created application and click "Add a bot" +- Give it a name which later will be your bots name, optionally upload an image which will be its profile image +- Disable "Public Bot", enable the "Privileged Gateway Intents" +- Copy and note your bots token (you will need to enter it into the `bot_token` field of the config + +## Create a config + +- Create a new text file named `config.yaml` (you can name it otherwise, just adapt the rest of the examples) +- Put the text shown below ("Config format") into it +- Adjust the `module_configs` + +## Start the bot + +### Using Docker + +```console +# docker pull luzifer/discord-community +# docker run --rm -ti -v /path/to/your/configfile:/config -e CONFIG=/config/config.yaml luzifer/discord-community +``` + +### Using Binary + +- Download the latest release from the [release page](https://github.com/Luzifer/discord-community/releases) +- Unpack the archive you've downloaded +- Start the bot in the same directory as your config (or provide a path to the config): +```console +# ./discord-community --config=config.yaml +``` + # Config format ```yaml diff --git a/wiki/Home.md.tpl b/wiki/Home.md.tpl index 604f73a..cd34dd8 100644 --- a/wiki/Home.md.tpl +++ b/wiki/Home.md.tpl @@ -1,3 +1,37 @@ +# Setup + +## Discord Bot + +- Go to https://discord.com/developers/applications and create your application +- Go to "Bot" in your newly created application and click "Add a bot" +- Give it a name which later will be your bots name, optionally upload an image which will be its profile image +- Disable "Public Bot", enable the "Privileged Gateway Intents" +- Copy and note your bots token (you will need to enter it into the `bot_token` field of the config + +## Create a config + +- Create a new text file named `config.yaml` (you can name it otherwise, just adapt the rest of the examples) +- Put the text shown below ("Config format") into it +- Adjust the `module_configs` + +## Start the bot + +### Using Docker + +```console +# docker pull luzifer/discord-community +# docker run --rm -ti -v /path/to/your/configfile:/config -e CONFIG=/config/config.yaml luzifer/discord-community +``` + +### Using Binary + +- Download the latest release from the [release page](https://github.com/Luzifer/discord-community/releases) +- Unpack the archive you've downloaded +- Start the bot in the same directory as your config (or provide a path to the config): +```console +# ./discord-community --config=config.yaml +``` + # Config format ```yaml