Skip to content

rConfig - V8 Pro Docker Container

5 mins V8 Pro

rConfig V8 Professional is an enterprise-grade Network Configuration Management (NCM) software designed to help you easily manage configurations on large and small heterogeneous networks. This guide provides the steps to install rConfig V8 Professional using Docker.


Complete the rConfig Professional installation in Docker by following those steps. Please run all steps as root

  1. Clone the Repository
  2. Login to rConfig Registry
  3. Configure the .env File
  4. Start the rConfig Docker Container
  5. Verify Container is Running
  6. Complete Installation Inside the Container
  7. Restart the Docker Container
  8. Access rConfig V8 Professional

Installation

Section titled “Installation”

Prerequisites

Section titled “Prerequisites”

Before starting the installation, ensure the following:

  1. Docker and Docker Compose are installed on your server.
  2. The data directory should be writable by the web server user inside the Docker container, and the contents of the data directory in this repository should be copied to the data directory on your server. You may clone this repository and copy the contents of the data directory to your server if you wish.
  3. rConfig Professional Subscription is required for Docker image access. Ensure you have valid credentials for the private registry.
  4. You need to be logged in as root when executing the scripts.

Steps

Section titled “Steps”

Clone the Repository

Section titled “Clone the Repository”

Clone the rConfig V8 Docker repository to your server:

Terminal window
git clone https://github.com/rconfig/rconfig8docker.git
cd rconfig8docker

Login to rConfig Registry

Section titled “Login to rConfig Registry”

Authenticate with the rConfig private Docker registry to pull the rConfig image. You will need to have a valid subscription to rConfig Professional to access the registry. Credentials are provided by rConfig.

Terminal window
docker login reg.rconfig.com:8443
Username: robot$rconfig+yourname
Password: # Enter your credentials

Configure the .env File

Section titled “Configure the .env File”

Navigate to the data directory and update the .env file with the following settings:

Terminal window
APP_DEBUG=true/false
APP_URL=http://yourFQDNorIP.domain.com
DB_HOST=db  # Database container or external DB server
DB_PORT=ENVOY_DB_PORT
DB_DATABASE=ENVOY_DB_DATABASE
DB_USERNAME=ENVOY_DB_USERNAME
DB_PASSWORD=ENVOY_DB_PASSWORD
RCONFIG_API_TOKEN=ENVOY_API_TOKEN

Start the rConfig Docker Container

Section titled “Start the rConfig Docker Container”

Start the container with the following command:

Terminal window
docker-compose up -d

Verify Container is Running

Section titled “Verify Container is Running”

Check that the container is running using the following:

Terminal window
docker ps

Complete Installation Inside the Container

Section titled “Complete Installation Inside the Container”

Execute the following commands inside the Docker container:

Terminal window
docker exec -it rconfig-container-name bash


# Run the artisan commands to complete the installation:
php artisan migrate
php artisan key:generate
php artisan passport:install  # Answer 'yes' to any prompts
php artisan rconfig:sync-tasks
php artisan rconfig:sync-search
php artisan rconfig:clear-all
php artisan rconfig:update-rbac-data


# Set permissions for the storage directory
chown -R www-data:www-data /var/www/html/rconfig8/current/storage
chmod -R 775 /var/www/html/rconfig8/current/storage

Restart the Docker Container

Section titled “Restart the Docker Container”

After completing the setup, restart the Docker container:

Terminal window
docker-compose up -d

Access rConfig V8 Professional

Section titled “Access rConfig V8 Professional”

You can now access the rConfig V8 Professional interface at the URL you specified in the .env.

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