XenForo-Discord-Bot

KO | EN

gitlite — search

#javascript #react #ai #typescript #golang #android #machine-learning #rust #linux #java #kubernetes #security #openai #open-source

XenForo-Discord-Bot

(★ 9)

No description available.

XenForo-Discord-Bot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Dependency status][david-dm-image]][david-dm-url] [![devDependency status][david-dm-dev-image]][david-dm-dev-url] [![optionalDependency Status][david-dm-optional-image]][david-dm-optional-url]

# XenForo Discord Bot

This is a XenForo Discord bot that manages the users in your Discord server, granting them access to the channels and roles based off their permissions on the related XenForo forum. Users will be unable to chat if they're not a registered member of the forum. Forum Moderators and Admins will be granted their respective roles on Discord.

* [First time install for Development](#first-time-install-for-development)
* [Production setup](#production-setup)
* [Forum setup](#form-setup)
* [Discord setup](#discord-setup)
* [Group / Roles setup](#group-roles-setup)
* [Editing the configuration options](#editing-the-configuration-options)
    * [Development](#development)
    * [Others](#others)
* [Environment variables](#environment-variables)

# First time install for Development

* Download and install [NodeJS][nodejs] version `5.x` or higher
* Download and install [Python 2.7.3][python] and ensure it's available in the command line
* Download and install [Redis] - [Windows installer][redis-windows]
* Download and install [XenForo]
* Clone the repo
* Follow the [Node Gyp setup guide]
* Run `npm install grunt-cli babel-cli mocha node-gyp -g` from an elevated command runner
* Run `npm install` from the repo base directory
* Create a [local config file](#development) with the appropriate settings for Discord/XenForo/etc.
* Run `node start.js` to start the application

# Production setup
Ensure that when installing OS packages you're getting the latest version from the package's maintainer and not the version as part of the OS's default package repository

* Linux OS
* Download and install [NodeJS][nodejs] version `5.x` or higher
* Download and install the latest [Redis]
* Download and install the latest [XenForo]
    * Once all set up, make sure to set the appropriate `environment variables`
* Set up a [DataDog] agent on the server
    * Hook up MySQL, and Redis [integrations] if the server is not already hooked up
* Set up a process to start/restart `start.js` found in the application root with the `environment variables` mentioned below
    * Application should start on system boot-up after MySQL and Redis are running
    * Application should be restarted if the process exits unexpectedly
    * Log the application output to a file in the application directory

# Forum setup

Add a new custom field on the XenForo forum instance

* Field ID: discordid
* Title: Discord ID
* Display Location: Personal Details
* Field type: Single-line text box
* General Options:
    * *NOT* moderator editable
    * *NOT* viewable on profile pages
    * *NOT* viewable in message user info
    
# Discord setup

Create a user account for the bot to use, and join it to the discord server you wish it to manage. Ensure it has been granted all permissions on the server/channels

# Group / roles setup

Edit the [Definitions][definitions] file to your heart's content for the roles/channels you'd like to have

## Unique server ID
Each server instance needs to have a unique ID for the server it's running on. By default this is a generated GUID, however, you can specify an ID for it to use instead of the generated one by creating a `serverid.txt` file in the root of the application directory containing the ID you'd like it to use to identify itself with. This ID is used in a `server:<id>` tag in all the datadog metrics

# Editing the configuration options

### Development
All development configuration options are controlled from the [config.js] file, which can be overriden locally by copying and renaming the [local] file in `/config` to `local.js`. All environment variables can be ignored.

### Others
Critical non-development configurations such as the database are controlled through the system environment variables and **must be set** otherwise the application will **not** start

**Required variables:**

* NODE_ENV **EXTREMELY IMPORTANT**
* SERVER_ENV
* DB_USER
* DB_PASSWORD
* DB_DATABASE
* DISCORD_EMAIL
* DISCORD_PASSWORD
* DISCORD_SERVER

# Environment variables

| Name  | Description |
| ------------- | ------------- |
| NODE_ENV | Defaults to `development` for local environment, otherwise set to `production` |
| SERVER_ENV | Configuration to load, defaults to `development` (set to `production` if not a local development environment) |
| PORT | Port to start the application on, defaults to `3000` for `development` or `80` otherwise ***optional*** |
| DB_HOST | Set the HOST for the database to connect to ex: `127.0.0.1` ***optional*** |
| DB_USER | Set the USERNAME for the database ex: `xenforo-user` |
| DB_PASSWORD | Set the PASSWORD for the database user |
| DB_PORT | Set the PORT for the database, defaults to `3306` ***optional*** |
| DB_DATABASE | Set the DATABASE NAME to connect to ex: `xenforo-database` |
| DISCORD_EMAIL | Discord user email for the bot to use |
| DISCORD_PASSWORD | Password associated with the Discord account to use |
| DISCORD_SERVER | Name of the Discord server the bot is supposed to manage |
| MOCHA_REPORTER | Used to set the test reporter ***(ONLY USED FOR UNIT TESTS)*** |
| MOCHA_URL | Used to configure the URL to test on ***(ONLY USED FOR UNIT TESTS)*** |
| REDIS_HOST | Redis host, defaults to `localhost` ***optional*** |
| REDIS_PORT | Redis host port, defaults to `6379` ***optional*** |
| NODE_PATH | Path of folder that contains NodeJS install, defaults to `/usr/local/bin/node` ***optional*** |

[nodejs]: http://nodejs.org/
[python]: http://www.python.org/download/releases/2.7.3#download
[config.js]:config/config.js
[local]:config/example.local.js
[definitions]:config/Definitions.js
[Redis]:http://redis.io/
[redis-windows]:https://github.com/MSOpenTech/redis/releases
[DataDog]:https://app.datadoghq.com/
[integrations]:https://app.datadoghq.com/account/settings
[MySQL]:http://www.mysql.com/
[XenForo]:https://xenforo.com/
[Node Gyp setup guide]:https://github.com/TooTallNate/node-gyp#installation
[david-dm-url]:https://david-dm.org/EnzoMartin/XenForo-Discord-Bot
[david-dm-image]:https://david-dm.org/EnzoMartin/XenForo-Discord-Bot.svg?style=flat-square
[david-dm-dev-url]:https://david-dm.org/EnzoMartin/XenForo-Discord-Bot#info=devDependencies
[david-dm-dev-image]:https://david-dm.org/EnzoMartin/XenForo-Discord-Bot/dev-status.svg?style=flat-square
[david-dm-optional-url]:https://david-dm.org/EnzoMartin/XenForo-Discord-Bot#info=optionalDependencies
[david-dm-optional-image]:https://david-dm.org/EnzoMartin/XenForo-Discord-Bot/optional-status.svg?style=flat-square

XenForo-Discord-Bot

XenForo-Discord-Bot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

XenForo-Discord-Bot

XenForo-Discord-Bot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README