mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-01 06:50:00 +00:00

Martijn de Boer 38cd889f7b

[docs] Add optional instructions for replicating SQLite for disaster recovery (#2981 )

* Add optional instructions for replicating SQLite for disaster recovery

* Remove references to MacOS from replicating-sqlite.md

Resolve comment on review

* Add mention for replicating SQLite in database_maintenance.md

Adds a reference to the replicating sqlite page under database maintenance

2024-06-13 15:09:51 +02:00

3.2 KiB

Raw Blame History

Replicating SQLite

Next to your regular backup methods, you might want to set up replication for disaster recovery to another path or external host.

For this to work properly, SQLite needs the journal mode to be configured in WAL mode, with synchronous mode set to NORMAL. This is the default configuration for GoToSocial.

You can check your settings in the configuration file. The journal mode is set in db-sqlite-journal-mode and the synchronous mode in db-sqlite-synchronous.

Litestream on Linux

A relatively light, and fast way to set up replication with SQLite is by using Litestream. It can be configured very easily and supports different backends like file based replication, S3 compatible storage and many other setups.

You can then install the prebuilt package by either the deb file on Linux, or building it from source on other distributions.

Using a .deb package on Linux:

Navigate to the releases page, and download the latest release (make sure to select the appropiate platform for the wget command below).

wget https://github.com/benbjohnson/litestream/releases/download/v0.3.13/litestream-v0.3.13-linux-amd64.deb
sudo dpkg -i litestream-*.deb

Configuring Litestream

Configuration is done by editing the configuration file. It's located in /etc/litestream.yml.

Configuring file based replication

dbs:
    - path: /gotosocial/sqlite.db
      - path: /backup/sqlite.db

Configuring S3 based replication

Set up a bucket for replication, and make sure to set it to be private. Make sure to replace the example access-key-id and secret-access-key with the proper values from your dashboard.

access-key-id: AKIAJSIE27KKMHXI3BJQ
secret-access-key: 5bEYu26084qjSFyclM/f2pz4gviSfoOg+mFwBH39

dbs:
    - path: /gotosocial/sqlite.db
      - url: s3://my.bucket.com/db

When using a S3 compatible storage provider you will need to set an endpoint. For example for minio this can be done with the following configuration.

access-key-id: miniouser
secret-access-key: miniopassword

dbs:
    - path: /gotosocial/sqlite.db
      - type: s3
	    bucket: mybucket
		path: sqlite.db
		endpoint: minio:9000

Enabling replication

You can enable replication on Linux by enabling the Litestream service.

sudo systemctl enable litestream
sudo systemctl start litestream

Check if it's running properly using sudo journalctl -u litestream -f.

If you need to change the configuration file, restart Litestream:

sudo systemctl restart litestream

Recovering from the configured backend

You can pull down a recovery file from the stored backend with the following simple command.

sudo litestream restore

If you have configured multiple files to be backupped, or have multiple replicas, specify what you want to do.

For filebased replication:

sudo litestream restore -o /gotosocial/sqlite.db /backup/sqlite.db

For s3 based replication:

sudo litestream restore -o /gotosocial/sqlite.db s3://bucketname/db

3.2 KiB Raw Blame History