System Settings Reference
System Settings Reference: Configuration and Administration Guide for rConfig V8
Section titled “System Settings Reference: Configuration and Administration Guide for rConfig V8”The System Settings interface in rConfig V8 provides centralized access to all configuration, security, maintenance, and administrative functions. This reference guide maps each settings section to its purpose and detailed documentation, enabling administrators to quickly locate configuration areas and understand their impact on system operations.
Organizations can use this reference to navigate system configuration efficiently, understand relationships between settings sections, and maintain consistent administrative practices across deployment lifecycle.
Getting Started
Section titled “Getting Started”Settings sections for initial system configuration and ongoing assistance.
Help & Support
Section titled “Help & Support”Purpose: Access to rConfig documentation, video tutorials, community resources, and support contact information.
Key Functions:
- Links to comprehensive documentation library
- Video tutorial series for common tasks and troubleshooting
- Community forum access for peer assistance
- Support ticket submission for technical assistance
- Knowledge base articles for frequently asked questions
When to Use: When seeking guidance on system features, troubleshooting issues, or contacting support for assistance with complex problems.
Related Documentation:
- Support resources available at rConfig Support Portal
- Video tutorials at rConfig YouTube Channel
System Management
Section titled “System Management”Core system configuration, maintenance, and operational settings.
System
Section titled “System”Purpose: General system configuration including application name, timezone, date formats, and default user preferences.
Key Settings:
- Application name and branding
- Timezone configuration for timestamps
- Date and time display formats
- Default language and localization
- Session timeout settings
- User interface preferences
When to Use: During initial deployment to configure organizational standards, or when adjusting system-wide display and behavior preferences.
Related Documentation: Covered in this reference; see the System Settings sections above for configuration details.
System Optimization
Section titled “System Optimization”Purpose: Performance tuning settings including memory allocation, queue workers, connection pools, and caching strategies.
Key Settings:
- PHP memory limits and execution timeouts
- Queue worker counts and priorities
- Database connection pool sizing
- Cache driver configuration
- Performance monitoring thresholds
When to Use: When optimizing system performance for larger deployments, troubleshooting performance issues, or scaling to accommodate growing device inventories.
Related Documentation:
- PHP Settings - PHP memory and execution time configuration
- Horizon Queue Manager - Queue worker optimization
Backup Settings
Section titled “Backup Settings”Purpose: Configuration of automated system backups including schedule, retention policies, and backup destinations.
Key Settings:
- Backup schedule frequency (daily, weekly, custom)
- Backup retention policies (how many backups to retain)
- Backup destination (local storage, FTP server)
- FTP server configuration for offsite backups
- Backup notification settings
When to Use: During initial deployment to establish backup strategy, or when modifying backup frequency and retention based on operational requirements.
Related Documentation:
- Backups - Comprehensive backup configuration and management
Product Key
Section titled “Product Key”Purpose: License key management for activating rConfig features and maintaining subscription status.
Key Functions:
- Enter or update license key
- View license status and expiration
- Display licensed features and limits
- Subscription renewal information
When to Use: During initial installation to activate license, when upgrading subscription tiers, or when renewing expired licenses.
Related Documentation: No dedicated licensing guide is published yet; contact rConfig support for license activation or renewal questions.
Upgrade
Section titled “Upgrade”Purpose: In-place system upgrade management for updating rConfig to newer versions.
Key Functions:
- Check for available updates
- View release notes and change logs
- Execute upgrade process
- Rollback procedures if needed
- Upgrade history and status
When to Use: When new rConfig versions are released with features, improvements, or security updates requiring deployment.
Related Documentation: rConfig V7 to V8 Pro Upgrade Guide - Migration and upgrade procedures
Update
Section titled “Update”Purpose: Patch management for minor updates, security fixes, and hotfixes between major versions.
Key Functions:
- Check for available patches
- View security advisories
- Apply minor updates and hotfixes
- Update history tracking
When to Use: When security advisories are published, when minor bugs require patching, or during regular maintenance windows to apply cumulative updates.
Related Documentation: How to update rConfig V8 Pro - Applying updates and patches
Security & Access
Section titled “Security & Access”Authentication, authorization, and security hardening configuration.
Purpose: Role-based access control configuration, defining what each role can view and manage across rConfig.
Key Functions:
- Create and edit roles
- Assign granular permissions per role
- Review which users hold each role
When to Use: When onboarding a new team with different access needs, tightening permissions for a specific function, or auditing who can perform sensitive actions.
Related Documentation: Roles and Permissions - Role-based access control
Purpose: Management of individual user accounts, their assigned roles, and account status.
Key Functions:
- Create, edit, and disable user accounts
- Assign one or more roles to a user
- Reset passwords and manage account lockouts
When to Use: When adding or removing team members, changing a user’s role, or investigating account access issues.
Related Documentation: User Management - Managing user accounts and roles
Security
Section titled “Security”Purpose: System security settings including password policies, session management, encryption, and security hardening options.
Key Settings:
- Password complexity requirements
- Password expiration and rotation policies
- Session timeout and concurrent session limits
- Two-factor authentication (2FA) configuration
- API rate limiting
- Security headers and HTTPS enforcement
- Audit logging configuration
When to Use: During initial deployment to establish security baseline, when implementing compliance requirements, or when hardening system against security threats.
Related Documentation:
- System Encryption Key - Encryption key management and rotation
- rConfig V8 Security Hardening Guide - Authentication, RBAC, encryption, and compliance best practices
Config Obfuscator
Section titled “Config Obfuscator”Purpose: Pattern-matching rules that mask sensitive strings (passwords, keys, and similar secrets) in displayed and exported configuration output.
Key Functions:
- Define obfuscation rules using pattern matching
- Enable or disable individual rules
- Search and filter existing rules
When to Use: When configuration output needs to be shared, reviewed, or exported without exposing embedded secrets.
Related Documentation: Configuration Obfuscation - Defining and managing obfuscation rules
Device Credentials
Section titled “Device Credentials”Purpose: Management of authentication credentials used for connecting to network devices.
Key Functions:
- Create and manage credential sets
- Configure SSH passwords and private keys
- Set Telnet passwords
- Configure SNMP community strings and v3 credentials
- Enable password configuration
- Credential assignment to devices
- Assign a separate snippet credential set per device, used only for snippet pushes
- Restrict who can see a credential set with the Visible to Roles selector
When to Use: When adding new devices requiring different credentials, rotating device passwords, or organizing credentials by device groups or security zones.
Related Documentation: Device Credential Fields - Credential field reference on the device form
LDAP Setup
Section titled “LDAP Setup”Purpose: Integration with LDAP/Active Directory for centralized user authentication and automatic user provisioning.
Key Settings:
- LDAP server configuration (hostname, port, SSL/TLS)
- Bind credentials for directory queries
- Base DN for user searches
- Authorized group for access control
- User attribute mapping (username, email, name)
- Password synchronization for fallback authentication
- Connection testing tools
When to Use: When integrating rConfig with enterprise directory services for single sign-on, centralizing user management, or eliminating duplicate credential administration.
Related Documentation:
- LDAP Integration - Complete LDAP configuration and troubleshooting
Data Management
Section titled “Data Management”Import, export, migration, and data lifecycle management.
Backups
Section titled “Backups”Purpose: View backup statistics and manage existing system backup files (view, clean up, or restore).
Key Functions:
- View backup file listing and statistics
- Clean up old backup files
- Restore from a backup file
When to Use: When reviewing existing backup files or restoring a prior backup, while planning a migration to an external backup solution.
Related Documentation: No dedicated guide is published; see the deprecation note above before relying on this feature.
Import/Export
Section titled “Import/Export”Purpose: Bulk data import and export functionality for devices, configurations, policies, and system data.
Key Functions:
- CSV import for bulk device addition
- Configuration export for backup or analysis
- Policy definition export/import
- Compliance results export
- System configuration export
When to Use: When initially populating device inventory, migrating data between rConfig instances, creating data backups, or exporting data for external analysis.
Related Documentation: Device Add Workbook - CSV bulk device import. A dedicated guide covering policy, compliance, and system data export is not yet published.
Data Migration
Section titled “Data Migration”Purpose: Migration tools for upgrading from previous rConfig versions or moving between deployments.
Key Functions:
- Database migration from older versions
- Configuration file migration
- User account migration
- Policy and compliance data migration
- Integration configuration migration
When to Use: When upgrading from rConfig V6 or V7 to V8, migrating to new infrastructure, or consolidating multiple rConfig instances.
Related Documentation: rConfig V7 to V8 Pro Upgrade Guide - Version migration procedures
Data Purge
Section titled “Data Purge”Purpose: Permanent deletion of old data to manage database size and comply with data retention policies.
Key Settings:
- Configuration retention policies (keep configurations for X days/months)
- Compliance result retention
- Log retention policies
- Archived data purging
- Purge scheduling and automation
When to Use: When implementing data retention policies, managing database growth, complying with data privacy regulations, or reclaiming storage capacity.
Related Documentation: Data Purge - Retention policies and purge scheduling
Monitoring & Debugging
Section titled “Monitoring & Debugging”Logging, monitoring, and diagnostic configuration.
System & Health
Section titled “System & Health”Purpose: At-a-glance view of live system resource usage (CPU, memory, uptime) for the rConfig server.
Key Functions:
- View current CPU and memory utilization
- Check system uptime
- Spot-check server health without shelling in
When to Use: When investigating slow performance, confirming the server is under expected load, or doing a quick health check before a maintenance window.
Related Documentation: System Monitoring - Monitoring components, metrics, and best practices
Logging & Debugging
Section titled “Logging & Debugging”Purpose: Configuration of logging levels, debug modes, and diagnostic tools for troubleshooting.
Key Settings:
- Log level configuration (emergency, alert, critical, error, warning, notice, info, debug)
- Debug mode enabling for verbose output
- Log file rotation settings
- Performance profiling tools
- Query logging for database optimization
When to Use: When troubleshooting system issues, investigating performance problems, or gathering detailed diagnostic information for support requests.
Related Documentation:
- Application Log - Operational event logging
- System Logs - Framework and diagnostic logging
Application Logs
Section titled “Application Logs”Purpose: Access to database-driven application event logs for operational monitoring and troubleshooting.
Key Functions:
- View and filter application events
- Search log descriptions by keyword
- Filter by severity level
- Export logs for external analysis
- Configure log archival policies
When to Use: When investigating device connection issues, reviewing user activity, monitoring scheduled task execution, or troubleshooting application-level errors.
Related Documentation:
- Application Log - Complete application logging documentation
Scheduled Tasks
Section titled “Scheduled Tasks”Purpose: Management and monitoring of scheduled background tasks including configuration downloads, compliance checks, and maintenance operations.
Key Functions:
- View task execution history
- Monitor task success/failure rates
- Configure task schedules
- Enable/disable tasks
- Task performance metrics
When to Use: When reviewing task execution status, troubleshooting scheduled task failures, or optimizing task scheduling for performance.
Related Documentation:
- Scheduled Tasks - Task configuration and management
- Horizon Queue Manager - Queue system for task processing
Developer Tools
Section titled “Developer Tools”API access and developer resources for integrations and automation.
REST API
Section titled “REST API”Purpose: Configuration and management of REST API access including authentication tokens, rate limiting, and endpoint documentation.
Key Functions:
- Generate API authentication tokens
- Configure API rate limits
- View API endpoint documentation
- Test API endpoints
- Monitor API usage and statistics
- Revoke compromised tokens
When to Use: When integrating rConfig with external systems, automating operations via API, or developing custom applications leveraging rConfig functionality.
Related Documentation: REST API - Authentication, endpoints, and usage
Developers
Section titled “Developers”Purpose: Developer resources, tools, and utilities for extending rConfig or building integrations.
Key Resources:
- API schema documentation
- Webhook configuration
- Custom integration examples
- Developer SDK and libraries
- Code samples and tutorials
When to Use: When building custom integrations, developing automation scripts, or extending rConfig functionality for specific organizational requirements.
Related Documentation: rConfig V8 Developer Notice & Best Practices - Security responsibilities and extension guidelines
System information and version details.
Purpose: System information display including version, license status, system health, and credits.
Information Displayed:
- rConfig version and build information
- License status and expiration
- System health metrics (uptime, resource usage)
- Installed modules and features
- Credits and open source licenses
- Support contact information
When to Use: When verifying system version for support requests, checking license status, reviewing system health at a glance, or accessing support contact information.
Related Documentation: No separate guide needed; the About panel is self-explanatory system information.
Settings Navigation Tips
Section titled “Settings Navigation Tips”Accessing System Settings
Section titled “Accessing System Settings”- Log in to rConfig with an account having Admin role
- Navigate to Settings from the main navigation menu (typically gear icon)
- Settings sections are organized by category in the left sidebar
- Click any section to view and modify its configuration
Search Functionality
Section titled “Search Functionality”Many System Settings sections include search functionality:
- Use search fields to quickly locate specific settings
- Search operates on setting names, descriptions, and values
- Filters narrow results by category or status
Configuration Best Practices
Section titled “Configuration Best Practices”Document changes: Before modifying settings, document current values and business justification for changes. This aids troubleshooting and audit compliance.
Test in non-production: When possible, test setting changes in development or staging environments before applying to production systems.
One change at a time: Modify one setting at a time to clearly identify impact of each change. Multiple simultaneous changes complicate troubleshooting.
Review after updates: After rConfig version updates, review System Settings to identify new options or deprecated settings requiring attention.
Backup before major changes: Create system backup before making significant configuration changes enabling rapid rollback if issues arise.
Common Settings Workflows
Section titled “Common Settings Workflows”Initial deployment configuration:
- System → Configure application name, timezone, defaults
- Security → Establish password policies, session timeouts
- Backup Settings → Configure automated backups
- LDAP Setup → Integrate with directory services (if applicable)
- Logging & Debugging → Set appropriate log levels
Regular maintenance review (quarterly):
- Security → Review and rotate credentials
- Backup Settings → Verify backups executing successfully
- Data Purge → Execute retention policy enforcement
- System Optimization → Review performance metrics and adjust
- About → Check for available updates
Troubleshooting workflow:
- Application Logs → Review recent errors and warnings
- Logging & Debugging → Temporarily increase log verbosity
- Scheduled Tasks → Check task execution history
- Help & Support → Access documentation and support resources
Related Documentation
Section titled “Related Documentation”- User Management - Managing user accounts and roles
- Roles and Permissions - Role-based access control
- System Monitoring - External monitoring best practices
- High Availability Options - HA deployment strategies
- Docker Deployments - Containerization considerations
Summary
Section titled “Summary”The System Settings interface provides centralized access to all rConfig V8 configuration, security, maintenance, and administrative functions. This reference guide maps settings sections to their purposes and detailed documentation, enabling efficient navigation and consistent administrative practices.
Key takeaways for effective settings management:
- Settings are organized by functional area - System Management, Security & Access, Data Management, Monitoring & Debugging, Developer Tools
- Many sections have dedicated documentation - Follow links to comprehensive guides for detailed implementation procedures
- Changes require Admin role - Most System Settings sections are restricted to users with administrator privileges
- Document configuration changes - Maintain records of what changed, why, and when for troubleshooting and compliance
- Test before production - Validate setting changes in non-production environments when possible
Regular review of System Settings ensures configuration remains aligned with organizational standards, security requirements, and operational needs as deployments evolve and scale. Use this reference as a navigation tool for locating specific configuration areas and accessing detailed implementation documentation.