Legacy documentation: this developer manual is kept for reference only.

Developer Manual

See also

• Web site
• Community
• Wiki
• Administrator manual

Rules and conventions

• Introduction
  • Target audience
  • Get involved
• Development process
  • Issues
  • Pull requests
  • RPM Version numbering rules
  • Commit message style guide
  • Documentation
  • New packages
  • Package updates
  • ISO releases
• RPM package rules
  • Naming and events conventions
  • Install/Update process
  • Uninstall process
  • Service packages
• Internationalization
  • Server Manager (Cockpit)
  • Server Manager (Nethgui)

Architecture

• Databases
  • Overview
  • Simple entries
  • Complex entries
  • Access from the command line
  • Access via the Perl API
  • Database initialization
  • Evaluation order
  • Best practices
  • List of available database
• Templates
  • Design of the template system
  • The Text::Template module
  • Template expansion
  • Template permissions and ownership: templates.metadata
  • Template deletion: templates.metadata
  • Perl API: processTemplate
• Actions and events
  • Actions
  • Events
• Services
  • Control a service
  • Access network service
  • Add a new service
  • Add a new network service

Implementation

• Auto-generated random URL
• Migration from NethService/SME Server
  • Coding conventions
  • Packages
• Certificate Management
  • Default behavior
  • Let’s Encrypt
• Yum plugin
  • Caching

Web interface

• Web interface
  • Nethgui framework
• Creating web UI module
  • Web UI structure
  • Writing the code
  • More examples
• Dashboard
  • SystemStatus tab
  • Services tab
  • Applications tab
  • Extending the dashboard
• Creating inline help pages
  • Editing rules
  • Creating help for plugin modules
  • Building docs inside RPMS
  • RST editors
• TODO API
  • Translations

Packages

• Building RPMs
  • Development vs Release builds
  • Publishing RPMs
• Building ISO
• Package groups
  • Submit a change proposal
  • How to edit .xml.in files

Modules

• nethserver-antivirus
  • Disable official signatures
  • Select signature rating
  • Cockpit API
• nethserver-avahi
• nethserver-backup-config
  • Configuration backup
• nethserver-backup-data
  • Configuration
  • Backward compatibility
  • Backup
  • Disk usage
  • Indexing
  • Customization
  • Retention policy
  • Restore
  • List backup contents
  • Duplicity
  • Restic
  • rsync
• nethserver-base
  • Network
  • Log retention and rotation
  • Transport Layer Security
  • Repositories
  • Notifications
  • Let’s Encrypt certificates
  • DNS challenge
• nethserver-blacklist
  • IP blacklist
  • DNS blacklist
  • GEOIP blacklist
• nethserver-cgp
• nethserver-cockpit
• nethserver-collectd
  • Ping plugin
  • Web interface
  • Cleanup
  • Interesting plugins
  • Database
• nethserver-cups
  • Configuration
  • Printer discovery
  • Configuration DB
• nethserver-dc
  • nethserver-dc-save event
  • Running commands in nsdc
  • Manual Join
  • Factory reset
  • Uninstall nethserver-dc
  • Upgrade the container
  • Changing the IP address of DC
  • Alternate UPN suffix
  • Enable check password script
  • ns-samba binary build
• nethserver-directory
  • Schema and base DN
  • User account states
  • Logging
  • Service accounts
  • User accounts
  • Anonymous access
  • Administrative access
  • Inspect OpenLDAP ACLs
  • Upgrade to Active Directory
• nethserver-dnsmasq
  • DNS
  • DHCP
  • IP reservation
  • TFTP server
• nethserver-duc
  • Overview
  • Configuration
• nethserver-ejabberd
  • Configuration
• nethserver-evebox
  • Links
• nethserver-firewall-base
  • Roles and zones
  • General configuration
  • Events
  • Policy
  • IP/MAC binding
  • Rules
  • Firewall objects
  • Port forwarding
  • Source NAT (sNAT)
  • Traffic shaping
  • Multi WAN
  • Static routes
• nethserver-firewall-migration
  • Migrate to another machine
  • In-place migration
  • Not migrated
• nethserver-freepbx
  • FreePBX Web UI Access
  • Backup
  • Open services from external networks
  • Users
  • WebRTC
  • Cockpit API
• nethserver-hotsync
  • What is it ?
  • Requirements
  • How it works
  • Installation
  • Configuration
  • How to restore
  • How to restore original server
  • How to synchronize custom paths
  • How to force synchronization from MASTER to SLAVE
  • How to force packages installation on SLAVE
  • Components
  • Supported packages
• nethserver-httpd
  • Templates
  • Web applications
  • configuration database
  • vhost database
  • proxypass database
  • rh PHP software collection
  • Events
  • NethServer 6 upgrade
  • UI plugins
  • Welcome page
• nethserver-httpd-admin
  • smwingsd daemon
  • Customization
  • Database example
  • Session timeouts
• nethserver-hylafax
  • Modem configuration
  • Accounting (FaxAccounting)
  • Incoming fax (FaxDispatch)
  • Outgoing fax (FaxNotify)
  • Custom scripts
  • Authentication
  • Internationalization
  • Client configuration
  • Configuration DB
• nethserver-iaxmodem
  • Multiple IAX modems
• nethserver-ipsec-tunnels
  • Logs
• nethserver-janus
  • Start Janus Gateway at boot
  • NAT modes
  • STUN and ICE enforced interfaces
  • Disable plugins
  • Debug problems with Admin Api
• nethserver-lang
  • Building a release RPM
  • Building RPMs for testing
  • Adding new resources
• nethserver-lightsquid
  • Database
• nethserver-mail
  • nethserver-mail-common
  • nethserver-mail-smarthost
  • nethserver-mail-disclaimer
  • nethserver-mail-filter
  • nethserver-mail-server
  • nethserver-mail-ipaccess
  • nethserver-mail-getmail
  • nethserver-mail-p3scan
  • mail-quarantine
  • Database format
  • Mail quota
  • Disabled users
  • Testing Dovecot with Mutt
  • Set special ACL on mailboxes
  • IP-based IMAP access restriction
  • Enable dovecot IMAP rawlog
  • Access the rspamd UI
  • Bayesian rules upgrade to rspamd
  • Sender address validation
  • Postfix SMTP listening ports
  • Dynamic group aliases
• nethserver-makerpms
  • Installation/upgrade
  • Build requirements
  • Building RPMs locally
  • Other commands
  • Building RPMs on github.com
• nethserver-mattermost
  • First configuration
  • Database
  • Account synchronization
  • Log files
  • Cockpit API
• nethserver-mock
  • Configuring the environment
  • Running the scripts
  • Development and Release builds
  • Signing RPMs
  • Running on EL8
• nethserver-mysql
  • Loading data
• nethserver-net-snmp
  • Database
• nethserver-netdata
  • Configuration DB
  • Access from LAN
  • Links
• nethserver-nextcloud
  • Admin user
  • Customize virtual host
  • Backup
  • OCC
  • Log of php80-fpm
  • Cockpit API
  • Full reinstall
• nethserver-ns8-migration
  • Commands
  • Applications
  • Migration APIs
  • Package uninstallation
  • Post-migration step back
  • Migration notes
• nethserver-ntopng
  • Database Reference
  • Download lates upstream release
  • Links
• nethserver-ntp
  • How it works
• nethserver-nut
  • Configuration
  • Master node
  • Slave node
  • Collectd-nut
• nethserver-openssh
  • Properties
  • Events
  • One time password (2FA)
• nethserver-openvpn
  • Events
  • Roadwarrior accounts
  • Roadwarrior server
  • Tunnel topology
  • Tunnel clients
  • Tunnel servers
  • Templates
  • Log files and systemd instances
• nethserver-phonenehome
  • Overview
  • Configuration
• nethserver-postgres
  • Access policy
  • Backup
• nethserver-pulledpork
• nethserver-release
  • Building a release RPM
• nethserver-rh-php56-php-fpm
  • Adding new configuration
• nethserver-rh-php71-php-fpm
  • Adding new configuration
• nethserver-roundcubemail
  • Database
• nethserver-samba
  • Configuration database
  • Accounts database
  • Shared folder profile
• nethserver-samba-audit
  • Configuration
• nethserver-smartd
• nethserver-squid
  • Configuration
  • Transparent mode
  • Authenticated mode
  • Bypasses
  • Cache
  • Priority and divert rules
  • WPAD
  • Miscellaneous options
• nethserver-squidguard
  • Inner workings
  • Known limitations
  • Blacklists
  • Databases
  • Block page
  • Troubleshooting
• nethserver-sssd
  • Configuration DB format
  • Realm and workgroup
  • Events
  • System users and groups
  • AD LDAP search
  • NethServer::SSSD
  • Join Active Directory
  • Leave and Re-Join Active Directory
  • Change the FQDN
  • Account import scripts
  • Password policy
• nethserver-subscription
  • Database
  • Configuration
  • YUM repositories
  • Events
  • Alerts
  • Inventory
• nethserver-suricata
  • Manually enable/disable Suricata
  • Bypass
  • Custom rules
  • Troubleshooting
• nethserver-unbonund
  • Database
• nethserver-unixODBC
  • /etc/odbc.ini
  • /etc/odbcinst.ini
  • Usage
• nethserver-vsftpd
  • Virtual users
  • System users
• nethserver-webtop4
  • Database
  • Troubleshooting
  • Known problems
• nethserver-webtop5
  • Database
  • Reset admin password
  • Troubleshooting
  • Tomcat instance

Appendix

• License Headers
  • PHP, Javascript, CSS
  • Perl, Python and BASH
• Rebranding Administrator Manual
  • Environment
  • Contents
  • Product name and version
  • Theme
  • Artworks
• License

Indices and tables

• Index
• Search Page