VoiceTwine

Create simple, dynamic voice channels to remove clutter from your Discord server!

Navigation

• Installation
  • Manual Installation
  • Pterodactyl Installation
• Updating
  • Manual Installation
  • Pterodactyl Installation

Installation

Manual Installation

Installation of VoiceTwine requires a basic understanding of server administration & Unix commands.

NodeJS and NPM are required to run VoiceTwine. Install the latest on the NodeJS website. A recent MariaDB installation is also required, with a dedicated username, password, and database set up for VoiceTwine.

Download a VoiceTwine release from GitHub or clone the git repository using the following command:

git clone https://github.com/Twijn/VoiceTwine.git

Copy the .example.env file to .env

cp .example.env .env

Edit the .env file with your favorite file editing tool

nano .env

Update the MariaDB credentials to point to a user created on your Maria installation, and fill out the discord client ID, secret, and token below.

# Environment Settings
NODE_ENV=production
LOG_LEVEL=info

# MariaDB Settings       # v CHANGE THESE AS NEEDED v
MARIADB_HOST=127.0.0.1
MARIADB_PORT=3306
MARIADB_USER=twine
MARIADB_PASS=Password
MARIADB_DB=voicetwine

# Discord Settings       # v CHANGE THESE AS NEEDED v
DISCORD_CLIENT_ID=discord_client_id
DISCORD_CLIENT_SECRET=discord_client_secret
DISCORD_TOKEN=discord_token

Install VoiceTwine dependencies with NPM

npm ci

Build VoiceTwine

npm run build

Create and seed the database

npm run migrate

Start VoiceTwine

npm start

Now you're (effectively) done!

It's recommended to use PM2 or systemd to start and restart the application, as shown below:

Creating & opening service file:

nano /etc/systemd/system/voicetwine.service

Copy & paste service details:

[Unit]
Description=VoiceTwine - Create simple, dynamic voice channels to remove clutter from your Discord server!
Documentation=https://github.com/Twijn/VoiceTwine
After=network.target

[Service]
Type=simple
User=root
ExecStart=/usr/bin/node /path/to/repo/dist/app.js
Restart=on-failure

[Install]
WantedBy=multi-user.target

Make sure to edit the /path/to/repo to point to your installation path.

To run the service on system restart, use the following command:

sudo systemctl enable voicetwine

Pterodactyl Installation

We now have a Pterodactyl egg available for VoiceTwine!

To use it, import the above egg into your Panel and create a new server. You'll want to have a MariaDB set up prior to that, ensuring that it's accessible by the Pterodactyl network.

Updating

Manual Installation: Updating

Update source code by downloading a release or using git pull.

Install any missing/updated dependencies

npm ci

Build source code

npm run build

Update the database

npm run migrate

You may now restart the application!

Pterodactyl Installation: Updating

You can update your Pterodactyl installation of VoiceTwine by reinstalling the server.