Ctrl K
ring2all.com

Network Configuration Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Sections
  5. Settings Reference
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Is Network Configuration?

Network Configuration is an infrastructure management module that displays and configures network settings for telephony servers. It provides visibility into network interfaces, IP addressing, DNS, and allows hostname configuration.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Network Configuration Architecture                │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Telephony Servers                                              │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │                                                          │   │
│  │  Server: PBX-Primary                                     │   │
│  │  ┌────────────────────────────────────────────────────┐  │   │
│  │  │  Interface: eth0                                   │  │   │
│  │  │  ├─ IP: 192.168.1.10                              │  │   │
│  │  │  ├─ Netmask: 255.255.255.0                        │  │   │
│  │  │  ├─ Gateway: 192.168.1.1                          │  │   │
│  │  │  ├─ DNS: 8.8.8.8, 8.8.4.4                         │  │   │
│  │  │  ├─ MAC: 00:1A:2B:3C:4D:5E                        │  │   │
│  │  │  ├─ DHCP: Disabled (Static)                       │  │   │
│  │  │  ├─ MTU: 1500                                     │  │   │
│  │  │  └─ State: UP                                     │  │   │
│  │  └────────────────────────────────────────────────────┘  │   │
│  │                                                          │   │
│  │  ┌────────────────────────────────────────────────────┐  │   │
│  │  │  Interface: eth1                                   │  │   │
│  │  │  ├─ IP: 10.0.0.10                                 │  │   │
│  │  │  ├─ VLAN: 100                                     │  │   │
│  │  │  └─ Description: Voice VLAN                       │  │   │
│  │  └────────────────────────────────────────────────────┘  │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Read from system / Apply changes                       │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Linux Network Stack                               │   │
│  │                                                          │   │
│  │  /etc/network/interfaces                                │   │
│  │  /etc/netplan/*.yaml                                    │   │
│  │  /etc/hostname                                           │   │
│  │  /etc/resolv.conf                                        │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.network_configNetwork configurations
public.telephony_serversServer references

Key Files

FileDescription
modules/networkSettings/Frontend module
/etc/hostnameSystem hostname
/etc/network/interfacesDebian networking
---

2. Module Overview (Commercial/Business)

Business Value

Network Configuration provides infrastructure visibility:

Without ModuleWith Module
SSH requiredWeb interface
Command lineVisual display
Manual trackingCentralized view
Multiple loginsSingle dashboard

Use Cases

  1. Infrastructure View

- All server networks

- Interface status

  1. Hostname Management

- Server identification

- DNS naming

  1. Troubleshooting

- IP verification

- Gateway check

  1. Documentation

- Network inventory

- Interface mapping

Feature Highlights

FeatureBenefit
Multi-ServerAll servers visible
Real-TimeRefresh from system
Interface ListAll NICs shown
DHCP/StaticConfiguration mode
HostnameEditable hostname
VLAN SupportVLAN ID display
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • View server network interfaces
  • See IP addresses and configuration
  • Check DHCP vs Static status
  • View DNS server settings
  • See MAC addresses
  • Check interface state (UP/DOWN)
  • Edit server hostname
  • Refresh network information

Network Configuration - Server List

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Network Configuration                              │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Configure network settings for telephony servers              │
│                                                                 │
│  [Refresh All]                                                  │
│                                                                 │
│  [🔍 Search servers...]                                         │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Server Name   │ Host          │ Location    │ Connectivity│ │
│  ├───────────────┼───────────────┼─────────────┼─────────────┤ │
│  │ PBX-Primary   │ 192.168.1.10  │ Datacenter  │ ● Online    │ │
│  │ PBX-Secondary │ 192.168.1.11  │ Datacenter  │ ● Online    │ │
│  │ PBX-Remote    │ 10.0.0.10     │ Branch      │ ● Online    │ │
│  │ Local         │ localhost     │ Local       │ ● Online    │ │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
│  Click a server to view network interfaces                      │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Network Configuration - Server Detail

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Server Network Configuration                       │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Server: PBX-Primary                    [List] [Refresh]       │
│                                                                 │
│  Network configuration read from this server in real-time      │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  ▼ Server Hostname                                              │
│                                                                 │
│  Hostname: [pbx-primary.company.local    ] [Save]              │
│    Configure the system hostname for this server               │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  ▼ Network Interfaces                                           │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Interface │ IP Address    │ Netmask       │ DHCP  │ State│  │
│  ├───────────┼───────────────┼───────────────┼───────┼──────┤  │
│  │ eth0      │ 192.168.1.10  │ 255.255.255.0 │ Static│ UP   │  │
│  │ eth1      │ 10.0.0.10     │ 255.255.255.0 │ Static│ UP   │  │
│  │ lo        │ 127.0.0.1     │ 255.0.0.0     │ -     │ UP   │  │
│  │ docker0   │ 172.17.0.1    │ 255.255.0.0   │ -     │ UP   │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Interface Details

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Interface: eth0                                    │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ⓘ Read-Only (from system)                                     │
│                                                                 │
│  Interface Name: eth0                                           │
│    Network interface name (e.g., eth0, ens33, bond0)           │
│                                                                 │
│  IP Address: 192.168.1.10                                      │
│                                                                 │
│  Netmask: 255.255.255.0                                        │
│                                                                 │
│  Gateway: 192.168.1.1                                          │
│                                                                 │
│  Primary DNS: 8.8.8.8                                          │
│                                                                 │
│  Secondary DNS: 8.8.4.4                                        │
│                                                                 │
│  DHCP Enabled: ☐ (Static)                                      │
│                                                                 │
│  MAC Address: 00:1A:2B:3C:4D:5E                                │
│                                                                 │
│  MTU: 1500                                                     │
│                                                                 │
│  VLAN ID: (none)                                               │
│                                                                 │
│  State: UP                                                     │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Refresh: Click Refresh to get real-time network info.
TIP
Hostname: Hostname changes take effect immediately.
NOTE
Read-Only: Interface settings are currently read-only.

---

4. Configuration Sections

Server List

ColumnDescription
Server NameServer identifier
HostIP or hostname
LocationPhysical location
ConnectivityOnline/Offline status

Interface Fields

FieldDescription
Interface NameNIC name (eth0, ens33)
IP AddressStatic IP address
NetmaskNetwork mask
GatewayDefault gateway
Primary DNSFirst DNS server
Secondary DNSBackup DNS server
DHCP EnabledAuto vs Static
VLAN IDVLAN tag (1-4094)
MTUMax transmission unit
MAC AddressHardware address
StateUP or DOWN
---

5. Settings Reference

Common Interface Names

NameDescription
eth0, eth1Traditional Ethernet
ens33, ens192Predictable names
eno1, eno2Onboard NICs
bond0Bonded interface
loLoopback
docker0Docker bridge

Netmask Values

CIDRNetmaskHosts
/8255.0.0.016M
/16255.255.0.065K
/24255.255.255.0254
/25255.255.255.128126
/30255.255.255.2522

MTU Values

MTUUse Case
1500Standard Ethernet
1400-1460VPN/tunnels
9000Jumbo frames

Common DNS Servers

ProviderPrimarySecondary
Google8.8.8.88.8.4.4
Cloudflare1.1.1.11.0.0.1
OpenDNS208.67.222.222208.67.220.220
---

6. Common Scenarios & Examples

Scenario 1: View Server Network

  1. Open Network Configuration
  2. Click on server
  3. View interfaces
  4. Check IP addresses and status
  5. Refresh for current data

Scenario 2: Change Hostname

  1. Open server detail
  2. Find Server Hostname section
  3. Enter new hostname
  4. Click Save
  5. Hostname updates immediately

Scenario 3: Verify DNS

  1. Open server detail
  2. Find Primary/Secondary DNS
  3. Verify DNS servers are correct
  4. If wrong, edit via SSH or system config

Scenario 4: Check VLAN Configuration

  1. Open server detail
  2. Look for VLAN ID column
  3. Verify VLAN tags match network plan
  4. Check with network team if mismatched

---

7. Limitations & Important Notes

Technical Notes

NOTE
Read-Only: Interface editing coming in future update.
NOTE
Real-Time: Refresh to get current system state.
WARNING
Hostname Format: Use valid DNS names only.

Best Practices

  1. Document Changes: Track network modifications
  2. Use Static IPs: For telephony servers
  3. Reliable DNS: Use stable DNS servers
  4. Verify Connectivity: Test after changes
  5. Proper VLAN: Separate voice traffic

Current Read-Only Status

FeatureStatus
View interfaces✓ Available
View IP/DNS✓ Available
Edit hostname✓ Available
Edit interface⏳ Future update
Add interface⏳ Future update
---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
No interfacesRefresh neededClick Refresh
Wrong IPDHCP changedCheck DHCP lease
OfflineNetwork issueCheck connectivity
Hostname failInvalid formatUse valid DNS name

Check Network via SSH

Bash
# View interfaces
ip addr show

# View routing
ip route show

# Check DNS
cat /etc/resolv.conf

# Check hostname
hostname -f

# Test connectivity
ping -c 3 8.8.8.8

Common Commands

Bash
# Set hostname
hostnamectl set-hostname pbx-primary.company.local

# Restart networking
systemctl restart networking

# Check interface status
ip link show eth0

# View DHCP lease
cat /var/lib/dhcp/dhclient.eth0.leases

---

9. Glossary

TermDefinition
InterfaceNetwork adapter
DHCPAuto IP assignment
Static IPFixed IP address
GatewayRouter address
DNSName resolution
VLANVirtual LAN
MTUMax packet size
---

Lua Script Status ℹ️

Infrastructure Module

ComponentStatus
Network Configurationℹ️ Network viewing - no Lua handler required
Network Configuration is an infrastructure viewing module. It reads and displays network settings from telephony servers. No Lua handlers are used - network data is read from the Linux system by the backend service.

---

Documentation last updated: January 2026
AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?