> For the complete documentation index, see [llms.txt](https://docs.andrezzz.pt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.andrezzz.pt/whmcs/addons/link-discord.md). # Link Discord Would you ever imagine, if you could have your WHMCS Clients verified with a Discord account and give them, in real-time, roles inside your guild? Now you can! By an affordable price.

{% hint style="info" %} Discord and related names, marks, emblems and images are registered trademarks of their respective owners. {% endhint %} ## Screenshots

## Installation 1. Download the release from the latest email you've received;

### Discord 1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) and create a new Application (if you have already, skip this step);

2. Click in the `OAuth2` tab, copy and save the `Client ID` and the `Client Secret` (if you don't have the button, reset it);

3. Add a new Redirect using the URL that you saved in [WHMCS - Step 3](#whmcs) (skip this step if you haven't set up the WHMCS side yet);

4. Click in the `Bot` tab, create the Bot if you don't have and save the `Token` (if you don't have the copy button, reset it). For security reasons, ensure that `Public Bot` it is off;

5. Add the Bot, by simply going to this [URL](https://discord.com/oauth2/authorize?scope=bot\&permissions=8\&client_id=CLIENTID) and editing in the Search Bar the `CLIENTID` to yours. Select the desired Guild, click on Continue and Authorize (you need to do this for every Guild you wanna add). Don't change the permission code so that it can work with other features.

### Backend {% tabs %} {% tab title="cPanel" %} {% hint style="success" %} This is the best solution if you use cPanel on shared web hosting. {% endhint %} 1. Open your cPanel, search for `Setup Node.js App` and open it;

2. Click on New Application, Setup like below (you can choose any domain) and Create;

3. Upload the `BACKEND` folder to `/AndrezzzLinkDiscord` (normally, when you open FTP/File Manager, it opens the `public_html` folder, you need to go back);

4. Edit the `config.json` file, with the information you gathered before in the [Discord Installation](/whmcs/addons/link-discord.md#discord) and change the `port` to `3000`;

5. Go back to the Application that you just created, refresh the page and click on `Run NPM Install`;

6. Click on `Restart` and then test it by clicking the `Open` button, if it doesn't redirect to my Website, then some mistake was made. Please check every single step. If it's all working, you can copy the URL in the Search Bar and save it to [WHMCS - Step 3](#whmcs).

{% endtab %} {% tab title="Pterodactyl" %} {% hint style="warning" %} If you can't allow IPs to make connections to the outside (Allow specific IPs for Outgoing Traffic in some ports), please try one of the following ports, and for more information, please check the [FAQ](#couldnt-connect-to-server): * 2082-2083; * 2086-2087; * 4081-4085; * 8080-8088; * 8888\. {% endhint %} 1. Create a new Server using the above ports, or if you manage the Hosting where the WHMCS is, you can choose any port.\ Choose the Egg `discord.js generic` and at least the image that contains `nodejs_16`in the name (if you don't have it, download it from their GitHub).\ Change the Bot.js file to `app.js`;

2. Wait until the server is created and upload the files using FTP or the File Manager (if you use the File Manager, please ZIP the `BACKEND` folder contents first, then `Unarchive`);

3. Edit the `config.json` file, with the information you gathered before in the [Discord Installation](/whmcs/addons/link-discord.md#discord) and change the `port` to the one you chose before;

4. Start/Restart the Server and wait until you see the logs below. Test it by clicking on the IP:Port on `Address` and pasting it at the Search Bar. If it doesn't redirect to my Website, then some mistake was made. Please check every single step. If it's all working, you can copy the URL in the Search Bar and save it to [WHMCS - Step 3](#whmcs).

{% endtab %} {% tab title="Self Hosted (SSH)" %} {% hint style="danger" %} If you don't have Node.js installed yet, or if you already have, make sure you have at least v16.11.0. You can check this by running in your Terminal: {% code fullWidth="false" %} ```shell node --version ``` {% endcode %} {% endhint %} {% hint style="warning" %} If you can't allow IPs to make connections to the outside (Allow specific IPs for Outgoing Traffic in some ports), please try one of the following ports, and for more information, please check the [FAQ](#couldnt-connect-to-server): * 2082-2083; * 2086-2087; * 4081-4085; * 8080-8088; * 8888\. {% endhint %} 1. Open your SSH Terminal and create a folder for the Bot. For example, you can use `/opt/AndrezzzLinkDiscord`;

2. Upload the `BACKEND` folder to the one you've just created, `/opt/AndrezzzLinkDiscord` (normally, when you open FTP, it opens the user folder, you need to go to the desired folder);

3. Edit the `config.json` file, with the information you gathered before in the [Discord Installation](/whmcs/addons/link-discord.md#discord) and change the `port` to the one you wanna use (don't forget to open it in your Firewall, if any, to allow Inbound Connections);

4. Install the necessary packages for the Backend to run by doing `npm i` in your Terminal, in the same folder, you have your `config.json`; 5. Edit the `AndrezzzLinkDiscord.service` file, and don't forget to replace it with the folder that you created in Step 1 (if you have a custom path for the Node.js executable, change it also);

6. Move the last file you edited to the folder `/etc/systemd/system`, enable it and start the Service;

7. Test it by pasting the server's IP with the port you chose at the search bar. If it doesn't redirect to my website, then some mistake was made. Please check every single step. If it's all working, you can copy the URL in the Search Bar and save it to [WHMCS - Step 3](#whmcs). {% endtab %} {% endtabs %} ### WHMCS 1. Upload the `modules` folder to your WHMCS root folder;

2. Go to `Setup -> System Settings -> Addon Modules` and active the module `Andrezzz - Link Discord`;

3. Go to the configuration of the Addon and fill out all the information required (copy the URL given in `Discord OAuth2 Redirect` and go to the [Discord - Step 3](#discord)). Please check the [FAQ](#frequent-asked-questions-faq), if you have any questions;

4. Go to `Addons -> Andrezzz - Link Discord` and add to the table the desired roles for each type you want. Please check the [FAQ](#frequent-asked-questions-faq), if you have any questions.

{% hint style="success" %} You're pretty to go. Have a good use of the module, and thank you once again 😊! {% endhint %} ## Troubleshooting For Commum Issues, kindly check the [Frequent-Asked Questions (FAQ)](#frequent-asked-questions-faq). if you don't find it, check the options below to troubleshoot it. ### WHMCS {% hint style="info" %} This is the easiest way to debug the module inside the WHMCS. {% endhint %} 1. Go to `System Logs -> Module Log` and activate it if you don't have it already and try to repeat the issue;

2. If you find any error similar to the one below, it's most likely a firewall issue. Please check the [FAQ](#couldnt-connect-to-server);

3. If you find any error similar to any below, it's most likely a backend issue. Please check the [FAQ](#frequent-asked-questions-faq). For the [first case](#couldnt-connect-to-server) and for the [second case](#whmcs-keeps-loading);

4. If you find any error similar to the one below, it's a Backend error. First, check if the [FAQ](#frequent-asked-questions-faq), have anything about it. If not, go to [Backend Troubleshooting](#backend-1);

### Backend 1. Edit the file `config.json,` change the Setting `debug` to `true` and restart the Bot;

2. Repeat the request/action and check the console. If you don't find anything similar in the [FAQ](#frequent-asked-questions-faq), please report it to me at [Report](#report). ### Report As a final step, if you don't find the solution, please report it to me with the maximum information as possible. Please copy the following template, edit and send it to me using one of my [Contact](/contact.md). ```markup System Information: - PHP Version: 8.1 - WHMCS Version: 8.6.2 - Node.js Version: 16.16.0 Issue: The WHMCS doesn't assign the roles if they have too many services. Any relative information: The client has 1000 services. Steps to reproduce: 1. Link the Discord; 2. Buy one more service. Request: Array ( [action] => add [clientID] => 2 [discordID] => 1014159062302195792 [roles] => Array ( [826466298555793408] => Array ( [0] => 826466298555793412 [1] => 826466298555793415 ) ) ) Response: Array ( [result] => error [message] => Error while adding the user: Invalid role(s) provided (826466298555793415) ) ``` ## Frequent-Asked Questions (FAQ) ### Notifications Currently, there are two types of Notifications: * Type Related: when a Hook is triggered, a personalised and translatable notification will be sent, based on the e-mail client's preference. At the moment, currently supports InvoicePaid, InvoiceCreated, TicketOpen, TicketOpenAdmin, TicketAdminReply, TicketClose, CancellationRequest, AfterModuleSuspend and AfterModuleUnsuspend. * E-mail Redirect: simply redirects every single e-mail to their Discord DM. This could break some ToS from Discord since you're sending to their DM personal information. {% hint style="danger" %} I'm not responsible for any kind of Ban/Warning that you can in Discord, by using any sort of Notifications. Using the Type Related, you have almost no chance to get it, but if you choose E-mail Redirect, since it has Personal Information about the Client itself (e.g. Name, Address or ID), it can be seen as a Data Leakage. Due to the EU Law GDPR, they're very cautious. {% endhint %} For any questions, you may have, you can contact me anytime, [here](/contact.md). ### Where to Show Currently, there are two types of places to show the current Link: * Homepage Panel

* Secondary Sidebar

Adicional to this, and after version 1.7, it's automatically added to the WHMCS Sign-in Integrations, so if the Client clicks in his name and chooses `Security Settings`, he'll see something like this page. My system works the same as before.

### Redirect to the Linkage This option, commonly mistaken, asks if you wanna redirect the Client to your Client Area or to show the Linked Discord information. Also, this is essential if you want the Client to choose if he wants to receive Notifications in their DM or not if you have this enabled.

### Linkage Page not showing properly If you see your Linkage Page showing like the one below, it's probably because you Upgraded from an older Version or you have some temporary bug in your Templates Cache. To go around this problem, you should go to `Utilities -> System -> System Cleanup` and click on `Empty Template Cache`.

### Type of Roles Currently, the module supports the following attribution criteria: * **Guest:** Client has no active services. * **Client:** Client has at least one active service. * **Group:** Client belongs to the specified client group. * **Product:** Client has at least one active service of the specified product. * **Product Addon:** Client has at least one active service of the specified product addon. * **Product Group:** Client has at least one active service within the specified product group. * **Product Server:** Client has at least one active service hosted on the specified product server. ### Dropdown without any Guild If you don't have any Guilds in the dropdown, please check if you added the Bot to the desired Guild. Check the [Discord - Step 5](#discord). ### Invalid role(s) provided If you get this error in the Backend API or in the [Module Log](#whmcs-1), check if the Bot/the Bot role is upper than the role you wanna give. ### Couldn't connect to server If you find this in your [Module Log](#whmcs-1), you either have a Connection Refused (Backend Firewall) issue or a Firewall (WHMCS) issue. Check below: * If you see `after 0 ms`, can be a Connection Refused issue. Check if you have a Firewall in the Backend, and if yes, if you allowed the Port you're using; * If you see `after x ms`, where `x` is a value greater than 0, and can be a firewall in the server on which you're running the WHMCS. To solve this issue, you should contact your Hosting Provider and ask them to allow the Backend IP, to have an Outgoing connection. If they don't allow it, please use port 80 or 443; * If you see `after x ms: Connection refused`, where `x`, can be 0 or greater than 0, can be the issue before. ### WHMCS keeps loading If you find your WHMCS, loading more time than it usually takes or keeps loading, it's due to the connection between WHMCS and the Backend. The Backend is giving a Timedout issue. To work around this, please check: * If you're using the right URL or IP:Port combination; * If the `config.json` doesn't have the wrong IP Address or Port. ## Thanks This module and all its features wouldn't have been possible if I didn't have the help of wonderful people who stayed by my side throughout allthe progress and helped me in every step I made. Gave ideas, argued mine, and tested them at all costs. Thank you again to all the buyers for your help and kindness ❤️! ``` pacman™#4344 - Idea of the project Dylan#1234 - Bug help xDizziex#0001 - Suggestions & Dutch Translation ༺j༻#3333 - Readme Docs Metuant#5074 - Suggestions & Bug help Pinkmare#1337 - Suggestions jake-#9777 - Bug help Maxou45400#6336 - Bug help Silver.#2200 - Suggestions MonkeyWhisper#0001 - Suggestions Richard (TheShiper)#3163 - Docs Help & Suggestions Don | Check my Bio!#1001 - Donation RX#4609 - Bug help Ciel#3836 - Discord ToS Help Fulger#0492 - Bug help & Romanian Translation Mika L.#0666 - German Translation Matthew#2000 - Suggestions ```