-
-
Notifications
You must be signed in to change notification settings - Fork 2
Quickstart
This is a guide for HLL server owners looking to start using Barricade to protect their servers.
Barricade is a service provided free of charge. You do not have to acquire your own hardware, nor do you have to have any knowledge in IT to get going.
- A Discord server with Manage Server permissions
- One or more running HLL servers that you own
- Either of the following;
- A Community RCON instance with Staff permissions
- A Battlemetrics RCON subscription with permission to manage bans and ban lists
Before being able to work with Barricade, you will first need to be approved. If you already have a Server Owner role over on the HLL Hosting Discord you can skip this step.
- Join the HLL Hosting & Divisions Bunker Discord
- Go to the #hosting-area-access channel and follow the instructions there
- Wait until you are given the Server Owner role
Now that Barricade recognizes you as a Server Owner, you are in theory ready to start submitting reports. However, let's also make sure you are receiving reports and can efficiently deal with them.
- Invite the Barricade bot to your own Discord server
- Use the
/config reports-channel
command to specify what channel to receive reports in.
Caution
Please make sure that this channel is private and can only be seen by your admins.
- Use the
/config admin-role
command to specify which role users must have to be able to (un)ban players.
While technically optional, Barricade assumes you link your community up with either Community RCON or Battlemetrics so that it can conveniently help you manage your bans. You only need one of them, not both.
Important
You need to have Community RCON set up and have an account with Staff permissions (a.k.a. being able to manage users). Community RCON supports Barricade integration as of v10.0.0, but it is recommended you upgrade to v10.4.0 or higher.
- Go to your Community RCON's
/admin
page - Click on the
Add
button next toDjango API Keys
- Copy the value in the
Api Key
field - Optionally add a note, then press
SAVE
- In Discord, run the
/config integrations
command - Click on the
Add integration...
button and selectCommunity RCON
- Next to
API URL
, fill in the link to your API, which is likely of formathttp://<address>:<port>/api
orhttps://<domain>.<com>/api
but should always end with/api
- Next to
API Key
, fill in the key from step 3 that you copied - Submit the form
Important
You need to have an active Battlemetrics RCON, RCON+, or Enterprise subscription in order to use this integration. You need permissions to manage bans and ban lists.
- Go to the Battlemetrics Developers page
- Click on the
New Token
button next toPersonal Access Tokens
- Select all
Ban Lists
andBans
permissions, as well asView RCON information
underRCON
- Click on the
Create Token
button at the bottom - Copy your newly generated token
- In Discord, run the
/config integrations
command - Click on the
Add integration...
button and selectBattlemetrics
- Next to
API Key
, fill in the key from step 5 that you copied - Go to https://www.battlemetrics.com/rcon/orgs and select your organization
- Next to
Organization URL
, copy and paste your browser's URL - Submit the form
You are now fully set up! Also see the Guides page for more information on how to use Barricade.