Factom Protocol Docs
Search…
Getting Started
Infrastructure
Technologies
Protocol development
Joining the docker swarm
This tutorial is fully covered in the video shown above. Some parts may differ from the text version, such as the swarm certificates and keys, these have been updated since the making of this video.
Installing docker
First you need to install docker. Please follow the instructions here to install docker-CE (Community Edition) to your system. Once it's installed run the following:
1
usermod -aG docker $USER
Copied!
Make sure you logout / login again, as otherwise your current terminal session will not be updated.
Storing the docker swarm certificate and key
The Docker Swarm certificate and key is used for authenticating with the docker swarm. These will verify clients with the certificate, as well as encrypt communication with the Docker API using TLS.
You can store these files in the directory
/etc/docker for instance: 1
sudo mkdir -p /etc/docker
2
sudo wget https://raw.githubusercontent.com/FactomProject/factomd-authority-toolkit/master/tls/cert_exp_5-14-21.pem -O /etc/docker/factom-mainnet-cert_exp_5-14-21.pem
3
sudo wget https://raw.githubusercontent.com/FactomProject/factomd-authority-toolkit/master/tls/key_exp_5-14-21.pem -O /etc/docker/factom-mainnet-key_exp_5-14-21.pem
4
sudo wget https://raw.githubusercontent.com/FactomProject/factomd-authority-toolkit/master/tls/ca_exp_5-14-21.pem -O /etc/docker/factom-mainnet-ca_exp_5-14-21.pem
5
sudo chmod 644 /etc/docker/factom-mainnet-cert_exp_5-14-21.pem
6
sudo chmod 440 /etc/docker/factom-mainnet-key_exp_5-14-21.pem /etc/docker/factom-mainnet-ca_exp_5-14-21.pem
7
sudo chgrp docker /etc/docker/*.pem
Copied!
Now you should have the files with the correct permissions set.
Please note that in the rest of this tutorial it's assumed you stored the files using the
/etc/docker location and with the above names. If not, please adjust the commands below involving the certificate and keys.Configuring and running the docker engine
Configure the docker daemon using a default config file, located at
/etc/docker/daemon.json . Create this file if it doesn't exist. Copy the following into the file:/etc/docker/daemon.json
1
{
2
"tlsverify": true,
3
"tlscert": "/etc/docker/factom-mainnet-cert_exp_5-14-21.pem",
4
"tlskey": "/etc/docker/factom-mainnet-key_exp_5-14-21.pem",
5
"tlscacert":"/etc/docker/factom-mainnet-ca_exp_5-14-21.pem",
6
7
"hosts": ["tcp://0.0.0.0:2376", "unix:///var/run/docker.sock"]
8
}
Copied!
If your system has multiple IP addresses you can select which IP it should listen on by editing
"hosts". Now you'll need to replace the standard docker start command. Run the following command:
1
sudo systemctl edit docker.service
Copied!
The above command creates an override directory at
/etc/systemd/system/docker.service.d/ and an override file called override.conf (which is open on your terminal now). Copy and paste the following:override.conf
1
[Service]
2
ExecStart=
3
ExecStart=/usr/bin/dockerd
Copied!
Exit and save the file. Now reload the docker configuration and the
docker.service:1
sudo systemctl daemon-reload
Copied!
Docker should now be configured and ready. You can test if it runs correctly with the following:
1
sudo systemctl restart docker
2
sudo systemctl status docker
Copied!
It should restart with no errors appearing and you should see that the
override.conf file has been loaded. Creating the Factomd volumes
Factomd relies on two volumes,
factom_database and factom_keys. Please create these before joining the swarm:1
docker volume create factom_database
2
docker volume create factom_keys
Copied!
These volumes are there to make sure that you can remove or delete the container itself but the database and the keys are still persistent on the system.
For running a main-net authority node we strongly recommend syncing the database from scratch. If you do already have a recently synced main-net node and would like to avoid re-syncing, run:
1
sudo cp -r <path to your database> /var/lib/docker/volumes/factom_database/_data .
Copied!
The directory in _data after the copy should be main-database, as the volume is mounted at
$HOME/.factom/m2.Joining the docker swarm
Finally, to join the swarm, run the following command:
1
docker swarm join --token SWMTKN-1-5ct5plmbn1ombbjqp8ql8hq93jkof6246suzast5n1gfwa083b-1ui6w6fupe45tizz0tv6syzrs 52.48.130.243:2377
Copied!
As a reminder, joining as a worker means you have no ability to control containers on another node.
Once you have joined the network, you will be issued a control panel login by a Factom employee after messaging one of the Factom engineers on discord. You should private message the following for each node:
- NodeID (found by running
docker info) - IP address
- Docker engine listening port (2376)
Only accept logins at federation.factomd.com. Any other login endpoints are fraudulent and not to be trusted.
Starting Factomd Container from the Docker CLI
Please note: There is a version for the Factom software in the next command. Make sure you run the correct and latest announced version from the Discord #operators-announcement channel
Run the following command exactly:
docker run -d --name "factomd" -v "factom_database:/root/.factom/m2" -v "factom_keys:/root/.factom/private" -p "8088:8088" -p "8090:8090" -p "8108:8108" -l "name=factomd" factominc/factomd:v6.5.2-alpine -startdelay=600 -faulttimeout=120 -config=/root/.factom/private/factomd.confIf you want the Factomd container to start at system boot (reboots) you can add the following parameter to the command above:
--restart unless-stoppedAfter this your node will be started. You can check for the existence of a Factom container using the command
docker ps . You're now almost ready to be included in the main-net. Stop the
factomd container with docker stop factomd and download the factomd.conf file here. There are some required edits that are needed, among them you're required to enter a few special peers here. You will get more information about this if you're accepted as an ANO.
In the
important.conf file generated earlier you'll find the following three lines:1
IdentityChainID
2
LocalServerPrivKey
3
LocalServerPublicKey
Copied!
Paste these into the
factomd.conf and save. Now place the config file in /var/lib/docker/volumes/factom_keys/_data by running (if the file is where you're currently at):
sudo mv factomd.conf /var/lib/docker/volumes/factom_keys/_data/factomd.confNow you're free to start the
factomd container again with docker start factomd . If you check the currently running docker containers you'll see a container named
factominc/filebeat:m3-debug , this is generally a good sign as it means the portainer system has successfully connected and started a container remotely. Please wait for your node to be fully synced by checking the control panel node sync statuses to be 100% before performing any next steps. Please also regard the initial wait period of 20 minutes before doing anything with your node. Also note that the
factomd:v6.5.2-alpine version may have changed since the time of writing.