1. Home
  2. Docs
  3. ConfigFiles
  4. Getting Started

Getting Started

What do I need?

In order to use ConfigFiles, you should have the following things ready:

  • A database node to be monitored for configuration file management (virtual, physical, cloud machine, container). See Supported Database Servers.
  • An Internet connection from the database node to be monitored to ConfigFiles API endpoints.
  • ConfigFiles agent is installed and running on the database node.
  • An active account with ConfigFiles. Register or login here.

The database node must have an Internet connection (or is allowed) to connect to ConfigFiles API endpoints for server-agent communications. When creating a new account with ConfigFiles, you will be guided with the onboarding configuration wizard to install the agent and add a database host under Servers. Once a backup host has been detected with the agent running, you can proceed to Configuration Files and you can start managing or editing your configuration files.

Further reading:

What do I get?

Users will be able to apply changes on the fly for their database configuration files. Changes do not mean it will be applied directly to your running database server. For example, changing the innodb_buffer_pool_size of your MySQL database node, ConfigFiles will not do anything to your MySQL server. ConfigFiles will not restart your MySQL server or will not dynamically change variables. ConfigFiles is purely a simple configuration management service that provides a simple yet straightforward UI for convenience and ease of use. Applying changes to your config files and differentiating the changes from the version history can be easier with ConfigFiles.

Aside from managing your configuration files, ConfigFiles provides the following features and benefits for the users:

  • Unlimited agents can be deployed per account.
  • You can have maintained your version changes.
  • Free for everyone that uses the database we support.

What does it do?

ConfigFiles requires the user to deploy an agent on the node to be monitored. Upon deploying the agent, a user role has to be created with a limited scope of grants just to monitor and apply the changes for your database configuration file. All changes are saved and are kept in history so you can use this later for comparison and determine what are the changes that have been made. This is useful for tuning your database and determining what changes might have caused an impact on the changes that brought some performance degradation or casual damage in the event of a disaster. It scans for the configuration files, detects them, then the server is added to the list of Configuration Files along with detected configuration files.

What it won’t do?

ConfigFiles does not apply a restart for your database server, nor restart your host system, and it won’t apply the changes dynamically whenever there are changes happening from your configuration files that are managed by the ConfigFiles. ConfigFiles also does not delete any files that are not managed and do not care for any database configuration files that are not referenced in the main configuration file that was detected. For example, in MySQL, when /etc/my.cnf is detected and references an !includedir directive, then only those files with *.cnf extentions have to be managed and monitored.


Was this article helpful to you? Yes No