files-autobackup

Setup Instructions

Install Docker

1. First, in order to ensure the downloads are valid, add the GPG key for the official Docker repository to your system:
   curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
2. Add the Docker repository to APT sources:
   sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
3. Next, update the package database with the Docker packages from the newly added repo:
   sudo apt-get update
4. Make sure you are about to install from the Docker repo instead of the default Ubuntu 16.04 repo:
   apt-cache policy docker-ce
   You should see output similar to the follow:

docker-ce:
    Candidate: 18.06.1~ce~3-0~ubuntu
    Version table:
        18.06.1~ce~3-0~ubuntu 500
            500 https://download.docker.com/linux/ubuntu xenial/stable amd64 Packages

5. Finally, install Docker:
   sudo apt-get install -y docker-ce
6. Docker should now be installed, the daemon started, and the process enabled to start on boot. Check that it's running:
   sudo systemctl status docker
7. If you want to avoid typing sudo whenever you run the docker command, add your username to the docker group:
   sudo usermod -aG docker ${USER}
8. To apply the new group membership, log out of the server and back in.
9. Afterwards, you can confirm that your user is now added to the docker group by typing:
   id -nG

• For more info, visit: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04

Install Docker Compose

1. We'll check the current release and if necessary, update it in the command below:
   ssudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
2. Next we'll set the permissions:
   sudo chmod +x /usr/local/bin/docker-compose
3. Then we'll verify that the installation was successful by checking the version:
   docker-compose -v

• For more info, visit: https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-16-04

Install the repository into the VPS

1. Clone the repository.
2. Step into the just created folder

Configure environment variables

1. If you want to change the backup frequency, just add the arguments FREQUENCY parameter on your build command or docker-compose file:

   args:
               FREQUENCY: ${FREQUENCY}

2. The following options are available: 15min, hourly, daily, weekly and monthly

3. The maximum historic size of backup files is given by the env variable HIST_SIZE, adjust it to your needs

Configure server sync

1. Create a file named rclone.conf inside the folder rclone_config in the repository with your storage provider configuration. Check the instructions at: https://rclone.org/docs/#config-config-file
2. Add any file required to authenticate with your storage provider to the same file, e.g.: key.json

Execute all the services

docker-compose up -d or docker-compose up -d --build --force-recreate to force recreation of image and container
Check if everything is working via the commands:
docker-compose ps or docker ps
Check the logs of each container via the command:
docker-compose logs container_name