Skip to content

added systemd example to README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markmnl merged 4 commits into from
Apr 17, 2026
Merged

added systemd example to README #2

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4ab51f
added systemd example to README
markmnl Apr 17, 2026
4bc9e30
fix ExecStart
markmnl Apr 17, 2026
d8813b7
PrivateTmp=true
markmnl Apr 17, 2026
ff2e1f2
write permission paths
markmnl Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,74 @@ All routes are served over HTTPS under the `/fmsgid` path.
| `GET` | `/fmsgid/:address` | Lookup an fmsg address and return its details including display name, quotas, and usage. The address must be in fmsg format (`@[email protected]`). Returns `AddressDetail` JSON on success, `400` if the address is invalid, `404` if not found. |
| `POST` | `/fmsgid/send` | Record a send transaction. Accepts an `AddressTx` JSON body with `address`, `ts` (timestamp), and `size`. |
| `POST` | `/fmsgid/recv` | Record a receive transaction. Accepts an `AddressTx` JSON body with `address`, `ts` (timestamp), and `size`. |

### systemd

An example systemd service to run fmsgid as a service on startup

ASSUMES:
* Directory `/opt/fmsgid` has been created and contains built executable: `fmsgid`
* 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 `/opt/fmsgid` and to the path specified by `FMSGID_CSV_FILE` if it is outside `/opt/fmsgid`

`/etc/systemd/system/fmsgid.service`

```
[Unit]
Description=fmsgid HTTP API
After=network-online.target
Wants=network-online.target

[Service]
Type=simple

User=fmsg
Group=fmsg

EnvironmentFile=/opt/fmsgid/env

ExecStart=/opt/fmsgid/fmsgid
WorkingDirectory=/opt/fmsgid
Comment on lines +114 to +117

Copilot AI Apr 17, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copilot uses AI. Check for mistakes.

Restart=on-failure
RestartSec=3

# --- Filesystem access ---
ReadWritePaths=/opt/fmsgid
PrivateTmp=true

# --- Hardening ---
NoNewPrivileges=true
PrivateTmp=true
ProtectSystem=strict
ProtectHome=true

# --- Logging ---
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target
```

### env

```
GIN_MODE=release
FMSGID_PORT=8080
FMSGID_CSV_FILE=addresses.csv

PGHOST=127.0.0.1
PGPORT=5432
PGUSER=
PGPASSWORD=
PGDATABASE=fmsgid
```

```
sudo systemctl daemon-reload
sudo systemctl enable fmsgid
sudo systemctl start fmsgid
```
Loading