Docker Setup¶

1. Install Docker¶

Install docker

2. Create the A records¶

We'll be using example.com as our domain for this example.

Info

The RMM uses 3 different sites. The Vue frontend e.g. rmm.example.com which is where you'll be accesing your RMM from the browser, the REST backend e.g. api.example.com and Meshcentral e.g. mesh.example.com

Get the public IP of your server with curl https://icanhazip.tacticalrmm.io
Open the DNS manager of wherever the domain you purchased is hosted.
Create 3 A records: rmm, api and mesh and point them to the public IP of your server:

arecords

3. Acquire Let's Encrypt Wildcard certs with certbot¶

Warning

If the Let's Encrypt wildcard certificates are not provided, a self-signed certificate will be generated and most agent functions won't work.

A. Install Certbot¶

sudo apt-get install certbot

B. Generate the wildcard Let's Encrypt certificates¶

We're using the DNS-01 challenge method

a. Deploy the TXT record in your DNS manager¶

Warning

TXT records can take anywhere from 1 minute to a few hours to propogate depending on your DNS provider.
You should verify the TXT record has been deployed first before pressing Enter.
A quick way to check is with the following command:
dig -t txt _acme-challenge.example.com
or test using: https://viewdns.info/dnsrecord/ Enter: _acme-challenge.example.com

txtrecord

dnstxt

b. Request Let's Encrypt Wildcard cert¶

sudo certbot certonly --manual -d *.example.com --agree-tos --no-bootstrap --manual-public-ip-logging-ok --preferred-challenges dns

Note

Replace example.com with your root domain

4. Configure DNS and firewall¶

You will need to add DNS entries so that the three subdomains resolve to the IP of the docker host. There is a reverse proxy running that will route the hostnames to the correct container. On the host, you will need to ensure the firewall is open on tcp ports 80, 443 and 4222.

5. Setting up the environment¶

Get the docker-compose and .env.example file on the host you which to install on

wget https://raw.githubusercontent.com/wh1te909/tacticalrmm/master/docker/docker-compose.yml
wget https://raw.githubusercontent.com/wh1te909/tacticalrmm/master/docker/.env.example
mv .env.example .env

Change the values in .env to match your environment.

When supplying certificates through Let's Encrypt, see the section below about base64 encoding the certificate files.

A. Base64 encoding certificates to pass as env variables¶

Use the below command to add the the correct values to the .env.

Running this command multiple times will add redundant entries, so those will need to be removed.

Let's encrypt certs paths are below. Replace ${rootdomain} with your own.

public key /etc/letsencrypt/live/${rootdomain}/fullchain.pem

private key /etc/letsencrypt/live/${rootdomain}/privkey.pem

echo "CERT_PUB_KEY=$(sudo base64 -w 0 /path/to/pub/key)" >> .env
echo "CERT_PRIV_KEY=$(sudo base64 -w 0 /path/to/priv/key)" >> .env

6. Starting the environment¶

Run the below command to start the environment.

sudo docker-compose up -d

Removing the -d will start the containers in the foreground and is useful for debugging.

7. Get MeshCentral EXE download link¶

Run the below command to get the download link for the mesh central exe. This needs to be uploaded on first successful signin.

sudo docker-compose exec tactical-backend python manage.py get_mesh_exe_url

Download the mesh agent:

meshagentdl

Navigate to https://rmm.example.com and login with the username/password you created during install.

Once logged in, you will be redirected to the initial setup page.

Create your first client/site, choose the default timezone and then upload the mesh agent you just downloaded.

Note about Backups¶

The backup script does not work with docker. To backup your install use standard docker backup/restore processes.