Server: Getting started

Setup database

Please setup a MariaDB (or MySQL) server and create an empty database.

Setup server

Download and build

To download and build the server and the dashboard, please use the install script:

curl https://raw.githubusercontent.com/SalvatorBackup/salvator/master/install-server.sh | sh

Configure and start

Salvator's configuration is made by setting environment variables and then run the following command:

npm start

The available configuration variables are:

• DB_TYPE: database name (default is mysql)
• DB_HOST: database host (default is localhost)
• DB_PORT: database port (default is 3306)
• DB_USERNAME: database username (default is root)
• DB_PASSWORD: database password (default is empty)
• DB_NAME: database name (default salvator)
• BACKUP_DIR: where to store all backups (default is a backups folder in root directory)
• DASHBOARD_PASSWORD: password to access to the dashboard (default is SalvatorFTW)
• SESS_SECRET: secret used to sign cookie (default is keyboard cat)

For example, the command:

DASHBOARD_PASSWORD=pimpmyride npm start

Will run the server with pimpmyride as dashboard password.