Rconfig
π V8 Core Released! Major upgrade complete - fully modernized codebase with new features, resolved deprecations, updated tests, and improved architecture. Ready for production use.
Install / Use
/learn @rconfig/RconfigREADME
<a name="readme-top"></a>
<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/rconfig/rconfig"> <img src="https://portal.rconfig.com/images/rconfig-logos/v8-core-logo-and-icon/rconfig_v8_core_logo_and_icon_with_strapline_gradient.png" alt="rConfig Logo" width="600"/> </a> <h1 align="center">rConfig v8 Core</h1> <p align="center"> <strong>Enterprise-Grade Network Configuration Management</strong> <br /> Free, Open Source, Community Edition <br /> <br /> <a href="https://v8coredocs.rconfig.com"><strong>π Explore the Docs Β»</strong></a> <br /> <br /> <a href="#quick-start">Quick Start</a> Β· <a href="#features">Features</a> Β· <a href="#installation">Installation</a> Β· <a href="https://github.com/rconfig/rconfig/issues">Report Bug</a> Β· <a href="https://github.com/rconfig/rconfig/issues">Request Feature</a> </p> <!-- Badges --> <p align="center"> <a href="https://github.com/rconfig/rconfig/actions"> <img src="https://github.com/eliashaeussler/typo3-badges/actions/workflows/tests.yaml/badge.svg" alt="Tests"/> </a> <a href="LICENSE"> <img src="https://img.shields.io/github/license/rconfig/rconfig" alt="License"/> </a> <a href="https://github.com/rconfig/rconfig/stargazers"> <img src="https://img.shields.io/github/stars/rconfig/rconfig?style=social" alt="GitHub stars"/> </a> </p> <!-- Technology Badges --> <p align="center"> <img src="https://img.shields.io/badge/PHP-8.4+-777BB4?logo=php&logoColor=white&style=for-the-badge" alt="PHP 8.4+"/> <img src="https://img.shields.io/badge/Laravel-12-FF2D20?logo=laravel&logoColor=white&style=for-the-badge" alt="Laravel"/> <img src="https://img.shields.io/badge/Vue.js-3-4FC08D?logo=vue.js&logoColor=white&style=for-the-badge" alt="Vue 3"/> <img src="https://img.shields.io/badge/Vite-Latest-646CFF?logo=vite&logoColor=white&style=for-the-badge" alt="Vite"/> <img src="https://img.shields.io/badge/MySQL-8.0+-4479A1?logo=mysql&logoColor=white&style=for-the-badge" alt="MySQL"/> </p> </div>π― About rConfig v8 Core
rConfig v8 Core is a powerful, free, and open-source Network Configuration Management (NCM) solution designed to help you easily manage configurations across networks of any sizeβfrom small deployments to large, heterogeneous enterprise environments.
Why Choose rConfig?
- π Fast & Efficient - Optimized for high-performance configuration backups
- π Secure - Built with security best practices from the ground up
- π Multi-Vendor Support - Works with Cisco, Juniper, HP, and more
- π¦ Easy Deployment - Docker support for quick setup
- π° Cost-Free - No licensing fees, truly open source
- π οΈ Actively Maintained - Regular updates and community support
πΈ Screenshots
<details> <summary><strong>Click to view screenshots</strong></summary>Dashboard

β¨ Features
<table> <tr> <td width="50%">Core Features
- β Configuration Backup - Automated device backups
- β Multi-Vendor Support - Cisco, Juniper, HP, Dell, and more
- β Unlimited Devices - No artificial limits
- β Scheduled Tasks - Automated backup scheduling
- β Version Control - Track configuration changes over time
- β Search & Compare - Powerful config search and diff tools
Technical Stack
- π§ Laravel 12 - Modern PHP framework
- π¨ Vue.js 3 - Reactive UI components
- β‘ Vite - Lightning-fast builds
- π¨ shadcn/ui - Beautiful UI components
- π³ Docker Ready - Container deployment
- π MySQL/MariaDB - Reliable database
π rConfig Editions Comparison
| Feature | π rConfig Core | π rConfig Professional | |----------------------|:---------------:|:-----------------------:| | Configuration Backup | β | β | | Multi-Vendor Support | β | β | | Unlimited Devices | β | β | | API Access | β | β | | Enterprise Features | β | β | | Priority Support | β | β | | SLA Guarantees | β | β |
<details> <summary><strong>π View Full Feature Comparison</strong></summary> <br> Check out the complete feature list at <a href="https://www.rconfig.com/pricing#full-features">rconfig.com/pricing</a> </details> <p align="right">(<a href="#readme-top">β¬ back to top</a>)</p>π Quick Start
Get rConfig v8 Core up and running in minutes!
Option 1: π³ Docker (Recommended for Quick Testing)
For Docker installation, please use our dedicated Docker repository:
π rconfig8coredocker
# Clone the Docker repository
git clone https://github.com/rconfig/rconfig8coredocker.git
cd rconfig8coredocker
# Start the containers
docker-compose up -d
# Access at http://localhost:8080
Default credentials:
- π§ Email:
admin@domain.com - π Password:
admin
β οΈ Important: Change these credentials immediately after first login!
Option 2: π» Native Installation
See the Full Installation Guide below.
<p align="right">(<a href="#readme-top">β¬ back to top</a>)</p>π¦ Installation
Prerequisites
Supported OS: Rocky Linux 8/9+ (recommended), CentOS 8/9+, RHEL 8/9+, Ubuntu 22.04+, Alma Linux 8/9+, AWS Linux 2023
Required Software: PHP 8.4+, Composer 2.4+, Apache 2.4+, MySQL 5.7+/MariaDB 10.5+, Node.js 14.17+, Git 2.25+, Supervisor 4.2+
π‘ Tip: We provide automated setup scripts! Visit docs.rconfig.com/getstarted/os-setup
ποΈ Database Setup
# Login to MySQL
mysql -u root -p
# Create database
CREATE DATABASE rconfig;
# Create user (recommended for Ubuntu 22.04+)
CREATE USER 'rconfig_user'@'localhost' IDENTIFIED BY 'your_secure_password';
GRANT ALL PRIVILEGES ON rconfig.* TO 'rconfig_user'@'localhost';
FLUSH PRIVILEGES;
EXIT;
π₯ Installation Steps
# 1. Navigate to web directory
cd /var/www/html
# 2. Clone the repository
git clone https://github.com/rconfig/rconfig.git
cd rconfig
# 3. Create environment file
cp .env.example .env
# 4. Edit .env with your settings
nano .env
Update these variables in .env:
APP_URL="https://your-server.domain.com"
APP_DIR_PATH=/var/www/html/rconfig
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=rconfig
DB_USERNAME=rconfig_user
DB_PASSWORD=your_secure_password
# 5. Install PHP dependencies
export COMPOSER_ALLOW_SUPERUSER=1
composer self-update --2
yes | composer install --no-dev
# 6. Setup Apache
chmod +x setup_apache.sh
./setup_apache.sh
# 7. Setup Supervisor
chmod +x setup_supervisor.sh
./setup_supervisor.sh
# 8. Run the beautiful installation wizard π¨
php artisan v8core:install
π When prompted about cron scheduling, type
yesand press Enter.
π§ Final Configuration
# Update Apache virtual host
# For CentOS/RHEL:
sudo nano /etc/httpd/conf.d/rconfig-vhost.conf
# For Ubuntu:
sudo nano /etc/apache2/sites-enabled/rconfig-vhost.conf
Update ServerName:
ServerName your-server.domain.com
ServerAlias your-server.domain.com
# Restart Apache
# CentOS/RHEL:
sudo systemctl restart httpd
# Ubuntu:
sudo systemctl restart apache2
# Set permissions and clear cache
# CentOS/RHEL:
cd /var/www/html/rconfig
chown -R apache storage bootstrap/cache
php artisan rconfig:clear-all
# Ubuntu:
cd /var/www/html/rconfig
chown -R www-data storage bootstrap/cache
php artisan rconfig:clear-all
π Access Your Installation
Open your browser and navigate to: https://your-server.domain.com
Default System Credentials:
- π§ Email:
admin@domain.com - π Password:
admin
<p align="right">(<a href="#readme-top">β¬ back to top</a>)</p>β οΈ Security Notice: Change or remove these credentials immediately after creating a new admin user!
π³ Docker Installation
Running rConfig v8 Core in Docker provides:
- β¨ Easy Setup - Get started in minutes
- π Isolation - Clean containerized environment
- π Portability - Move between systems easily
- π¦ Consistency - Same behavior everywhere
Docker Repository
We maintain a dedicated Docker repository for rConfig v8 Core:
π rconfig8coredocker
Quick Docker Setup
# Clone the Docker repository
git clone https://github.com/rconfig/rconfig8coredocker.git
cd rconfig8coredocker
# Build and start containers
docker-compose up -d
# Access at http://localhost:8080
π Full Docker documentation: rconfig8coredocker repository
<p align="right">(<a href="#readme-top">β¬ back to top</a>)</p>π Updating
β οΈ Before updating:
- Backup your database
- Backup your
.envfile- Backup your
storagedirectory- Backup your entire server if possible
PHP 8.4 Update (Required as of Feb 2024)
# For CentOS/RHEL/Rocky:
cd /home
yum -y install wget
wget https://dl.rconfig.com/downloads/php-updates/centos-php8-update.sh -O /home/centos-php8-update.sh
chmod +x centos-php8-update.sh
./centos-php8-update.sh
# For Ubuntu:
cd /home
sudo apt-get install wget
wget https://dl.rconfig.com/downloads/php-updates/ubuntu-php8-update.sh -O /home/ubuntu-php8-update.sh
chmod +x ubuntu-php8-update.sh
./ubuntu-php8-update.sh
Update Commands
# CentOS/Rocky/RHEL:
cd /var/www/html/rconfig
git pull
php artisan migrate
php artisan rconfig:sync-ta
