Conversation
There was a problem hiding this comment.
Pull request overview
Adds a systemd service example to the README to document how to run fmsgid at startup on Linux hosts.
Changes:
- Document an example
/etc/systemd/system/fmsgid.serviceunit for runningfmsgidunder a dedicated user. - Add an example environment file (
/opt/fmsgid/env) and basicsystemctlcommands to enable/start the service.
| EnvironmentFile=/opt/fmsgid/env | ||
|
|
||
| ExecStart=/opt/fmsgid/fmsgid | ||
| WorkingDirectory=/opt/fmsgid |
There was a problem hiding this comment.
ExecStart=/opt/fmsgid/fmsgid 0.0.0.0 suggests the binary accepts a bind-address argument, but src/fmsgid.go doesn't parse CLI args and Gin’s Run(":"+port) already binds on all interfaces by default. Consider removing 0.0.0.0 (or documenting the actual supported way to configure the bind address if one exists).
| An example systemd service to run fmsgid as a service on startup | ||
|
|
||
| ASSUMES: |
There was a problem hiding this comment.
Minor docs polish: this sentence is missing ending punctuation, and the following ASSUMES: line has a trailing space. Tightening these up will improve readability/consistency with the rest of the README.
| An example systemd service to run fmsgid as a service on startup | |
| ASSUMES: | |
| An example systemd service to run fmsgid as a service on startup. | |
| ASSUMES: |
| * Text file `/opt/fmsgid/env` exists containing environment variables (example below) | ||
| * User `fmsg` has been created and has | ||
| - read and execute permissions to `/opt/fmsgid/`, e.g. with `chown -R fmsg:fmsg /opt/fmsgid` after `mkdir /opt/fmsgid` | ||
| - write permissions to FMSG_DATA_DIR |
There was a problem hiding this comment.
The prerequisites list mentions FMSG_DATA_DIR, but this repo/documentation appears to only use FMSGID_PORT and FMSGID_CSV_FILE (no FMSG_DATA_DIR env var). This is likely a stale/incorrect variable name—please update this bullet to reference the actual path(s) that need write access (e.g., /opt/fmsgid and/or the FMSGID_CSV_FILE location).
| - write permissions to FMSG_DATA_DIR | |
| - write permissions to `/opt/fmsgid` and to the path specified by `FMSGID_CSV_FILE` if it is outside `/opt/fmsgid` |
No description provided.