Settings

5 mins

V6 ProV6 MSPV6 Core

Overview

The settings section has a simplified view to configure system settings. Sections below detail each tabs options.

ℹ️ Not all settings are available in V6 Core.

System Settings

Some organizations have a legal or other requirement to add a warning banner to notify users of restrictions etc.. before they login. rConfig allows you to apply a standard banner to the login page. This is a free text field and should be kept brief if possible to avoid over consuming space on the login page.

System Timezone

Set the system timezone from this setting. This is a different configurable setting from the OS level timezone configuration and is required for rConfig to function correctly. The default is UTC, and you are recommended to change this depending on your services location. There are sometimes issues, saving the timezone, as it needs to be saved to the .env file directly on the disk. If you run into issues saving the timezone, please review the support KB article here.

As of V6.11.3 and V6 Core please note, in the UI, the time of all events, including backups, and other scheduled tasks will be displayed in the timezone you set here. However, the locale of the UI align with your browsers locale settings. This means that the date and time will be displayed in your browsers locale. i.e. for US users this would be MM/DD/YYYY, and for UK users this would be DD/MM/YYYY.

SMTP Settings

Configuring mail settings in rConfig is very important. You will get notifications of events, and issues via email from rConfig, but this will not work unless mail is configured correctly.

Please contact your mail administrator if you are unsure of your organizations mail/ SMTP or relay settings. All fields are required. Authentication fields are only required if the Authentication button is set to on.

ℹ️ Please use the Test Email and Test Notifications buttons to verify your email settings. Any errors when running these tests usually related to connectivity, mail servers authentication, or other SMTP protocol errors.

Device Credentials

The Device Credentials tab allows you to set a default Username & Password that maybe used when manually adding devices later to conveniently input a standard Username & Password that you have use in your organization. All fields are optional.

A few important things to note when create credential sets:

  1. When selecting a credential set, the Username and Password fields will be populated with the values from the selected credential set from the Devices form.
  2. Only one credential set can be selected as Default. This is to avoid confusion when selecting a credential set to use as a default fro your teams. If you want to use a different credential set as default, you will need to unselect the current default and then select the new default.
  3. The Credential Set Name is used to identify the credential set in the Devices form.
  4. You can update all devices creds in bulk by editing a credential set, and clicking the Rotate device credentials button. This will update all devices with the new credentials. Be careful with this option as it will immediately update all devices with this credential set with the new credentials.
  5. You can also update device credentials from a credential set using the rConfig application Rest API. Please see the REST API Access section for more information.

TFTP Server

You can enable or disable the TFTP server from here. More information on the TFTP server can be found in the TFTP Server section.

Logging & Debugging

Logging & Debugging Options

Logging & Debugging Options allow you to enable or disable certain rConfig application Logging & Debugging settings.

  1. Debug device output - logs verbose output to files when downloading configurations, such as returned prompts, errors etc... This is similar to adding the -d switch to the rconfig:download-device command
  2. PHP Error Logging - This is enabled by default. Do not disable unless asked to by rConfig Support. If you encounter any PHP or application errors, please report them to rConfig Support.

Security

Logging & Debugging Options

A notice to inform that 'Password encryption is enabled for all passwords' is present, and this is not configurable.

Download Key

Download Key Setting (previously API Token)

You will know, having purchased rConfig, that you must acquire an Download Key from the rConfig.com portal to install or update rConfig. The Download Key settings page allows you to validate your currently configured token, and change it if needed. Some notes on this;

  1. Your Download Key is tied to your account. Any misuse of the token will be recorded and acted on.
  2. You may validate your current token using the Validate Current Token button. One validated per screenshot below, you may use this token to install or update rConfig.
  3. From time to time you may need to change your token in the rConfig portal. During your subscription period you may do this as often as needed. But, you must update this form with the new token to update the current rConfig installation.

LDAP

As of 6 you may configure rConfig to use LDAP Authentication. Before we get into configuration, here are somethings to know about this LDAP implementation.

  1. Fallback to Local auth is the default if LDAP does not work or the LDAP servers are unreachable.
  2. Any users that are authorized and authentication via LDAP - their credentials are stored in rConfigs database encrypted, to allow local fallback.
  3. For the immediate login after an LDAP password change, both the old and new passwords will work until the new password is entered in rConfig login and authenticated correctly.
  4. Only AD LDAP is supported as of Version 5.1. OpenLDAP may come in the future.
  5. You should consult your AD administrator for assistance in configuring and testing LDAP settings.
  6. As of 6.8, only Active Directory, and FreeIPA is supported. OpenLDAP support is coming in a future version.
FieldNotes
LDAP EnabledEnable or disable LDAP Authentication - Off by default
LDAP ServerHostname/ IP of LDAP Server - Multiple hosts can be added separated by commas. Hosts will be checked in order.
LDAP PortLDAP Port if different from default of 389
Use SSLOption to SSL, the port will default to 636, and can be changed.
Use TLSOption to choose TLS. SSL will be disabled, and the port will default to 389 and can be changed
Password SyncSync user LDAP passwords to database. They will be encrypted. Useful for local fallback incase LDAP is unavailable.
LDAP Bind UsernameUsername, if required to authenticate and read LDAP
LDAP Bind PasswordPassword, if required to authenticate and read LDAP
Base DNA base dn is the point from where a server will search for users
Authorized GroupThe authorized group for users sign in. This will be a single authorized group, that users should belong to. An empty value means the user can be anywhere in the directory.
Username fieldThis will be the username used to login, usually set to 'userprincipalname' in AD. (sAMAccountName is not supported for LDAP Username Field)
First Name fieldUsed to store the users firstname in rConfig DB
Last Name fieldUsed to store the users lastname in rConfig DB
Test LDAPAllows you to test your LDAP settings, but be sure to save the settings first.

FreeIPA Implementation Notes

To enable FreeIPA LDAP authentication, you must follow the steps below.

  1. Enable LDAP Authentication in rConfig. Open the .env file
vi /var/www/html/rconfig6/current/.env
  1. Change or add the following lines
LDAP_SCHEMA=freeipa
  1. Refresh the application cache
cd /var/www/html/rconfig6/current && php artisan rconfig:clear-all
  1. Set the parameters in the LDAP settings page in rConfig. Some notes on this; LDAP Username is normally the full DN of the user, such as uid=ldapuser,cn=users,cn=accounts,dc=example,dc=com. Base DN is normally cn=users,cn=accounts,dc=example,dc=com. Username field is normally uid.

rConfig support team can provide some limited support to help with LDAP implementation, but often AD admin support if a good first step for assistance.

REST API Access

As of 6.2 the REST API interface is fully supported. From this tab you can create and delete tokens, and view the current tokens. Click the 'View Docs' button to view the API documentation.

⚠️ As of 6.5, the key for the API token is no longer 'api_token'. It is now 'apitoken'. Example call is now /api/v1/devices/1?apitoken=<token>.

The below screenshot shows how to access the documentation for the rConfig API.

Import /Export

In this section, you can import and export your rConfig data. This is useful if you want to move your settings to another rConfig installation, or if you want to backup your settings.The Device import wizard walks you through the process of importing your device data. You can export a number of tables directly from the database in the second section of this page.

Backup Strategy

The system backup cleanup strategy below will be used to clean up old system backups. The default settings will keep all system backups for a certain amount of days. After that period only a daily system backup will be kept. After that period only weekly system backups will be kept and so on. No matter how you configure it the strategy will never deleted the newest system backup. This relates to rConfig system backups only, and not device configuration backups.

Steps for a successful system backup strategy

  1. Start a manual backup from the backups page
  2. Set you backup clean up strategy per the settings below
  3. Configure a daily, weekly or other backup scheduled task
  4. Configure a daily, weekly or other Backup Clean Up scheduled task
  5. Monitor email notifications and logs for success and failures

You can check for latest version from this page as we release new versions. This section also has detailed update and upgrade instructions. When an update is available, release notes for that update can be view from this page also.

About

License and Support Information is available on this page.

Edit this page on GitHub
Table of Contents