From bdbf39219bc5c16cdbbbd1d5a227edd87d56b34a Mon Sep 17 00:00:00 2001 From: JP Appel Date: Wed, 2 Oct 2024 12:22:33 -0400 Subject: Add README with instructions --- Makefile | 1 - README.md | 37 +++++++++++++++++++++++++++++++++++++ nonsense-time.service | 2 +- 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/Makefile b/Makefile index ca1bf17..b6980df 100644 --- a/Makefile +++ b/Makefile @@ -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 default 8080 + server listening port +-b default 0.0.0.0 + network address to bind to +-w 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 -- cgit v1.2.3