Services¶
A service is a software which usually runs in background.
The system will ensure service status accordingly to its configuration.
A service in configuration database is something like this:
httpd=service
status=enabled
access=public
TCPPorts=80,443
Where httpd is the service name and status tells the system if the service should be enabled or disabled.
When the status property is switched between enabled/disabled state, the change will be reflected into runlevel configuration. This is what runlevel-adjust event and action do for all configured services. There is also another action called adjust-services which does the same thing for services registered on a single event.
A service without a record in the configuration database is ignored and can be manually manged using systemctl. See Add a new service.
Control a service¶
Enable a service:
config setprop myservice status enabled
signal-event runlevel-adjust
Disable a service:
config setprop myservice status disabled
signal-event runlevel-adjust
Where myservice is the service name to be enabled or disabled.
Access network service¶
A network service is a service running on the server which expose UDP or TCP ports. Ports can be listed in following properties:
TCPPort: a single TCP portTCPPorts: a comma separated list of TCP portsUDPPort: a single UDP portUDPPorts: a comma separated list of UDP ports
If both TCPPort and TCPPorts properties are set, TCPPorts has the precedence. If both UDPPort and UDPPorts properties are set, UDPPorts has the precedence.
A service can be accessible from public or private LAN. This configuration is saved on access property.
The property is a comma separated list of zones (green, red, blue, orange).
Example of a service with UDP port 1122 open to the Internet:
config setprop myservice status enabled UDPPort 1122 access green,red
Example of a service with TCP ports 1122 an 2233 open to local network:
config setprop myservice status enabled TCPPorts 1122,2233 access green
The ports are opened only if the status property is set to enabled.
Add a new service¶
Any software can configure the init system using the standard systemctl command. This approach always work for third-party software.
On the other hand, if the service must be controlled by NethServer, create a new record inside configuration database:
config set myservice service status enabled
Where myservice is the name of the new service.
Make sure also there are defaults values inside the directory /etc/e-smith/db/configuration/defaults: if the key is present
inside the configuration database, but not inside defaults, the service will be stopped.
Given the above example, create these files:
mkdir -p /etc/e-smith/db/configuration/defaults/myservice
echo "service" > /etc/e-smith/db/configuration/defaults/myservice/type
echo "enabled" > /etc/e-smith/db/configuration/defaults/myservice/status
Signal the new service to the system:
signal-event runlevel-adjust
Add a new network service¶
If a service not controlled by NethServer needs one or more open ports, use the TCPPort(s) or UDPPort(s) prop to declare the port(s) and signal the firewall to open it:
config set fw_myservice service status enabled TCPPort 12345 access green
signal-event firewall-adjust
Otherwise, if the service is controlled by NethServer, you can add the properties directly to the service key. For the service myservice on above example:
config set myservice service status enabled TCPPort 12345 access green
signal-event firewall-adjust