Installation

15 mins

V6 ProV6 MSP

Introduction

The main installation guide is for RHEL, Rocky and CentOS distributions. See last section on this page for Ubuntu Installation guide.

ℹ️ rConfig V6 Core
rConfig V6 Core is the free version of rConfig. Setup and installation instructions are located on the github repository. Click on the link below to go to the github repository, and follow the install instructions there.

1. Download the deployer script
2. First run Initialization of the deployer script
3. Deploy rConfig and verify installation

⚠ WARNING: SSL Setup

SSL is not configured as part of the default rConfig setup. We highly recommend SSL configuration, and you can use your own PKI, or a free service such as 'lets encrypt'. But we left this out as ultimately the choice is yours on how you want to implement SSL depending on your corporate policy. Contact us if you need assistance in getting SSL operational for your rConfig v6 installation. Update: We have provided a guide in the docs on how to get SSL up and running. SSL Setup Document

Download the deployer script

mkdir /var/www/html/rconfig6
cd /var/www/html/rconfig6
wget https://www.rconfig.com/downloads/rconfig6-envoy.blade.php -O /var/www/html/rconfig6/Envoy.blade.php

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 your dashboard on rConfig.com (remove the angel brackets < >)

Once you have the above details, run the following command to initialize the rConfig installation.

envoy run init --dbhost=localhost --dbuser=root --dbpass=SomePassword --hostname=rconfig6vm.domain.local --apitoken=<someCode>

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;

[root@homedev html]# which envoy
/root/.composer/vendor/bin/envoy

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.

 envoy run deploy --apitoken=<someCode>

Once the process has completed without errors you may login to the server IP address or hostname with the following credentials

Username: admin@domain.com Password: admin

ℹ️ Please setup a new admin user in settings as a first step and delete this user once your new user can login and is verified.

Ubuntu Installation

The rConfig v6 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.

composer global require laravel/envoy
echo 'export PATH="$PATH:$HOME/.config/composer/vendor/bin"' >> ~/.bashrc
source ~/.bashrc
envoy --version

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.

users1@devtextubuntu2004:/var/www/html$ envoy --version
Laravel Envoy 2.8.2

sudo mkdir /var/www/html/rconfig6
cd /var/www/html/rconfig6
sudo wget https://www.rconfig.com/downloads/rconfig6-ubuntu-envoy.blade.php -O /var/www/html/rconfig6/Envoy.blade.php

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.

sudo mysql -u root -p

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.

GRANT ALL PRIVILEGES ON *.* TO 'user1'@localhost IDENTIFIED BY 'password1';
FLUSH PRIVILEGES;
quit;

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 - This can be retrieved from your dashboard on rConfig.com (remove the angel brackets < >)

sudo -E env "PATH=$PATH" envoy run init --dbhost=localhost --dbuser=user1 --dbpass=SomePassword --hostname=rconfig6vm.rconfig.com --apitoken=<someCode>

sudo -E env "PATH=$PATH" envoy run deploy --apitoken=<someCode>

sudo chown -R $USER:www-data /var/www/html/rconfig6/persistentdata/
sudo chmod -R ug+w /var/www/html/rconfig6/persistentdata/

sudo a2enmod rewrite
sudo service apache2 restart

Once this process has completed without errors you may login to the server IP address or hostname with the following credentials

Username: admin@domain.com Password: admin

ℹ️ Please setup a new admin user in settings as a first step and delete this user once your new user can login and is verified.