# Real-time Backup Server - Seafile Admin Manual
Author: seafile

Skip to content

# Seafile Real-Time Backup Server

Note: This feature is deprecated and not recommended to use in production. If you're looking for backup solution:

- If you're not using object storage, you can follow the instructions in backup and recovery.
- If you're using object storage, you can use the migration script to backup the objects.

Backup is the procedure that copies data from a primary server (which is running production service) to a backup server.

The real-time backup server uses a syncing algorithm similar to the Seafile desktop client to retrieve data from the primary server. It works as follows:

- Whenever a library is updated, the primary server notifies the backup server to retrieve the changed data. With a delta syncing algorithm, this procedure runs quickly and updates the backup server in nearly real-time.
- The backup server also checks all libraries on the primary server at a fixed period. Any new or updated libraries will be synced to the backup server. This will pick up any legged updates due to glitches in the above real-time sync procedure.
- The backup server always keep the database and data directory consistent. So no libraries on the backup server will be in corrupted state (unless they're already corrupted on the primary server).
- The full history of all libraries will be backed up. This is not like the desktop client, which only syncs the latest state of a library.

There are two sets of data that need to be backed up:

- The seafile-data directory and the core library metadata tables in the seafile database. This data is the core data structures of the libraries in Seafile. They're synced to the backup server with Seafile's syncing algorithm. In this procedure, the metadata tables are kept consistent with the seafile-data directory.
- All other tables in the database (including seafile, ccnet and seahub databases) are backed up with mysqldump. mysqldump can't back up the database in real time. You can setup a crontab for mysqldump at regular intervals. The latency of backup for these tables doesn't affect the integrity of library data.

In the following discussion, we'll use "primary server" and "master server", "backup server" and "slave server" interchangeably.

## Configure Real-Time Backup Server

We assume you already have a primary server running, and now you want to set up a backup server.

The steps to setup the backup server are:

1. Install Seafile on the backup server
2. Configure Seafile syncing between the primary server and the backup server
3. Back up the tables in the database by `mysqldump` at regular intervals

### Install Seafile on the Backup Server

You should install Seafile Pro Edition on the backup server according to this documentation. Since the real-time backup feature is only available for 5.1.0 or later, you also have to upgrade your primary server to version 5.1.0 or later.

When installing Seafile on the backup server, you have to notice:

- The database names (ccnet, seafile and seahub database) should be the same as the names on the primary server.
- You don't need to enable other Pro features, such as Office file preview, search indexing, file auditing etc.
- You can't start the seahub progress on backup server. It means that usually the Seafile backup server can't provide service.

### Configure Real-time Backup in Seafile

On the primary server, add following options to seafile.conf:

    [backup]
    backup_url = http://backup-server
    sync_token = c7a78c0210c2470e14a20a8244562ab8ad509734

On the backup server, add following options to seafile.conf:

    [backup]
    primary_url = http://primary-server
    sync_token = c7a78c0210c2470e14a20a8244562ab8ad509734
    sync_poll_interval = 3

- `backup_url`: the backup server's address in url format. You can use HTTP or HTTPS.
- `primary_url`: the primary server's address in url format.
- `sync_token`: a secret shared between the primary and backup server. It's a 40 character SHA1 token generated by the system admin. You can use `uuidgen | openssl sha1` command to generate a random token.
- `sync_poll_interval`: The backup server polls all libraries of the primary server periodically. You can set the poll interval in units of hours. The default interval is 1 hour, which means the backup server will poll the primary every hour. You should choose larger intervals if you have larger libraries.

If you use HTTPS to sync between primary and backup servers, you must use the correct Seafile server package for your system. If you run CentOS, you should use the Seafile package named without the "Ubuntu" suffix; if you run Debian or Ubuntu, you should use the Seafile package named with "Ubuntu" suffix. Otherwise you may meet CA errors in HTTPS requests.

After saving the configuration, restart the seafile service on the primary and backup servers. The backup server will automatically start backing up on restart.

Note: Don't start the seahub progress on the Seafile backup server.

### Back up the Databases

Backup data from the databases on the primary server's MySQL with mysqldump:

    mysqldump -u <user> -p<password> --databases \
    --ignore-table=<seafile_db>.Repo \
    --ignore-table=<seafile_db>.Branch \
    --ignore-table=<seafile_db>.RepoHead \
    <seafile_db> <ccnet_db> <seahub_db> > dbdump.sql

You should replace `<user>`, `<password>` with your MySQL admin user and password. You should replace `<seafile_db>`, `<seahub_db>` and `<ccnet_db>` with your database names.

The three ignored tables are core tables related to library data, and are synced by Seafile backup server in a real-time manner. They're kept in the seafile database of the backup server and are separated from the mysqldump process.

You should set up crontab to run the mysqldump at regular intervals.

If you want to back up the tables (except for the 3 tables synced by Seafile) in a more real-time manner, you can deploy the master-slave replication for the MySQL/MariaDB database from the primary node to another database server. The database running on the backup server must not be used as the target of this replication. Otherwise you'll end up with replication conflicts, since the db on backup server will also be updated by Seafile backup process too.

### Checking Backup Status

After the above setup, you should now have the below layout of your backup data:

- Library data is backed up and managed by Seafile backup server. The data can be stored on external storage, object storage, or local disk, depending on your setup for the backup server.
- Database tables are split into two parts:
  - 3 core library tables are backed up in real-time to the backup node's MySQL database.
  - Other tables are regularly dumped to a file with mysqldump. The backup files are stored somewhere other than the primary server.

`seaf-backup-cmd.sh` provides `status` command to view the backup status. The output is like:

    # ./seaf-backup-cmd.sh status
    Total number of libraries: xxx
    Number of synchronized libraries: xxx
    Number of libraries waiting for sync: xxx
    Number of libraries syncing: xxx
    Number of libraries failed to sync: xxx

    List of syncing libraries:
    xxx
    xxx

    List of libraries failed to sync:
    xxx
    xxx

There are a few reasons the backup of a library may fail:

- Some data in the primary server is corrupted. The data may be in the latest state or in history. Since the backup procedure syncs the full history, corruption in history will fail the backup.
- The primary server has run seaf-fsck, which may restore a library back to an older state.

## Restore from the Backup Server

In the unfortunate situation where severe data corruption happens on the primary server, you can restore your service quickly directly on the backup server. The recovered service can be run directly on the backup server.

There are tow steps to restore on the backup server:

- Import the latest MySQL dump file into the Seafile backup server's MySQL database.
- Enable other Pro features on the Seafile backup server, and start seahub progress `./seahub.sh start`.

#### Step1: Import MySQL dump file into backup server

Importing the latest MySQL dump file into the backup server's database:

    mysql -u <user> -p<pass> < dbdump.sql

Replace `<user>` and `<pass>` with your MySQL admin user name and password.

#### Step2: Start the backup server's seahub

Copy the seafile's configuration to the backup server, then start the seahub progress on the backup server.

    ./seahub.sh start

## Setup Backup Server for Seafile Cluster

If your primary service runs as a Seafile cluster, you have two points to notice when setting up a backup server:

1. You should only use one MySQL instance as the replication master, if you're using MariaDB cluster.
2. You have to change seafile.conf and set the `backup_url` and `sync_token` options on each Seafile node. The configuration on all primary Seafile node should be the same. They all point to the same backup server.

Currently you cannot deploy the backup service as a cluster. That is, you can only use a single node as backup server. This support may be added in the future.

## Managing the Real-time Backup Server

`seaf-backup-cmd.sh` script is the tool for managing the backup server. The `seaf-backup-cmd.sh` script provides the following commands:

### Manually Trigger Syncing a Library

You can use the `sync` command to manually schedule backup of a library:

    # ./seaf-backup-cmd.sh sync <library id>

The command will block until the backup is finished.

### Handling Backup Errors

The `--force` option of `sync` command can be used to force failing backup to complete. Permanent backup failures are usually caused by data corruption of a library in the primary server. The `--force` option asks the backup to skip corrupted objects and finish the backup.

When you find a backup error, follow two steps:

1. Run seaf-fsck on the primary server, for the failing libraries. Fsck fixes any corruption for the latest state of the libraries.
2. Run `seaf-backup-cmd.sh sync --force <library id>` on the backup server.