User settings¶
There're two configuration sections available: user settings and system-wide settings. The first one is available as submenu items under your username on the top right corner of the screen. Two options are available:
- Profile
Here you can change your full name, password, mail and access token. - Settings
Here you can adjust personalization options such as date format, interface language and interface options.
System settings¶
These settings dilate to the whole system. Four global sections are available in system settings:
Global settings¶
-
Isolated system
If system is isolated, there's no access to the internet, therefore some features will not be available in isolated mode: i.e. live update and content delivery.
-
Administrator email
Mail recipient for all major reports, by default it's equal to your root user's mail. -
Nodes lifetime
This settings defines how long unreachable node will stay in database. By default it's0
, so no nodes will be purged from database. Adjust this value according to your needs and policies. -
Logs lifetime
This setting defines how long log entries will be stored in database. Logs are main database disk space consumers, so limiting this value will have major impact on how much disk space database will utilize. By default it's7
days. For 1200 nodes with daily discovery and backup processes 7 days of logs consume ~13 Mb on INFO logging level. -
System log level
This setting defines how much detalization do you need. Logging levels are identical to default *nix system logging levels. -
Default prepend location
This is a string, that by default will be prepended to all locations in nodes. Can be useful for geolocation. -
Git path
Path to git executable, ensure it's valid
Git settings¶
-
Use Git
Git functionality is one of main cBackup features and shoud not be ignored if you want to run the tool at its' full potential. Git repository initialization will be run in the directory marked as backup root (seePath to storage folder
from Background process settings) -
Git username, Git email
Username and email which will be used as author credentials for configuration file commits -
Use git remote
You can push data to remote Git repository, if you would like to use it as additional safety replication layer. E.g. you can push it to your local gitlab installation. If you use git remote, it's also necessary to enter valid data in git login and git password fields in the configuration.Warning
We strictly discourage you from using Github, Bitbucket or any other public services as long as your configuration files can contain sensitive data.
-
Git log display period
For what perios in days changes in configuration will be displayed under button. Please note, that commit log itself is not truncated, this setting only affects data in the web interface popup under button.
Note
After saving configuration, two buttons on top of the section's panel will become available: Init repository and Reinit Git settings. You want to initialize repository upon the first run to start using Git and if you've changed any git-related setting. Initialization writes down .git
folder with related metadata.
Mailer settings¶
All settings should be understandable. You can adjust sender address and choose between SMTP or sendmail transport, adjusting related variables if necessary. These settings will be used sending regular scheduled reports or dumping critical errors in case of emergency.
Background process settings¶
These settings are related to the cBackup Java daemon:
-
SNMP timeout
Increase it if necessary, on LAN 500ms should be enough -
SNMP retries
How many attempts daemon will make trying to reach the node, 3 by default -
Telnet timeout
Generally it has to be substantially longer than SNMP timeout -
Telnet before send delay
We recommend putting at least 200 ms delay before command send -
SSH before send delay
We recommend putting at least 1000 ms delay before command send -
Path to storage folder
Where all config data is stored, must exist and be writable -
Thread count
How much threads Java daemon will launch. For two cores on VM on Xeon E5620, 30 threads utilizes CPU completely when backup is running, but yet without excessive overload
Server credentials¶
These are credentials used by cBackup web core to connect to the server via SSH protocol to start, stop or restart cBackup system daemon.
Daemon credentials¶
These are credentials used by cBackup web core to connect to the java daemon socket via SSH protocol to manage the internal daemon scheduler.