rConfig6-Docker (DEPRECATED)

As of November 2024, this project is no longer maintained. rConfig6-Docker is fully deprecated and will no longer be supported in the public repository. This notice does not affect customers with current subscription arrangements until the end of the term of those arrangements.

rConfig6-Docker has been in development since 2022, and we are incredibly proud of its impact and value for network professionals and businesses worldwide.

However, we are pleased to announce the release of rConfig v6 Docker. This is a complete rewrite of the rConfig application, built on the latest technologies, and offers a more streamlined and efficient experience. rConfig v6 Professional is a paid subscription product available for purchase at rConfig Professional, and rConfig v6 Core is free and open source, available on the rConfig GitHub repository at rConfig6 Core.

To access the new rConfig v6 Docker, please visit our new repository here: rConfig v6 Docker.

---

⚠️ Important Notice

If you download and use the code from this repository, you are doing so at your own risk. rConfig6-Docker will no longer be updated or maintained. This code and repository will remain available for historical purposes only.

---

Useful URLs

• Docker Installation for CentOS/Rocky
• Manual Docker Compose Installation for CentOS/Rocky (useful in case the previous installation fails)

---

Installation (Deprecated)

1. Clone the Repository

First, clone the repository to a directory of your choosing:

cd /var/www/html
git clone https://github.com/rconfig/rconfig6-docker.git


2. Create top level .env file

   ```sh
   cd rconfig6-docker
   cp .env.example .env

3. Edit the .env file with your DB and other parameters

   vim .env

   APP_URL=somehostname.yourdomain.com
   APP_PORT=8080
   
   DB_CONNECTION=mysql
   DB_HOST=rconfig6-mariadb
   DB_PORT=3306
   DB_USERNAME=root
   DB_PASSWORD=
   
   RCONFIG_API_TOKEN=
   
   #REDIS ENV CONFIG
   REDIS_HOST=rconfig6-redis
   REDIS_PASSWORD=null
   REDIS_PORT=6379
   
   #EXPOSED PORTS
   EXPOSED_APP_PORT=8080

If you are uncertain about any of the above, the most important items to change are the DB_PASSWORD and the RCONFIG_API_TOKEN

4. Bring up the containers. This time we remove the Horizon container from the build as the application init is not complete so will throw errors. (This will take a few minutes the first time)

   docker-compose up --scale horizon=0 -d --build

5. Once the comtainers are up and running with no errors from the previous output, login to the php-apache container

   docker-compose exec php-apache /bin/bash

6. Download envoy script

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

7. Run the envoy init

   envoy run init --dbhost=$DB_HOST --dbuser=$DB_USERNAME --dbpass=$DB_PASSWORD --hostname=$APP_URL --apitoken=$RCONFIG_API_TOKEN

8. run the envoy deploy

   envoy run deploy --apitoken=$RCONFIG_API_TOKEN

9. Once the installation completes with no errors, exit the container, bring everything down, and start all containers up.

   exit
   docker-compose down
   docker-compose up -d --build

10. your final output from the previous step should look like this

[+] Running 6/6
⠿ Network rconfig6-docker_rconfig6Network  Created       0.3s
⠿ Container rconfig6-redis                 Started       0.6s
⠿ Container rconfig6-mariadb               Started       0.7s
⠿ Container rconfig6-php-apache            Started       1.1s
⠿ Container rconfig6-horizon-supervisor    Started       1.6s
⠿ Container rconfig6-cronjob               Started       1.6s

When troubleshooting issues, the following commands are useful. docker ps -a docker logs CONTAINERNAME

Disk or storage permissions issues

If you have permissions issues, such as errors that rConfig cannot write to the storage directory, follow these steps.

1. Login to the php-apache container

   docker-compose exec php-apache /bin/bash

2. View the users list and find the id for the www-data account

   more /etc/passwd | grep www

3. The output should be similar to this

   www-data:x:33:33:www-data:/var/www:/usr/sbin/nologin

4. Simply apply the correct permissions to the persistentdata directory

   chown -R 33 persistentdata/

(back to top)

Usage

The default port for the web app is 8080. So go ahead and login to yourhostname.domain.com:8080 with the rConfig default creds per the documentation.

Please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

This code base for this repository's code is distributed under the MIT License. See LICENSE.txt for more information. rConfig v6 is excluded from this license and repository.

(back to top)

Support

Although we provide this code free and open source, rConfig v6 is based on a professional subscription arrangement. You may open issues in the issue section here at github, but rConfig Professional subscribers should open a ticket via our normal support channels.