rConfig Vector – Server Installation
1. Introduction
1.1 Licensing
rConfig Vector is a licensed product. You will need a valid license to use the product. If you do not have a license, please contact us at [email protected] to obtain a license. rConfig V7 Professional users are able to upgrade existing licenses and installations to rConfig Vector.
1.2 Prerequisites
Before you begin the installation, ensure you have the following:
Server requirements
The server requirements are almost the same as rConfig V7. See /getstarted/os-setup/ for updated information. But we do expect some enhanced resource requirements for the server. The following are the minimum requirements for the server:
- 4 CPU Cores minimum
- 16 GB RAM minimum
- 250 GB Disk Space minimum
Infrastructure and Security requirements
In most, but not all cases, rConfig Vector server will be need to be accessible from the internet for the agents to connect to it. Of course, the agents can connect privately also, should connectivity and routing allow it. Ensure you have the necessary infrastructure and security measures in place to allow this.
We expect the server to be accessible on port 443 (HTTPS) from the internet. Ensure you have the necessary firewall rules in place to allow this, and that you have a valid SSL certificate installed on the server.
Requirements:
- Public IP address (Natted or direct), with inbound source IP restrictions
- Firewall rules to allow inbound traffic on port 443 only from the agents source IP addresses
- Valid SSL certificate installed on the server (no self-signed certificates). Must be TLS 1.2 or higher.
- DNS entry for the server
- Reverse DNS entry for the server (optional but recommended)
- Outbound internet access from the server for pinging rConfig for updates
- Monitoring, we expect customers to add this IP address to their monitoring systems to ensure secure connectivity at all times.
- Any other security measures you feel are necessary to secure the server, such as 2FA, IPS, IDS, etc.
2. Installation
Actual installation steps are very similar to V7 Professional and a very easy to follow.
Complete the rConfig Professional installation by following three steps. Please run
all steps as root
- Setup a new MySql or MariaDb User account
- Download the deployer script
- First run Initialization of the deployer script
- Deploy rConfig and verify installation
Install steps per OS type
OS Setup scripts
If not done already, install a new CentOS, Rocky, Rhel, or Alma server, and run the OS install script per the instructions per OS Setup Scripts.
Setup a MariaDB/ MYSQL User
Rocky 9+ users will need to create a new user and password for the database. Login to the MariaDB/Mysql Database server using the root user. The root user password is the same as the one you used in the OS install script.
Create the user and password for the database. And example is below, but you will need to change the username/password to something more secure.
Download the deployer script
First run Initialization of the deployer script
You need to have the follow details ready before you run the next command.
- Database host name - ‘localhost’ if you followed all the instructions to this point
- Database user name - ‘root’ unless you specify otherwise
- Database password - per the previous steps in OS Setup
- Hostname - The DNS Hostname for your machine, please create one if you do not have one already prepared
- API Token - This can be retrieved from the license keys section rConfig.com portal (remove the angel brackets < >)
Once you have the above details, run the following command to initialize the rConfig installation.
Note: We use Laravel Envoy as the deployment tool. If the envoy command fails for any reasons, first check that your system does not have https://www.getenvoy.io/ installed. You can check this by running the following;
Anything other than /root/.composer/vendor/bin/envoy
returned and you need to uninstall the ‘other’ envoy, or update the environment variable to the correct Laravel Envoy path.
Deploy rConfig and verify installation
Next, run the following command to deploy rConfig.
OS Setup scripts
If not done already, install a new Ubuntu server, and run the OS install script per the instructions per OS Setup Scripts.
Ubuntu Installation
The rConfig V7 installation is available for Ubuntu. But the install steps are a little different. FOLLOW THE INSTRUCTIONS BELOW. If not done already, install a new Ubuntu server, and run the OS install script per the instructions per Ubuntu Setup Script.
Install composer
Though the below envoy install script has been tested on Ubuntu 18.04, we recommend you install composer on your own.
If the envoy --version
returns valid output per below, this step has been completed. The composer version can be any variant of the 2.x version.
Download the deployer script
Setup a MariaDB/ MYSQL User
Ubuntu users will need to create a new user and password for the database. Login to the MariaDB/Mysql Database server using the root user. The root user password is the same as the one you used in the OS install script.
Create the user and password for the database. And example is below, but you will need to change the username/password to something more secure.
First run Initialization of the deployer script
You need to have the follow details ready before you run the next command.
- Database host name - ‘localhost’ if you followed all the instructions to this point
- Database user name - The username you created in the previous step
- Database password - The password you created in the previous step
- Hostname - The DNS Hostname for your machine, please create one if you do not have one already prepared
- API Token - - API Token - This can be retrieved from the license keys section rConfig.com portal (remove the angel brackets < >)
Deploy rConfig and verify installation
Reset storage directory permissions
Update apache web server
3. Post Installation
Once this process has completed without errors you may login to the server IP address or hostname with the following credentials
Username: [email protected]
Password: admin