How to install ACP?
First Steps:
-
Download the Asset:
Go to keymaster.fivem.net (opens in a new tab), navigate to Granted Assets, and download Synapse ACP. -
Add the Asset to Your Resources Folder:
Drag and drop thesyn-acp
folder into your server'sresources
directory. -
Ensure syn-acp is in Your server.cfg:
Add the following line to yourserver.cfg
file:
ensure syn-acp
Set Up Your Website
To begin, locate and access the .env file in your [WEBSITE] directory. In this file, you'll find settings that look like this:
# MongoDB Connection
MONGO_URL=""
MONGO_DB = ''
# Discord BOT
DISCORD_CLIENT_ID=""
DISCORD_CLIENT_SECRET=""
BOT_TOKEN=""
# Server Config
SERVER_ID =""
# ==== DOMAIN ===
# Backend URL
# URI=""
# Frontend Index
# FRONTEND_URL="/#/"
1. Setup Mongodb Database
You will need a MongoDB database, for this you can use a cluster or create a local database using MongoDB Community.
MONGO_URL=""
MONGO_DB = ''
You will have to fill in the MONGO_URL with the url for the connection to your database, for example:
MONGO_URL="mongodb://192.168.1.1:27017"
MONGO_DB = 'panel_database'
2. Setup Discord BOT
To get started, visit Discord Developer Portal and log in.
After logging in, click "New Application" in the top right corner, then enter a name for your application.
Now, click on the left side on "OAuth2" and copy the CLIENT ID and CLIENT SECRET that we will use to fill in the config in .ENV
DISCORD_CLIENT_ID=""
DISCORD_CLIENT_SECRET=""
The config should look something like this:
DISCORD_CLIENT_ID="1273690389819293818"
DISCORD_CLIENT_SECRET="iI_K42Jmmhti1NlteYxAG0TheVCGD4FN"
Click on "Add Redirect" and in the box that appears, enter your domain in the following format:
http://yourdomain.com + /auth/callback
For example: http://example.com/auth/callback.
Now you will have to go to the "Bot" category, and click on the "Reset Token" button to be able to reset and copy the new token for your Discord bot.
BOT_TOKEN=""
This should look something like this:
BOT_TOKEN="MTI3MzY5MDM4OTgxOTI5MzgxOA.G7_JaA.ve0Z0h4Eif0Bj2KjZGdFWyAy8M7PzmSb_he6Rw"
Now, Make sure you have all the settings checked in the "Bot" category, exactly as it is in the image.
Finally, invite the bot to your discord server.
3. Fill the Server id
We use the server id to show you the number of players on your fivem server.
SERVER_ID =""
Something like:
SERVER_ID ="8698qm"
4. Config Domain URL
Here you will have to fill in with your domain
# Backend URL
# URI=""
# Frontend Index
# FRONTEND_URL="/#/"
At URI it's simple, you will just have to fill in with your domain, something like:
URI="https://yourdomain.com"
And at FRONTEND_URI you will have to fill in with your domain, followed by /#/, which is something like this:
FRONTEND_URL="https://yourdomain.com/#/"
5. Install on Webhost
Now the last step is to install it on your webhost. Which is very simple, drag and drop to the files from [WEBSITE] on your webhost, in the subdomain or on the main domain depending on how you want.
Activate NodeJS, and set the startup file index.js.