NethServer 8 Administrator Manual

website·Indexed 34 days ago

https://docs.nethserver.org

Documentation for NethServer 8 (NS8), an application server and cluster management platform. Includes guides on installation, system requirements, and the configuration of core services like TLS certificates, firewall, and backup. It also details the deployment of integrated applications and modules such as Nextcloud, Mattermost, Samba file server, Roundcube, and NethVoice.

Tokens
44.8K
Snippets
97
Records
344
Agent score
68%

What's inside NethServer

  1. Overview of NethVoice communication system

    NethVoice is a comprehensive communication system integrating voice, video, and mobile capabilities. It is composed of two primary applications:

    1. NethVoice Proxy: Responsible for managing SIP (Session Initiation Protocol) and RTP (Real-time Transport Protocol) connections.
    2. NethVoice: Provides the core VoIP telephony services.

    Detailed technical documentation is maintained at https://docs.nethvoice.com/.

  2. Overview of the Lamp containerized environment

    Lamp is a containerized environment providing a full LAMP stack: Linux (Ubuntu), Apache (web server), MariaDB (database), and PHP (scripting language). It is designed for the deployment and management of web applications with isolation and portability.
  3. Overview of RustFS on NS8

    RustFS provides high-performance, S3-compatible object storage. The NS8 application provides a basic single-node/single-disk installation suitable for small environments. Multiple RustFS instances can be installed on the same node via the NS8 Software Center.
  4. Overview of NethServer 8 (NS8)

    NethServer 8 (NS8) is a container orchestrator designed for Linux system administrators who want the flexibility of containers without the complexity of tools like Kubernetes. It provides a web-based user interface to manage applications and hide system complexity. Unlike NethServer 7, which was a CentOS 7-based OS using RPMs and e-smith, NS8 can run on multiple supported Linux distributions, utilizes containers for application installation, and employs a multi-node architecture for scaling workloads across multiple machines via encrypted VPN.
  5. Overview of TLS certificate management in NethServer 8

    In NethServer 8, applications do not handle TLS directly. Instead, each cluster node runs a Traefik HTTP proxy that terminates TLS connections and presents the appropriate certificate based on the HTTP 'Host' header. Certificates are node-specific and are not shared across the cluster. Upon installation, Traefik generates a default self-signed certificate for local applications and the cluster web interface.
  6. Overview of the NethServer monitoring stack

    NethServer automatically installs a monitoring stack on the leader node. All nodes in the cluster run Node Exporter to provide metrics endpoints. The leader node manages the following components:

    • Prometheus: Scrapes node_exporter metrics and stores them locally.
    • Alertmanager: Sends alerts to configured receivers.
    • Grafana: Visualizes collected metrics (disabled by default).

    The stack automatically reconfigures when nodes are added or removed. If a leader node switch occurs, the monitoring stack is migrated to the new leader, but existing metrics and alerts are not preserved.

  7. Overview of Imapsync on NethServer 8

    Imapsync is an IMAP transfer tool used to copy and move emails between IMAP servers. In NethServer 8, it is primarily used to transfer emails from remote IMAP servers to a local Mail application instance for two main purposes: IMAP account migration (recursive and incremental import of accounts) and periodic INBOX retrieval.
  8. Overview of NethSecurity Controller centralized management

    The NethSecurity Controller provides remote management for multiple NethSecurity installations, known as 'units'. It establishes secure communication between a central server and these units using the ns-plug client for registration, which then generates an OpenVPN configuration for secure connectivity.

    Key capabilities include:

    • Centralized Configuration: Manage and configure multiple firewalls via a single user interface.
    • Monitoring & Logging: Log collection and analysis via Loki; metrics visualization via Prometheus, TimescaleDB, and built-in Grafana dashboards.
    • Remote Access: Web-based SSH access to the command-line interface of the managed firewalls.
  9. Overview of NethServer HTTP routing

    NethServer uses Traefik as an HTTP proxy on each cluster node to route traffic from ports 80 (HTTP) and 443 (HTTPS) to applications or custom network destinations. Routes are defined by match rules based on the HTTP host name and/or request path.

    There are two types of routes:

    • Automatic: Created and managed by installed applications. These cannot be modified except for their IP allowlists.
    • Custom: Created by the administrator to point to any reachable destination URL (local or remote).
  10. NethServer 8 Core Capabilities and Modules

    NethServer 8 provides a suite of core system management features and optional application modules:

    Core Capabilities:

    • Node Management: Add and remove nodes from the system.
    • Centralized Logging: Unified log collection for monitoring.
    • Backups: Configuration and data backups to remote providers (e.g., Amazon S3, Backblaze B2).
    • Authentication: Support for Active Directory and LDAP (RFC2307).
    • File Services: SMB file server for Windows network integration.
    • Security & Auditing: System change tracking, multi-factor authentication (MFA) for admins, and a built-in local firewall.
    • Networking: Email relay via smart host and custom web routing for specific URLs.
    • Migration: A dedicated Cockpit module for importing NethServer 7 applications.

    Additional Modules:

    • Collaborative Tools: Dovecot, Postfix, Rspamd, WebTop, Roundcubemail, Nextcloud, Collabora Online, Dokuwiki, ejabberd, and Mattermost.
    • Development: MariaDB and NGINX web server.
    • Monitoring: Grafana, Prometheus, and node_exporter.
    • Data Storage: MinIO for structured and unstructured data.
    • Network Defense: CrowdSec for protecting local applications.