Providing a vault

There are 2 kinds of vaults: standard ones (in binary or source form) and tracked ones (only in binary form).

The prerequisites for all vauts are:

• configure the firewall to allow incoming connections on port 5483 for TCP protocol

• for vault at home, configure the ISP box to forward port 5483/TCP to the IP address of the machine that runs the vault.

Providing a standard vault

Get binary from Maidsafe release

Download zip file from Maidsafe release corresponding to your platform, extract the vault executable and configure it with the set of configuration files defined in "vaults" directory.

For example on linux platform:

# Download zip file
wget https://github.com/maidsafe/safe_vault/releases/download/0.17.2/safe_vault-v0.17.2-linux-x64.zip

# Unzip file
unzip safe_vault-v0.17.2-linux-x64.zip

# Get configuration files
git clone https://github.com/Thierry61/tfa_safenetwork.git

# Configure vault
mkdir app
cd app
cp ../safe_vault-v0.17.2-linux-x64/safe_vault .
cp ../tfa_safenetwork/vaults/*.config .

# Launch vault
RUST_LOG=info ./safe_vault

Compile source from Maidsafe repository

This kind of node is to be build from safe_vault Maidsafe repository and configured with the set of configuration files defined in "vaults" directory.

On a Linux host with latest rust version:

# Build vault from Maidsafe source
git clone https://github.com/maidsafe/safe_vault.git
cd safe_vault
cargo build --release

# Get configuration files
cd ..
git clone https://github.com/Thierry61/tfa_safenetwork.git

# Configure vault
mkdir app
cd app
cp ../safe_vault/target/release/safe_vault .
cp ../tfa_safenetwork/vaults/*.config .

# Launch vault
RUST_LOG=info ./safe_vault

Providing a tracked vault

This kind of node is provided in binary form (as a docker image). It uses an out of band network that collects data from participating vaults. Aggregate data are displayed on this site.

Install Docker

Install Docker with engine version >= 18.09.0 on a Linux host:

# Uninstall old version (It’s OK if apt-get reports that none of these packages are installed)
apt-get remove docker docker-engine docker.io containerd runc
# Download installer
curl -fsSL https://get.docker.com -o get-docker.sh
# Install docker
sh get-docker.sh

Start the vault

Create an initially empty log file with:

touch /var/log/safe_vault.log

If there is an existing log file from a previous vault, messages from the new vault will be appended to it. If this is not what you want, just truncate it with:

echo -n > /var/log/safe_vault.log

But in all cases /var/log/safe_vault.log file must exist, empty or not.

Then join the network with the following command:

docker swarm join --token SWMTKN-1-3eqzfowpfpsmknaiqitojn560jzfeqapkvgpvy0cj8wqb1oxkw-9up8ds418mt3u03x2wyd9y1ps 116.203.25.212:2377

Define firewall rules

For security reasons you should also set firewall rules to restrict in-going traffic other than ssh, docker and safe_vault. With ufw package the commands are:

# Default rules
ufw default deny incoming
ufw default allow outgoing
# ssh
ufw allow 22/tcp
# docker
ufw allow 2376/tcp
ufw allow 2377/tcp
ufw allow 4789/udp
ufw allow 7946/udp
ufw allow 7946/tcp
# safe_vault
ufw allow 5483/tcp
# Turn it on
ufw enable

Inscribe your name in the galaxy

To be considered a sponsor and participate in the Honor Roll, provide one or more tracked nodes on different hosts whose hostname contains a double dash sequence ('--') with a common string before this sequence. This common string will be your name as a sponsor. For example with the following hostnames:

• BIGCORP--SW
• BIGCORP--NE

You will be participating as BIGCORP sponsor.

Advantages associated with this title:

• Be listed in the Honor Roll. This list is ordered by decreasing number of nodes, so provide many nodes to be ranked at the top of the list
• Show your nodes in the galaxy of constellations
• Monitor your own nodes in the dashboard

Get the vault logs

Your vault stores logs in /var/log/safe_vault.log file. To display them continuously on the screen, issue following command:

tail -f /var/log/safe_vault.log

You can modify the logging configuration by modifying log.yml file. Modifications are dynamic, meaning you can change configuration without stopping the running vault.

Get configuration file with:

docker cp $(docker ps -q):/app/log.yml .

Modify log.yml with the editor of your choice.

Put back new configuration file with:

docker cp log.yml $(docker ps -q):/app/log.yml

Stop your vault

Whenever your vault crashes or the host is rebooted, your vault is automatically restarted. To properly stop your vault, disconnect it from the swarm with following command:

docker swarm leave

Accessing the network from a client

Replace existing crust configuration file with the one in "clients" directory.

The file is provided for "SAFE Browser". For other clients, just rename it by replacing "SAFE Browser" part with the base name of the client program.