Skip to content

Superbition/Bakup-Agent-Cpp

Repository files navigation

Bakup Agent

This is the backup agent for bakup.io

Bakup Agent CI

Automatic Installation

  1. Download install.sh
  2. Ensure you're logged in as the user that you would like the agent to run as
  3. Run sudo ./install.sh [YOUR-CLIENT-ID] [YOUR-API-KEY]

Manual Installation

  1. Three configuration files must be created

    mkdir -p /etc/opt/bakupagent
    touch /etc/opt/bakupagent/{USER_ID,CLIENT_ID,API_TOKEN}
    
  2. Populate USER_ID with the ID of the user you wish bakup agent to run under, then create CLIENT_ID and API_TOKEN with your Client ID and API Token, respectively.

    NOTE: Ensure that the CLIENT_ID and API_TOKEN files are writable by the user that will run the agent

  3. Copy the Bakup Agent and rclone binaries in to /opt/bakupagent/.

  4. After making the binaries executable, you can start the agent - ./opt/bakupagent/bakupagent

    NOTE: The Bakup Agent can be run with the -d argument to enable debug messages.

Directory Tree

/
├── etc/
│   └── opt/
│       └── bakupagent/
│           ├── USER_ID
│           ├── CLIENT_ID
│           └── API_TOKEN
└── opt/
    └── bakupagent/
        ├── bakupagent
        └── rclone

Uninstallation

To uninstall an agent from a server, you can either:

  1. Use Bakup.io to remove it remotely
  2. Run the uninstall script on the server manually using: sudo ./opt/bakupagent/uninstall.sh

Both methods will inform Bakup that the agent has been removed from its server.