Skip to content

Quick Setup

Hariprasanth S edited this page Oct 16, 2020 · 1 revision

Synchly can be run with --help flag to get a full list of flags.

The quickest way to get started is to run the synchly --config=db command.

To start synchly use the command synchly --start. Synchly instance have to be restarted everytime you make a change to the configuration using the cli options.

To restore database from the backup files use the command synchly --restore.

Configuration of modules (remote-sync and smtp) can be added or updated using synchly --config=module command. Initializing configurations can also be done using a file, synchly --config=module --file=filepath, refer Configuration using file.

By default, remote-sync and smtp modules are disabled, to enable them, use synchly --enable=module command.

To encyrpt the job configuration files use the command synchly --enable=cipher and to disable it globally use the command synchly --disable=cipher. Encryption of backup files can be done only when cipher module is enabled.

For the complete list of options and their behavior, refer List of options.

For running synchly as a daemon, refer Running as a deamon.

For creating multiple backup jobs, refer Running multiple jobs

Clone this wiki locally