Skip to content
This repository was archived by the owner on Jul 22, 2025. It is now read-only.

Configuration

KastenKlicker edited this page Oct 4, 2024 · 6 revisions

You will find the configuration file (config.yml) in the /plugins/SecureServerBackup/ directory. You have to start the server once with the plugin installed to generate the default configuration file.

backupFolder:

The directory where the local backups are stored. This directory must be in the main directory of the server. This directory will be created automatically if it doesn't already exists.


maxBackupFolderSize:

The maximum backups directory size in Gigabyte. If the directory size is greater than allowed size, the oldest backups will be deleted till the directory size is smaller than the allowed size.


excludeFiles:

List of files which should be excluded. By default the backup directory and the session.lock files are excluded. You might also want to exclude .jar files and other unnecessary files.


uploadProtocol:

Defines which upload protocol should be used for uploading the backup. At the moment sftp and ftps are valid values. If no vaild value is read, the backup won't be uploaded.


hostname:

Hostname or IP address of the remote server.


port:

The port of the remote server. Set to 22 for the default SFTP port and 21 for the default FTPS port.


username:

Username of the remote server user.


authentication:

For SFTP set the path of your private RSA Key File (passwordless) or remote users password.

For FTPS set your remote users password.


knownHosts: Just for SFTP

If you already have been connected to the remote host you can set the path to your knownHosts file or the host key.

If not the server will scan the host key at the first connection and save the host key to the given path.


timeout: Just for SFTP

Set the connection timeout for SFTP in seconds.


remoteDirectory:

The directory on the remote server where the backups will be stored. Make sure the directory already exists.


duration:

The duration between the backups. For valid values look into the JavaDocs 21 Duration.parse. An invalid value will disable the autobackup.

Clone this wiki locally