Skip to main content

Working with Access Server's Configuration Database

Access Server stores configurations in SQLite database files. You can also migrate to a MySQL-type database, but the SQLite database files are the default setup.

configuration-database.png

When you modify your Access Server setup in the Admin Web UI or with a command-line tool, you update the configuration and these database files.

Default configuration file locations

These are the default configuration file locations:

  • Global server configuration: /usr/local/openvpn_as/etc/db/config.db

  • Server and client certificates: /usr/local/openvpn_as/etc/db/certs.db

  • User and group properties: /usr/local/openvpn_as/etc/db/userprop.db

  • Log database: /usr/local/openvpn_as/etc/db/log.db

  • Debug and low level settings: /usr/local/openvpn_as/etc/as.conf

  • Local server node configuration: /usr/local/openvpn_as/etc/db/config_local.db

  • Cluster configuration: /usr/local/openvpn_as/etc/db/cluster.db

  • Cluster notification system: /usr/local/openvpn_as/etc/db/notification.db

If you're running Access Server on a Docker container, refer to Tutorial: How to Back Up Access Server Configuration on Docker.Tutorial: How to Back Up Access Server Configuration on Docker

How to view the current server configuration

You can list your current server's configuration, user and group properties, and specific properties for users and groups with the command-line tool sacli.

Configuration for authentication modes

The user configuration is stored differently depending on your authentication mode. This tutorial helps you determine where to find user and group properties.

Back Up Access Server's Configuration

It's a security best practice to create regular backups of your configuration. We also recommend it before upgrading or migrating to a new server. Follow this tutorial to create backups of your SQLite 3 database files.

Important

If you use a separate database server, ensure you create a server backup. The above tutorial applies to Access Servers using the default SQLite3 database files.

Note

If you need help creating a backup VPN, refer to the high-availability topic.

Recover Access Server with backup files

Should you need to recover an Access Server from a backup point or migrate to a new server, refer to this tutorial for the commands to restore from backup files:

Recover damaged database configuration files

Suppose your Access Server uses the default SQLite3 database files on a single node, and they've become managed. Refer to our troubleshooting page:

Use ConfigReplace for manual configuration edits

Access Server supports a command, ConfigReplace, which allows you to upload configuration changes in one file, and Access Server imports those changes to the correct configuration files.