Download and installation

Ubuntu, Debian and equivalents

amd64

$ wget --content-disposition https://deploy.oxibox.com/linux/deb/amd64

or

$ curl -O -J -L https://deploy.oxibox.com/linux/deb/amd64

i386

$ wget --content-disposition https://deploy.oxibox.com/linux/deb/i386

or

$ curl -O -J -L https://deploy.oxibox.com/linux/deb/i386

Installation

# apt install /chemin/fichier.deb

or

# dpkg -i /chemin/fichier.deb

Update

# apt install /chemin/nouveau_fichier.deb

or

# dpkg -i /chemin/nouveau_fichier.deb

Uninstallation

# apt remove oxibackup && apt purge oxibackup

or

# dpkg -r oxibackup && dpkg -P oxibackup

Specific OpenSUSE versions

This version is only for the following distributions: OpenSuSE Ports Leap 42.3, OpenSuSE Leap 15.0 to 15.2 inclusive, OpenSuSE Ports Leap 15.0 to 15.2 inclusive.

x86_64

$ wget --content-disposition https://deploy.oxibox.com/linux/rpm/openSUSE/x86_64

or

$ curl -O -J -L https://deploy.oxibox.com/linux/rpm/openSUSE/x86_64

i386

$ wget --content-disposition https://deploy.oxibox.com/linux/rpm/openSUSE/i386

or

$ curl -O -J -L https://deploy.oxibox.com/linux/rpm/openSUSE/i386

Installation

# rpm -i /chemin/fichier.rpm

or

# zypper install /chemin/fichier.rpm

or

# yum install /chemin/fichier.rpm

Update

# rpm -U /chemin/nouveau_fichier.rpm

or

# zypper install /chemin/nouveau_fichier.rpm

or

# yum install /chemin/nouveau_fichier.rpm

Uninstallation

# rpm -e oxibackup

or

# zypper remove oxibackup

or

# yum remove oxibackup

Other RPM distributions

This version is for CentOS, RHEL (Red Hat), Fedora-type distributions and other SUSE / OpenSUSE versions not covered by the other RPM.

x86_64

$ wget --content-disposition https://deploy.oxibox.com/linux/rpm/other/x86_64

or

$ curl -O -J -L https://deploy.oxibox.com/linux/rpm/other/x86_64

i386

$ wget --content-disposition https://deploy.oxibox.com/linux/rpm/other/i386

or

$ curl -O -J -L https://deploy.oxibox.com/linux/rpm/other/i386

Installation

# rpm -i /chemin/fichier.rpm

or

# zypper install /chemin/fichier.rpm

or

# yum install /chemin/fichier.rpm

Update

# rpm -U /chemin/nouveau_fichier.rpm

or

# zypper install /chemin/nouveau_fichier.rpm

or

# yum install /chemin/nouveau_fichier.rpm

Uninstallation

# rpm -e oxibackup

or

# zypper remove oxibackup

or

# yum remove oxibackup

Registering the machine

You need to register the machine with the Oxibox services if this has not been done yet.

To do so, enter the command below in a terminal:

# oxibox-registration

and follow the instructions. This step requires your Oxibox login credentials.

The machine is now linked to your Oxibox account, and you can configure it from the Oxibox console (admin.oxibox.com).

Administration and advanced configuration

Managing the service

The backup service is enabled and starts automatically by default after an installation. You normally do not need the commands below.

The service restarts automatically if it is enabled. To disable the service completely, you must disable it and then stop it. You can also uninstall the agent if you wish.

Enable, start, restart

To enable the service, use this command:

# oxibackup-control enable

To start the service manually, use this command:

# oxibackup-control start

To restart the service, for example to apply an Advanced configuration, use this command:

# oxibackup-control restart

Disable, stop

To disable the service, use this command:

# oxibackup-control disable

To stop the service, use this command:

# oxibackup-control stop

If the service is still enabled, it restarts automatically after being stopped.

Status

You can check whether the service is enabled and/or running with this command:

# oxibackup-control status

Advanced configuration

Some advanced settings let you change the resources allocated to the backup service. Changing one of them requires a restart of the service to take effect. Changes to the cache location do not require a restart.

The backup is configured from the Oxibox console (admin.oxibox.com).

RAM usage

The default setting is enough to keep memory use as low as possible at run time. We advise against changing it.

VALEUR (the value) must be an integer in the range ]0,100] and gives the percentage at which the garbage collector must step in. The higher the value, the higher the RAM usage. A value that is too low can hurt the agent's performance too much without saving any resources.

# oxibackup-configure set gc VALEUR

CPU usage

The default setting means the program can use all the CPUs (physical and logical) available on the machine for multi-threaded actions.

VALEUR (the value) must be an integer in the range [0,number of CPUs] and gives the number of CPUs on which the program can start a thread. 0 is the default value and means all CPUs are available.

# oxibackup-configure set cpus VALEUR

Cache management

The backup agent creates a cache folder on the machine to speed up the deduplication steps during backup. The source volume to back up and the number of files (especially small ones) affect the size of the cache. As a rule of thumb, allow about 5% of your source volume for the cache.

By default the cache is located at /opt/oxibackup/var/cache/oxibackup. If you want to put it somewhere else, you can use a bind mount or a link to replace the target of this path.

If you want to disable the cache, which has a negative impact on backup performance and speed, you can replace the directory with a file. Delete the /opt/oxibackup/var/cache/oxibackup folder and create a file at the same location.