# Self-Hosting

## Requirements

1. [Node.js v16.6.0](https://nodejs.org/) or newer.
2. A [MySQL](https://www.mysql.com/) or [MariaDB](https://mariadb.org/) database.

## Setup

1. Copy example config files.
   * Navigate to the `config` folder of this project.
   * Copy all files ending in `.example.json` and remove the `.example` from the copied file names.
     * Ex: `config.example.json` should be copied and renamed as `config.json`.
2. Obtain a bot token.
   * You'll need to create a new bot in your [Discord Developer Portal](https://discord.com/developers/applications/).
     * See [here](https://www.writebots.com/discord-bot-token/) for detailed instructions.
     * At the end you should have a **bot token**.
3. Modify the config file.
   * Open the `config/config.json` file.
   * You'll need to edit the following values:
     * `client.id` - Your discord bot's [user ID](https://techswift.org/2020/04/22/how-to-find-your-user-id-on-discord/).
     * `client.token` - Your discord bot's token.
     * `database.host`- The ip address that your database is running on (or `localhost`)
     * `database.database` - The name of the database to use.
     * `database.username` - The username to use when accessing the database.
     * `database.password` - The password of the user accessing the database.
4. Install packages.
   * Navigate into the downloaded source files and type `npm install`.
5. Register commands.
   * In order to use slash commands, they first [have to be registered](https://discordjs.guide/interactions/registering-slash-commands.html#registering-slash-commands).
   * Type `npm run commands:register` to register the bot's commands.
     * Run this script any time you change a command name, structure, or add/remove commands.
     * This is so Discord knows what your commands look like.
     * It may take up to an hour for command changes to appear.

## Running

You can run the bot in multiple modes:

1. Normal Mode
   * Type `npm start`.
   * Starts a single instance of the bot.
2. Manager Mode
   * Type `npm run start:manager`.
   * Starts a shard manager which will spawn multiple bot shards.
3. PM2 Mode
   * Type `npm run start:pm2`.
   * Similar to Manager Mode but uses [PM2](https://pm2.keymetrics.io/) to manage processes.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://friend-time.arilyn.cc/misc/self-hosting.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.