improve docs for installing

This commit is contained in:
genofire 2021-11-07 18:31:48 +01:00
parent af80fc6c92
commit b5d374c0ae
2 changed files with 45 additions and 0 deletions

View File

@ -3,3 +3,45 @@ An Prometheus Exporter for OvenMediaEngine
(it provides also a small API-Client for OvenMediaEngine)
Be welcome to improve it.
## Configure OvenMediaEngine
This Exporter use the REST-API of OvenMediaEngine,
to setting it up, that a look in there Documentation [OvenMediaEngine REST-API](
https://airensoft.gitbook.io/ovenmediaengine/rest-api).
## Setup Exporter
### Compile
Install [golang](https://golang.org/doc/install).
Run:
`go install -v dev.sum7.eu/genofire/oven-exporter@latest`
### Configuration
Read comments in [config_example.toml](config_example.toml) for more information.
Maybe a good place to store this file is: `/etc/ovenmediaengine/exporter.conf`
### Startup
Create a systemd.service file e.g. under `/etc/systemd/system/oven-exporter.service` with maybe a content like this:
```ini
[Unit]
Description = Prometheus exporter for OvenMediaEngine
[Service]
Type=simple
ExecStart=/usr/local/bin/oven-exporter -c /etc/ovenmediaengine/exporter.conf
Restart=always
RestartSec=5s
Environment=PATH=/usr/bin:/usr/local/bin
[Install]
WantedBy=multi-user.target
```
PS: maybe you need to adjust the binary path and configuration path.
Start and enable on boot:
`systemctl enable --now oven-exporter.service`

View File

@ -1,6 +1,9 @@
# (Address +) Port where the Exporter is listen for Prometheus request
listen = ":8080"
[api]
# URL to REST-API of OvenMediaEngine
url = "http://1.2.3.4:8081"
# AccessToken of OvenMediaEngine's REST-API
token = "ome-access-token"