The easiest way to deploy our API is via docker.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
version: "3"
services:
armonitor:
image: manyos/armonitor:latest
environment:
- INTERVAL=30
- BASEURL=http://rapi:8080
- AR_SERVER=pier1
- AR_PORT=9502
- AR_USER=<ar-user>
- AR_PASSWORD=<ar-password>
- MONITOR_USERNAME=<api-user>
- MONITOR_PASSWORD=<api-password>
rapi:
image: manyos/roc-server
volumes:
- armonitor:/home/node/app/conf
volumes:
armonitor:
driver: local
driver_opts:
type: nfs
o: nfsvers=4,addr=<nfs-host>,rw
device: ":/<nfs-export-path>/armonitor"
Note: Make sure to mount the /home/node/app/conf folder externally to store your conf permanently. The container runs as uid/gid 999; an existing volume (e.g. NFS) must allow this user to write.
MONITOR_USERNAME / MONITOR_PASSWORD are the preferred names of the API credentials (USERNAME / PASSWORD still work, but USERNAME collides with the operating system variable on some systems).
The image is based on Node 24. For container probes use GET /health (liveness) and GET /ready (readiness); both need no authentication. /ready is 200 while the scheduler runs and conf/metrics.json is readable, otherwise 503; it does not depend on Remedy.