0.3.5 • Published 6 years ago
systemctl-rest v0.3.5
systemctl-rest
REST endpoint for manipulation of system services. This serves as a thin wrapper around native linux systemctl command (leveraging sysctlx package).
Prerequisites
- linux host supporting service manipulation via systemctl
API
http://localhost:<port>/service/<service>- returns structuredsystemctl statusin JSONhttp://localhost:<port>/service/<service>/enable- callssystemctl enablehttp://localhost:<port>/service/<service>/disable- callssystemctl disablehttp://localhost:<port>/service/<service>/start- callssystemctl starthttp://localhost:<port>/service/<service>/stop- callssystemctl stophttp://localhost:<port>/service/<service>/restart- callssystemctl restart
Usage
1. Directly as a standalone server
When invoked directly from the command line, systemctl-rest configures express server instance and automatically starts listening on given port.
$ sudo node systemctl-rest (with default port 8181)
$ sudo node systemctl-rest 8080
2. Required to provide configured server instance
In case you would like to build on top of this package you could reuse the existing configured express instance and add your own routing paths with respective handlers. This helps you to avoid combining multiple server instances to achieve your goal with systemctl.
Please note that in this scenario you need to retrieve the port and start listening on it yourself:
let server = require('systemctl-rest').server;
# .. add your paths
server.get('/my/custom/path', myHandlerFunction);
# .. start the server
server.listen(<my-port>);