https://github.com/benweissmann/discord-permission-manager

Manage discord permissions with Terraform
https://github.com/benweissmann/discord-permission-manager

Last synced: about 17 hours ago
JSON representation

Manage discord permissions with Terraform

• Host: GitHub
• URL: https://github.com/benweissmann/discord-permission-manager
• Owner: benweissmann
• Created: 2024-01-29T05:35:57.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-01-30T00:43:48.000Z (8 months ago)
• Last Synced: 2024-01-30T07:31:18.088Z (8 months ago)
• Language: TypeScript
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Overview

This tool allows you to view and edit the permissions for categories and channels in a Discord server via Terraform.

# Setup

This repo uses [asdf](https://asdf-vm.com/) to manage Node.JS and Terraform versions. If you have asdf set up, along with with the [Terraform](https://github.com/asdf-community/asdf-hashicorp) (`asdf plugin-add terraform https://github.com/asdf-community/asdf-hashicorp.git`) and [NodeJS](https://github.com/asdf-vm/asdf-nodejs) (`asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git`) plugins, you can install and use the correct versions with:

```

asdf install

```

Otherwise, manually install NodeJS 20.11.0 and Terraform 1.7.1 (or use other versions at your own risk).

Then, install the NodeJS dependencies:

```

npm install

```

# Setting up a bot token

You'll need to provide your [Bot Token](https://discordjs.guide/preparations/setting-up-a-bot-application.html#your-bot-s-token) via env var (you should set it as `DPM_BOT_TOKEN` for this script, and also as `TF_VAR_discord_token` for the Terraform config):

```

export DPM_BOT_TOKEN=xxxx

export TF_VAR_discord_token=xxxx # the name is case-sensitive!

```

This tool requires the permission to list all servers users, which is considered a "privileged intent". In your application, navigate to the "Bot" page, find the "Privileged Gateway Intents" section, and toggle on "Server Members Intent"

Then, [add your bot to your Discord server](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#creating-and-using-your-invite-link). Select `bot` permissions, and then select `Administrator` for the "Bot Permissions" that appear after selecting `bot` (you might be able to run this tool with lower permissions, but Bots can only grant permissions they themselves have, so your bot will need at least every permission you want it to manage).

Export the [ID of your Discord server](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID):

```

export DPM_SERVER_ID=xxx

```

# Running the tool

Now, you can generate the Terraform for your server's current configuration:

```

npm start

```

This will:

- Delete old generated files (after confirming, if they exist)

- Use the Discord API to generate `./terraform/imports.tf` with imports for every category/category permission/channel/channel permission, `./terraform/data.tf` with data blocks for users/roles used in permissions, and `./terraform/channels.tf` with Terraform declarations for each channel / category.

From there, you can run `cd terraform; terraform init; terraform apply` to confirm that there are not pending changes and the terraform was correctly generated, and then apply to carry out the import. DO NOT make any edits to the `channels.tf` file before doing this first apply to finish the imports.

Then, edit `terraform/channels.tf` and run `cd terraform; terraform apply` to preview and apply your changes.