Bot configuration

Here you will find a complete guide to configure your SteamSpeak bot. Follow the steps below, and you'll get it running in less than 20 minutes. 🚀

Initial configuration folder structure

All the configuration files of SteamSpeak are stored in the packages/server/src/config directory. They are separated into multiple files to make your installation process as delightful as possible.

📦packages
 ┗ 📂server
 ┃ ┣ 📂node_modules
 ┃ ┣ 📂src
 ┃ ┃ ┣ 📂config
 ┃ ┃ ┃ ┣ 📜cache.sample.ts
 ┃ ┃ ┃ ┣ 📜database.sample.ts
 ┃ ┃ ┃ ┣ 📜language.sample.ts
 ┃ ┃ ┃ ┣ 📜steam.sample.ts
 ┃ ┃ ┃ ┣ 📜teamspeak.sample.ts
 ┃ ┃ ┃ ┣ 📜website.sample.ts
 ┃ ┃ ┃ ┗ ...
 ┃ ┃ ┣ 📂core
 ┃ ┃ ┣ 📂locales
 ┃ ┃ ┣ 📂tests
 ┃ ┃ ┣ 📂types
 ┃ ┃ ┗ 📂utils
 ┃ ┗ ...
 ┗ ...

Create the configuration files

You may notice that all the configuration files name ends with .sample.js. This is to prevent an accidental configuration push to GitHub.

To rename those configuration files, execute the following command in your SteamSpeak directory:

~/SteamSpeak make config

explain this command

This command will generate these new files/directories inside packages/server/src/config directory.

📦packages
 ┗ 📂server
 ┃ ┣ 📂src
 ┃ ┃ ┣ 📂config
 ┃ ┃ ┃ ┣ + 📂old.config
 ┃ ┃ ┃ ┣ + 📜cache.ts
 ┃ ┃ ┃ ┣ + 📜database.ts
 ┃ ┃ ┃ ┣ + 📜language.ts
 ┃ ┃ ┃ ┣ + 📜steam.ts
 ┃ ┃ ┃ ┣ + 📜teamspeak.ts
 ┃ ┃ ┃ ┣ + 📜website.ts
 ┃ ┃ ┃ ┗ ...
 ┃ ┃ ┗ ...
 ┃ ┗ ...
 ┗ ...

Edit your configuration files

Do not share any of the following configuration files to anyone. Someone can literally break your TeamSpeak/Steam hard work in less than 1 minute.

Navigate to packages/server/config directory and modify previusly generated files.

• Cache
• Database
• Language
• Steam
• TeamSpeak
• Website

SteamSpeak uses Redis as caching solution. Follow this tutorial to get it working on your server.

∼/SteamSpeak/packages/server/src/config/cache.ts

export default {
    host: '127.0.0.1',
    port: 6379,
    debug: false
};

3 items

required

• stringrequired

  host

  The host to connect to.

  • Default: "127.0.0.1"
  • View examples
• numberrequired

  port

  The port of the Redis instance.

  • Default: 6379
  • View examples
• booleanrequired

  debug

  Debug redis connection.

  • Default: false
  • View examples

How was it? Did this tutorial work?  Yes  No