Skip to content

Commit 1304d97

Browse files
andre8244actions-userCopilotgsanchietti
authored
fix(admin_manual): ns8 wizard and settings refactored (#33)
--------- Co-authored-by: Translation Sync Bot <action@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Giacomo Sanchietti <giacomo.sanchietti@nethesis.it>
1 parent a84ea33 commit 1304d97

File tree

16 files changed

+402
-594
lines changed

16 files changed

+402
-594
lines changed

docs/administrator-manual/advanced/nethvoice_proxy.md

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -69,54 +69,51 @@ In this scenario:
6969

7070
## Installation {#installation}
7171

72+
### Recommended Installation {#installation-steps}
73+
74+
NethVoice proxy is installed as part of the NethVoice module setup wizard. See [NethVoice Installation](../install/nethvoice_install.md) for the complete installation sequence.
75+
76+
### Manual Installation (not recommended)
77+
7278
:::note
7379
You can install only one NethVoice Proxy per node from the Software Center.
7480
:::
7581

76-
NethVoice Proxy must be installed **before** deploying any NethVoice instances. See [NethVoice Installation](../install/nethvoice_install.md) for the complete installation sequence.
77-
78-
### Installation Steps {#installation-steps}
82+
NethVoice Proxy must be installed **before** deploying any NethVoice instances.
7983

80-
1. **Open NethServer Management Interface** on your node
84+
1. **Open NethServer Management Interface**
8185
2. **Navigate to Software Center**
8286
3. **Search for "NethVoice Proxy"**
8387
4. **Click "Install"** and wait for installation to complete
84-
5. **Proceed to Configuration** (see section below)
85-
86-
:::warning Installation Order
87-
Do not attempt to install NethVoice before installing and configuring NethVoice Proxy. The installation will fail if the proxy is not available.
88+
5. **Proceed to configuration** (see section below)
8889

8990
## Configuration {#configuration}
9091

91-
Configuration of NethVoice Proxy is essential before installing NethVoice instances. The proxy requires a dedicated FQDN and proper network settings.
92-
93-
:::warning Configuration Required
94-
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.
95-
:::
96-
9792
### Prerequisites {#prerequisites}
9893

9994
Before configuring NethVoice Proxy, ensure:
10095

10196
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
102-
2. **Public IP Address**: Know the public IPv4 or IPv6 address where the proxy will be accessible from the internet
97+
2. **Public IP Address**: Identify the public IPv4 or IPv6 address where the proxy will be accessible from the internet
10398
3. **Network Interface**: Identify which network interface will handle VoIP traffic
10499

105100
### Configuration Steps {#configuration-steps}
106101

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

121118
### Configuration Example {#configuration-example}
122119

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

157-
### Next Steps {#next-steps}
158-
159-
Once NethVoice Proxy is fully configured and running:
160-
161-
1. **Verify proxy is operational**: Check the proxy status in the NethServer management interface
162-
2. **Proceed to install NethVoice**: See [NethVoice Installation](../install/nethvoice_install.md)
163-
3. **Configure NethVoice instances**: Each instance requires separate configuration with dedicated FQDNs
164-
165154
:::info Network Diagram
166155
```
167156
External Users/Trunks
@@ -177,5 +166,3 @@ External Users/Trunks
177166

178167
The proxy acts as a gateway between external VoIP traffic and internal NethVoice instances.
179168
:::
180-
181-
Now, you can install and configure one or more NethVoice instances. See [NethVoice Installation](../install/nethvoice_install.md) for detailed steps.

docs/administrator-manual/configuration/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The Configuration section contains documentation for managing and monitoring you
1212
- **[Wizard](./configuration/wizard)** - Access the configuration wizard for system setup and customization
1313
- **[Dashboard](./configuration/dashboard)** - Monitor system status, users, and presence information
1414
- **[Applications](./configuration/applications/)** - Configure additional NethVoice applications and integrations
15+
- **[NethServer 8 module](../install/nethvoice_install.md#module-configuration)** - Configure the NethVoice module
1516

1617
:::info Getting Started
1718
For the initial NethVoice setup, start with the [configuration wizard](./configuration/wizard).

docs/administrator-manual/index.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This documentation covers the complete installation, configuration, and manageme
2020
Get started quickly by jumping to the most important sections:
2121

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

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

9795
### Deployment Steps {#deployment-steps}
9896

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

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

docs/administrator-manual/install/index.md

Lines changed: 24 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,10 @@ This section covers the complete installation process for NethVoice, from settin
99

1010
## Overview {#overview}
1111

12-
NethVoice installation is a multi-step process:
12+
NethVoice installation is a two-step process:
1313

1414
1. **[NethServer 8 Installation](nethserver.md)** - Install the NethServer 8 base platform
15-
2. **[Create User Domain](nethserver.md#user-domains)** - Set up LDAP for users and authentication (in NethServer)
16-
3. **[NethVoice Proxy Installation & Configuration](../advanced/nethvoice_proxy.md)** - Install and configure the external VoIP gateway (REQUIRED first)
17-
4. **[NethVoice Installation](nethvoice_install.md)** - Install NethVoice on top of configured proxy
18-
5. **[Module Configuration](nethvoice_install.md#module-configuration)** - Configure NethVoice with your requirements
19-
20-
:::warning Installation Order
21-
1. NethServer 8 must be installed first
22-
2. User Domain must be created second (required by NethVoice)
23-
3. NethVoice Proxy must be installed and configured third
24-
4. NethVoice can only be installed after proxy is ready
25-
5. NethVoice configuration uses the user domain created in step 2
26-
27-
See [NethVoice Proxy Installation](../advanced/nethvoice_proxy.md) for details on proxy requirements.
28-
:::
15+
2. **[NethVoice Installation](nethvoice_install.md)** - Install and configure NethVoice application
2916

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

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

65-
### Step 3: Create User Domain {#step-3-create-user-domain}
66-
67-
Create a user domain for NethVoice users and extensions:
68-
- Access NethServer 8 web interface → Domains and users
69-
- Create domain (OpenLDAP recommended for NethVoice)
70-
- Set admin credentials
71-
- Note LDAP bind settings (needed for NethVoice configuration)
72-
73-
See [User Domains setup](nethserver.md#user-domains) in the NethServer Installation guide for details.
74-
75-
### Step 4: Install NethVoice Proxy {#step-4-install-nethvoice-proxy}
76-
77-
After NethServer 8 and user domain are ready, install and configure the VoIP proxy:
78-
- Access the Software Center
79-
- Install NethVoice Proxy
80-
- Configure proxy domain (FQDN)
81-
- Set network interface and public IP
82-
- Verify proxy is running
83-
84-
See [NethVoice Proxy Installation Guide](../advanced/nethvoice_proxy.md) for detailed steps.
85-
86-
### Step 5: Install NethVoice {#step-5-install-nethvoice}
87-
88-
With NethVoice Proxy configured and running:
89-
- Access the Software Center
90-
- Install NethVoice
91-
- Complete the NethVoice configuration wizard
92-
- Select the user domain created in Step 3
93-
- Set up virtual hosts and certificates
94-
95-
### Step 6: Configure NethVoice {#step-6-configure-nethvoice}
52+
### Step 3: Install and configure NethVoice {#step-3-install-nethvoice}
9653

9754
Follow the [NethVoice Installation guide](nethvoice_install.md) to:
98-
- Configure NethVoice virtual hosts
99-
- Verify user domain is selected
100-
- Configure Let's Encrypt certificates
101-
- Access NethVoice administration and CTI
55+
- Install NethVoice
56+
- Complete the setup configuration wizard:
57+
- Configure an account provider
58+
- Install and configure a NethVoice Proxy
59+
- Set up virtual hosts, certificates and administration password
60+
- Access NethVoice administration interface and CTI
10261

10362
## Quick Reference {#quick-reference}
10463

105-
### System Requirements (Minimum) {#system-requirements-minimum}
64+
### Minimum System Requirements {#system-requirements-minimum}
10665

10766
| Component | Requirement |
10867
|-----------|-------------|
@@ -149,6 +108,19 @@ Complete guide covering:
149108
- Cluster configuration
150109
- Troubleshooting
151110

111+
### [NethVoice Installation](nethvoice_install.md) {#nethvoice-installation}
112+
113+
Complete guide covering:
114+
- NethVoice software installation
115+
- Setup wizard:
116+
- User domain
117+
- NethVoice Proxy
118+
- Virtual hosts (base hosts)
119+
- Let's Encrypt certificates
120+
- Administration password
121+
- Administrator access
122+
- Initial configuration
123+
152124
### [NethVoice Proxy Installation](../advanced/nethvoice_proxy.md) {#nethvoice-proxy-installation}
153125

154126
Complete guide covering:
@@ -158,19 +130,7 @@ Complete guide covering:
158130
- Configuration (domain, interface, public IP)
159131
- SSL certificate setup
160132
- Verification and testing
161-
- Must be installed BEFORE NethVoice
162-
163-
### [NethVoice Installation](nethvoice_install.md) {#nethvoice-installation}
164-
165-
Complete guide covering:
166-
- Installation order (Proxy → NethVoice)
167-
- NethVoice software installation
168-
- Module configuration
169-
- Virtual host setup
170-
- User domain configuration
171-
- Let's Encrypt certificate configuration
172-
- Administrator access
173-
- Initial configuration
133+
- Must be installed before NethVoice
174134

175135
## Installation Checklist {#installation-checklist}
176136

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

188-
During installation, ensure you complete:
189-
190-
- [ ] NethServer 8 installation
191-
- [ ] User Domain creation (OpenLDAP recommended)
192-
- [ ] Note down LDAP bind settings
193-
- [ ] NethVoice Proxy installation
194-
- [ ] NethVoice Proxy configuration
195-
- [ ] Verify proxy is running before NethVoice install
196-
- [ ] NethVoice installation
197-
- [ ] NethVoice configuration with user domain
198-
199148
## Important Notes {#important-notes}
200149

201150
:::info

docs/administrator-manual/install/nethserver.md

Lines changed: 3 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -137,66 +137,13 @@ After installation completes:
137137
- Password: `Nethesis,1234`
138138

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

142142

143143
After cluster setup, you can:
144144

145-
1. **Install User Domain**: [Set up LDAP or Active Directory](#user-domains)
146-
2. **Install NethVoice**: Proceed with [NethVoice installation](nethvoice_install) via the Software Center
147-
3. **Register NethServer**: Activate your [Enterprise subscription](#register-nethserver)
148-
149-
150-
## User Domains {#user-domains}
151-
152-
User domains store users and groups in an LDAP database. NethVoice requires at least one user domain to manage extensions, users, and authentication.
153-
154-
### Overview {#overview}
155-
156-
NethServer 8 supports two types of LDAP account providers:
157-
158-
| Provider | Type | Best For | Features |
159-
|----------|------|----------|----------|
160-
| **OpenLDAP (RFC2307)** | Internal | Unix/Linux clients, simple setup | Lightweight, easy configuration, smaller deployments, multiple instances per node |
161-
| **Active Directory (Samba)** | Internal | Windows clients, SMB file sharing | Domain controller, Windows compatibility, higher complexity, one instance per node |
162-
| **External LDAP** | External | Existing LDAP infrastructure | Connect to existing servers (Active Directory, OpenLDAP, etc.) |
163-
164-
165-
:::info NethVoice Requirement
166-
NethVoice requires at least one configured user domain. Choose **OpenLDAP (RFC2307)** for simpler deployments or **Active Directory** if you need Windows client support.
167-
:::
168-
169-
### Quick Setup: OpenLDAP (Recommended for NethVoice) {#quick-setup-openldap-recommended-for-nethvoice}
170-
171-
OpenLDAP is the simplest option for NethVoice-only deployments:
172-
173-
1. **Access the NethServer 8 web interface** after installation completes
174-
2. **Navigate to Domains and users** section
175-
3. **Click "Create domain"** and choose **"Internal"**
176-
4. **Select "OpenLDAP"** as the provider
177-
5. **Enter domain name** (e.g., `nethvoice.local`) - this is a logical name, not DNS-related
178-
6. **Set OpenLDAP admin username and password**
179-
7. **Click "Install provider"**
180-
181-
The domain will be ready immediately. You can now:
182-
- Create users and groups for NethVoice extensions
183-
- Manage user authentication
184-
- Configure NethVoice to use this domain
185-
186-
:::tip
187-
Keep the OpenLDAP admin credentials in a secure location. You'll need them for administrative tasks.
188-
:::
189-
190-
191-
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).
192-
193-
Key topics in the official docs:
194-
- **Active Directory Setup**: Complete domain controller configuration
195-
- **External LDAP Connection**: Binding to existing LDAP servers
196-
- **Password Policies**: Age, strength, and expiration settings
197-
- **User Management Portal**: Self-service password changes
198-
- **LDAP Provider Replicas**: Fault tolerance and redundancy
199-
- **LDAP binding settings**: Connect external application to a local-running LDAP server
145+
1. **Install NethVoice**: Proceed with [NethVoice installation](nethvoice_install) via the Software Center
146+
2. **Register NethServer**: Activate your [Enterprise subscription](#register-nethserver)
200147

201148
## Register NethServer {#register-nethserver}
202149

0 commit comments

Comments
 (0)