Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 18 additions & 31 deletions docs/administrator-manual/advanced/nethvoice_proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,54 +69,51 @@ In this scenario:

## Installation {#installation}

### Recommended Installation {#installation-steps}

NethVoice proxy is installed as part of the NethVoice module setup wizard. See [NethVoice Installation](../install/nethvoice_install.md) for the complete installation sequence.

### Manual Installation (not recommended)

:::note
You can install only one NethVoice Proxy per node from the Software Center.
:::

NethVoice Proxy must be installed **before** deploying any NethVoice instances. See [NethVoice Installation](../install/nethvoice_install.md) for the complete installation sequence.

### Installation Steps {#installation-steps}
NethVoice Proxy must be installed **before** deploying any NethVoice instances.

1. **Open NethServer Management Interface** on your node
1. **Open NethServer Management Interface**
2. **Navigate to Software Center**
3. **Search for "NethVoice Proxy"**
4. **Click "Install"** and wait for installation to complete
5. **Proceed to Configuration** (see section below)

:::warning Installation Order
Do not attempt to install NethVoice before installing and configuring NethVoice Proxy. The installation will fail if the proxy is not available.
5. **Proceed to configuration** (see section below)

## Configuration {#configuration}

Configuration of NethVoice Proxy is essential before installing NethVoice instances. The proxy requires a dedicated FQDN and proper network settings.

:::warning Configuration Required
NethVoice Proxy must be fully configured and operational before installing NethVoice instances. Verify configuration is complete and proxy is running before proceeding to NethVoice installation.
:::

### Prerequisites {#prerequisites}

Before configuring NethVoice Proxy, ensure:

1. **DNS Records Created**: Create a DNS A/AAAA record for the proxy domain (e.g., `proxy.nethserver.org`) pointing to your public IP address
2. **Public IP Address**: Know the public IPv4 or IPv6 address where the proxy will be accessible from the internet
2. **Public IP Address**: Identify the public IPv4 or IPv6 address where the proxy will be accessible from the internet
3. **Network Interface**: Identify which network interface will handle VoIP traffic

### Configuration Steps {#configuration-steps}

NethVoice Proxy is usually configured during the setup wizard of a NethVoice module (see [NethVoice Installation](../install/nethvoice_install.md) for the complete installation sequence). To review or modify the proxy configuration:

1. **Access the proxy configuration page** in the NethServer management interface
2. **Enter the Proxy Domain**: Set a valid FQDN (e.g., `proxy.nethserver.org`)
- This domain must have a valid DNS A/AAAA record pointing to your public IP
- External VoIP devices and remote offices will use this domain to reach your system
3. **Select Network Interface**: Choose the network interface that will handle VoIP traffic from the dropdown menu
- Typically the interface connected to your WAN/Internet
4. **Configure Public IP Address**:
3. **Request SSL Certificate**:
- Enable Let's Encrypt to automatically manage SSL certificates for the proxy domain
- This requires the DNS record to be publicly resolvable
4. **Select Network Interface**: Choose the network interface that will handle VoIP traffic from the dropdown menu
- This is typically the interface connected to your WAN/Internet
5. **Configure Public IP Address**:
- Enter the public IPv4 or IPv6 address if different from the interface IP
- This is necessary if your node is behind a router/NAT
- Leave blank if the interface has a direct public IP address
5. **Request SSL Certificate**:
- Enable Let's Encrypt if you want automatic SSL certificate management
- Requires the DNS record to be publicly resolvable

### Configuration Example {#configuration-example}

Expand Down Expand Up @@ -154,14 +151,6 @@ If your node has multiple public IP addresses, configure the proxy with the spec
2. Enter the specific public IP in the "Public IP Address" field
3. Ensure DNS records point to this IP address

### Next Steps {#next-steps}

Once NethVoice Proxy is fully configured and running:

1. **Verify proxy is operational**: Check the proxy status in the NethServer management interface
2. **Proceed to install NethVoice**: See [NethVoice Installation](../install/nethvoice_install.md)
3. **Configure NethVoice instances**: Each instance requires separate configuration with dedicated FQDNs

:::info Network Diagram
```
External Users/Trunks
Expand All @@ -177,5 +166,3 @@ External Users/Trunks

The proxy acts as a gateway between external VoIP traffic and internal NethVoice instances.
:::

Now, you can install and configure one or more NethVoice instances. See [NethVoice Installation](../install/nethvoice_install.md) for detailed steps.
1 change: 1 addition & 0 deletions docs/administrator-manual/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The Configuration section contains documentation for managing and monitoring you
- **[Wizard](./configuration/wizard)** - Access the configuration wizard for system setup and customization
- **[Dashboard](./configuration/dashboard)** - Monitor system status, users, and presence information
- **[Applications](./configuration/applications/)** - Configure additional NethVoice applications and integrations
- **[NethServer 8 module](../install/nethvoice_install.md#module-configuration)** - Configure the NethVoice module

:::info Getting Started
For the initial NethVoice setup, start with the [configuration wizard](./configuration/wizard).
Expand Down
12 changes: 4 additions & 8 deletions docs/administrator-manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This documentation covers the complete installation, configuration, and manageme
Get started quickly by jumping to the most important sections:

- **[Installation Guide](./install/index.md)** - Complete setup instructions from NethServer prerequisites to NethVoice deployment
- **[Configuration](./configuration/index.md)** - CTI, extensions, and user administration
- **[Configuration](./configuration/index.md)** - NethVoice management after the initial setup.
- **[Phone Provisioning](./provisioning/index.md)** - Automated phone device management and provisioning
- **[Advanced Resources](./advanced/index.md)** - System configuration and advanced topics

Expand Down Expand Up @@ -91,20 +91,16 @@ Before deploying NethVoice, ensure you have:
- ✅ **System Resources**: Minimum 2 vCPU, 2GB RAM, 40GB storage per instance
- ✅ **Network Requirements**: Static IP, DNS configured, internet connectivity
- ✅ **NethServer 8**: Fully installed and configured (see [Installation Guide](./install/index.md))
- ✅ **User Domain**: Created for users and authentication (see [User Domains in NethServer Installation](./install/nethserver.md#user-domains))
- ✅ **NethVoice Proxy**: Installed and configured with proper FQDN and DNS records (required for any NethVoice deployment)

### Deployment Steps {#deployment-steps}

1. **[Review System Requirements](./install/nethserver.md#system-requirements)** - Ensure your infrastructure meets requirements
2. **[Install NethServer 8](./install/nethserver.md)** - Deploy the base infrastructure platform
3. **[Create User Domain](./install/nethserver.md#user-domains)** - Set up LDAP for users and authentication
4. **[Install & Configure NethVoice Proxy](./advanced/nethvoice_proxy.md)** - Deploy the external VoIP gateway (REQUIRED before NethVoice)
5. **[Deploy NethVoice](./install/nethvoice_install.md)** - Install NethVoice module(s) on top of the proxy
6. **Configure Your System**:
3. **[Install & Configure NethVoice](./install/nethvoice_install.md)** - Install NethVoice Proxy and NethVoice modules
4. **Configure Your System**:
- [Provision Phones](./provisioning/index.md) - Deploy and configure telephone devices
- [Manage Extensions](../user-manual/nethcti/index.md) - Create extensions and assign to users
7. **[Advanced Configuration](./advanced/index.md)** - Configure trunks, gateways, routing, and advanced features
5. **[Advanced Configuration](./advanced/index.md)** - Configure trunks, gateways, routing, and advanced features

## Key Documentation Sections {#key-documentation-sections}

Expand Down
99 changes: 24 additions & 75 deletions docs/administrator-manual/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,10 @@ This section covers the complete installation process for NethVoice, from settin

## Overview {#overview}

NethVoice installation is a multi-step process:
NethVoice installation is a two-step process:

1. **[NethServer 8 Installation](nethserver.md)** - Install the NethServer 8 base platform
2. **[Create User Domain](nethserver.md#user-domains)** - Set up LDAP for users and authentication (in NethServer)
3. **[NethVoice Proxy Installation & Configuration](../advanced/nethvoice_proxy.md)** - Install and configure the external VoIP gateway (REQUIRED first)
4. **[NethVoice Installation](nethvoice_install.md)** - Install NethVoice on top of configured proxy
5. **[Module Configuration](nethvoice_install.md#module-configuration)** - Configure NethVoice with your requirements

:::warning Installation Order
1. NethServer 8 must be installed first
2. User Domain must be created second (required by NethVoice)
3. NethVoice Proxy must be installed and configured third
4. NethVoice can only be installed after proxy is ready
5. NethVoice configuration uses the user domain created in step 2

See [NethVoice Proxy Installation](../advanced/nethvoice_proxy.md) for details on proxy requirements.
:::
2. **[NethVoice Installation](nethvoice_install.md)** - Install and configure NethVoice application

## What is NethServer 8? {#what-is-nethserver-8}

Expand Down Expand Up @@ -62,47 +49,19 @@ Follow the [NethServer Installation guide](nethserver.md) to:
- Access the web administration interface
- Create your cluster

### Step 3: Create User Domain {#step-3-create-user-domain}

Create a user domain for NethVoice users and extensions:
- Access NethServer 8 web interface → Domains and users
- Create domain (OpenLDAP recommended for NethVoice)
- Set admin credentials
- Note LDAP bind settings (needed for NethVoice configuration)

See [User Domains setup](nethserver.md#user-domains) in the NethServer Installation guide for details.

### Step 4: Install NethVoice Proxy {#step-4-install-nethvoice-proxy}

After NethServer 8 and user domain are ready, install and configure the VoIP proxy:
- Access the Software Center
- Install NethVoice Proxy
- Configure proxy domain (FQDN)
- Set network interface and public IP
- Verify proxy is running

See [NethVoice Proxy Installation Guide](../advanced/nethvoice_proxy.md) for detailed steps.

### Step 5: Install NethVoice {#step-5-install-nethvoice}

With NethVoice Proxy configured and running:
- Access the Software Center
- Install NethVoice
- Complete the NethVoice configuration wizard
- Select the user domain created in Step 3
- Set up virtual hosts and certificates

### Step 6: Configure NethVoice {#step-6-configure-nethvoice}
### Step 3: Install and configure NethVoice {#step-3-install-nethvoice}

Follow the [NethVoice Installation guide](nethvoice_install.md) to:
- Configure NethVoice virtual hosts
- Verify user domain is selected
- Configure Let's Encrypt certificates
- Access NethVoice administration and CTI
- Install NethVoice
- Complete the setup configuration wizard:
- Configure an account provider
- Install and configure a NethVoice Proxy
- Set up virtual hosts, certificates and administration password
- Access NethVoice administration interface and CTI

## Quick Reference {#quick-reference}

### System Requirements (Minimum) {#system-requirements-minimum}
### Minimum System Requirements {#system-requirements-minimum}

| Component | Requirement |
|-----------|-------------|
Expand Down Expand Up @@ -149,6 +108,19 @@ Complete guide covering:
- Cluster configuration
- Troubleshooting

### [NethVoice Installation](nethvoice_install.md) {#nethvoice-installation}

Complete guide covering:
- NethVoice software installation
- Setup wizard:
- User domain
- NethVoice Proxy
- Virtual hosts (base hosts)
- Let's Encrypt certificates
- Administration password
- Administrator access
- Initial configuration

### [NethVoice Proxy Installation](../advanced/nethvoice_proxy.md) {#nethvoice-proxy-installation}

Complete guide covering:
Expand All @@ -158,19 +130,7 @@ Complete guide covering:
- Configuration (domain, interface, public IP)
- SSL certificate setup
- Verification and testing
- Must be installed BEFORE NethVoice

### [NethVoice Installation](nethvoice_install.md) {#nethvoice-installation}

Complete guide covering:
- Installation order (Proxy → NethVoice)
- NethVoice software installation
- Module configuration
- Virtual host setup
- User domain configuration
- Let's Encrypt certificate configuration
- Administrator access
- Initial configuration
- Must be installed before NethVoice

## Installation Checklist {#installation-checklist}

Expand All @@ -185,17 +145,6 @@ Before you begin, ensure:
- [ ] Internet connection is stable
- [ ] You have administrative access to the server

During installation, ensure you complete:

- [ ] NethServer 8 installation
- [ ] User Domain creation (OpenLDAP recommended)
- [ ] Note down LDAP bind settings
- [ ] NethVoice Proxy installation
- [ ] NethVoice Proxy configuration
- [ ] Verify proxy is running before NethVoice install
- [ ] NethVoice installation
- [ ] NethVoice configuration with user domain

## Important Notes {#important-notes}

:::info
Expand Down
59 changes: 3 additions & 56 deletions docs/administrator-manual/install/nethserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,66 +137,13 @@ After installation completes:
- Password: `Nethesis,1234`

Follow the wizard to create a cluster and configure the node.
More info available in the [official NethServerdocumentation](https://docs.nethserver.org/projects/ns8/en/latest/install.html#post-installation-steps).
More info available in the [official NethServer documentation](https://docs.nethserver.org/projects/ns8/en/latest/install.html#post-installation-steps).


After cluster setup, you can:

1. **Install User Domain**: [Set up LDAP or Active Directory](#user-domains)
2. **Install NethVoice**: Proceed with [NethVoice installation](nethvoice_install) via the Software Center
3. **Register NethServer**: Activate your [Enterprise subscription](#register-nethserver)


## User Domains {#user-domains}

User domains store users and groups in an LDAP database. NethVoice requires at least one user domain to manage extensions, users, and authentication.

### Overview {#overview}

NethServer 8 supports two types of LDAP account providers:

| Provider | Type | Best For | Features |
|----------|------|----------|----------|
| **OpenLDAP (RFC2307)** | Internal | Unix/Linux clients, simple setup | Lightweight, easy configuration, smaller deployments, multiple instances per node |
| **Active Directory (Samba)** | Internal | Windows clients, SMB file sharing | Domain controller, Windows compatibility, higher complexity, one instance per node |
| **External LDAP** | External | Existing LDAP infrastructure | Connect to existing servers (Active Directory, OpenLDAP, etc.) |


:::info NethVoice Requirement
NethVoice requires at least one configured user domain. Choose **OpenLDAP (RFC2307)** for simpler deployments or **Active Directory** if you need Windows client support.
:::

### Quick Setup: OpenLDAP (Recommended for NethVoice) {#quick-setup-openldap-recommended-for-nethvoice}

OpenLDAP is the simplest option for NethVoice-only deployments:

1. **Access the NethServer 8 web interface** after installation completes
2. **Navigate to Domains and users** section
3. **Click "Create domain"** and choose **"Internal"**
4. **Select "OpenLDAP"** as the provider
5. **Enter domain name** (e.g., `nethvoice.local`) - this is a logical name, not DNS-related
6. **Set OpenLDAP admin username and password**
7. **Click "Install provider"**

The domain will be ready immediately. You can now:
- Create users and groups for NethVoice extensions
- Manage user authentication
- Configure NethVoice to use this domain

:::tip
Keep the OpenLDAP admin credentials in a secure location. You'll need them for administrative tasks.
:::


For advanced scenarios (external LDAP, Active Directory, DNS setup, password policies, user management), see the [official NethServer 8 User Domains documentation](https://docs.nethserver.org/projects/ns8/en/latest/user_domains.htm).

Key topics in the official docs:
- **Active Directory Setup**: Complete domain controller configuration
- **External LDAP Connection**: Binding to existing LDAP servers
- **Password Policies**: Age, strength, and expiration settings
- **User Management Portal**: Self-service password changes
- **LDAP Provider Replicas**: Fault tolerance and redundancy
- **LDAP binding settings**: Connect external application to a local-running LDAP server
1. **Install NethVoice**: Proceed with [NethVoice installation](nethvoice_install) via the Software Center
2. **Register NethServer**: Activate your [Enterprise subscription](#register-nethserver)

## Register NethServer {#register-nethserver}

Expand Down
Loading