Self-hosting

This guide sets you up with a self-hosted Fluxcord bot.

Prerequisites

Docker/Podman (recommended)

• A system with Docker and Docker Compose (or Podman and Podman Compose)

  Caution

  Podman support is not tested by the devs. You can get support on it but because we don’t run Podman, we might have difficulties supporting you.

Bare-metal

Caution

After Fluxcord releases voice support, if you want voice, the only supported way is using Docker or Podman.

• A system with Node.js (>= 20)
• A package manager such as pnpm (recommended) or npm.
• Both Fluxer and Discord has Developer Mode enabled (go to Settings > Advanced and enable “Developer Mode”)

Installing

1. Firstly, clone the Fluxcord repository.

   $ git clone https://git.gay/Fluxcord/core Fluxcord

2. Then, install dependencies.

   $ cd Fluxcord
   $ pnpm install # (BARE METAL ONLY) or npm install if you didn't install pnpm

Making a bot (Discord)

1. Go to https://discord.com/developers/applications (log in if needed)
2. Go to Applications, and create an application by clicking “New Application”.
3. Name your bot, accept the terms, and click “Create”.
4. Copy the Application ID. We’ll need that, then go to Bot, then click “Reset Token”. Verify your Multi-factor Authentication if needed.
5. Copy the generated token, we’ll also need that.
6. Scroll down and enable “Message Content Intent”.

Making a bot (Fluxer)

1. Go to Settings > Applications, and create an application by clicking “Create Application”.
2. Name your bot, and click “Create”.
3. Copy the Application ID. We’ll need that in the next step.
4. Click “Reset Token”. Verify your Multi-factor Authentication if needed.
5. Copy the generated token, we’ll need that.

Making a community for temporary emojis (Fluxer)

This is so the bot can store temporary bridged emojis. If you want to use an existing community you can skip to step 3.

1. Click “Add a Community”, then “Create Community”.
2. Name it something, and click “Create Community”.
3. Now, invite the Fluxer bot by using this link. Replace the [APP_ID] to the Application ID we got on the previous step.

   https://web.fluxer.app/oauth2/authorize?client_id=[APP_ID]&scope=bot&permissions=2260735261797440

4. After that, right click the community and click “Copy Community ID”

Creating the config file

1. Copy the example config file and edit it:

   $ cp config.example.js config.js
   $ nano config.js # or vi, gedit, kwrite, emacs...

2. Put all the things that we got on the previous steps on it.
3. Add your Discord and Fluxer accounts on the Admin account IDs by right clicking your user and click “Copy User ID”, then pasting it on the AdminAccountIds field.
4. If bare-metal: Edit the data directory to where you want the Fluxcord data to be stored. By default it will store it to /data which is not recommended for bare-metal setups. Do not touch this if on Docker.

Running the bot

Docker/Podman (recommended)

1. Run the bot.

   $ docker compose up -d --build # or podman-compose up -d --build

2. To see logs, just run

   $ docker compose logs -f

Bare-metal

1. Run the migrations. Very important.

   $ pnpm migrate # or npm run migrate

2. Now, run the bot.

   $ pnpm start # or npm run start

Note

You might want to put Fluxcord somewhere that can automatically start and restart it if it exits, e.g. systemd service.

Inviting the bot

The bot will output the invite links on the log/console. Those are the invite codes you use to invite the bot to your server.

After that, go back to Getting Started and follow steps 2-4.