/remote-discord-muter

Remotely mute voice chat from outside a LAN 🎙️🌐

Primary LanguageRustApache License 2.0Apache-2.0

How to use?

Only in a local network

  1. Build and run the Dockerfile in the root (Pass '-p 8080:8080' at runtime)
  2. Copy .example.env in /muter and rename it to .env
  3. Fill in the .env (details)
  4. Run 'npm i'
  5. Run 'npx ts-node main.ts'
  6. Access to localhost:8080 with a web browser

Even from outside a local network

To make it available from outside local networks, a server is required.

Here's how to deploy with render.com. (free)

  1. Fork this repository
  2. Create an account on render.com
  3. Go to your dashboard
  4. Go to the page to create a new web service

If you cannot find the forked repository, configure your GitHub account.

  1. After confirming that runtime is docker, create

From here, please work on a computer that is actually running Discord Desktop.

  1. Copy .example.env in /muter and rename it to .env
  2. Fill in the .env (details)
  3. Run 'npm i'
  4. Run 'npx ts-node main.ts'
  5. Access to the deployed server with a web browser (e.g. xxx.onrender.com)

Setting environment variables

Discord related

The environment variables DISCORD_CLIENT_ID, DISCORD_CLIENT_SECRET and DISCORD_REDIRECT_URI must be set to run muter.

These can be obtained via the Discord Developer Portal.

Others

SERVER_HOST_PORT and WEBSOCKET_SCHEME need not be changed from .example.env if used in a local network.

If used from outside local networks, SERVER_HOST_PORT should be the hostname of the server you deployed to.

If you are deploying on render.com, change WEBSOCKET_SCHEME to wss.