diff options
| author | JP Appel <jeanpierre.appel01@gmail.com> | 2024-10-02 12:22:33 -0400 |
|---|---|---|
| committer | JP Appel <jeanpierre.appel01@gmail.com> | 2024-10-02 12:22:33 -0400 |
| commit | bdbf39219bc5c16cdbbbd1d5a227edd87d56b34a (patch) | |
| tree | 2fb91287cb4348e4279b64fc3283c719bed947a3 | |
| parent | 7e8ad97094fbd7753116254f1021f96447e4ec9c (diff) | |
Add README with instructions
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | README.md | 37 | ||||
| -rw-r--r-- | nonsense-time.service | 2 |
3 files changed, 38 insertions, 2 deletions
@@ -9,7 +9,6 @@ build: $(BIN) install: $(BIN) cp $(BIN) /usr/bin - cp test: go test ./... diff --git a/README.md b/README.md new file mode 100644 index 0000000..f223a2c --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Nonsense Time + +Back-end for Nonsense Time campaign + +## Building + +Tested for go1.23 `linux/amd64` and `darwin/amd64` + +``` +make build +``` + +## Installation + +``` +make install +``` + +## Running + +The server can be started via the `nonsense-time` binary. +It accepts the following options: + +``` +-p <PORT> default 8080 + server listening port +-b <BIND_ADDRESS> default 0.0.0.0 + network address to bind to +-w <WAIT_TIME> default 2 seconds + maximum wait time for timed requests +-v + verbose output +``` + +## SystemD Service + +A SystemD service is provided but not installed by default. diff --git a/nonsense-time.service b/nonsense-time.service index 2bbe9f0..673f88a 100644 --- a/nonsense-time.service +++ b/nonsense-time.service @@ -3,7 +3,7 @@ Description=Nonsense Time backend After=nginx.service [Service] -ExecStart=/usr/bin/nonsense-time +ExecStart=/usr/bin/nonsense-time -b 127.0.0.1 -p 1500 Type=simple Restart=on-failure |