adyxax/ods
1
0
Fork 0
Code Issues Pull requests Releases 1 Packages Activity Actions

chore(tooling): improve README and Makefile
All checks were successful
/ deploy (push) Has been skipped
Details
/ publish (push) Has been skipped
Details
/ test (push) Successful in 13s
Details
/ build (push) Has been skipped
Details

Browse source
This commit is contained in:
Julien Dessaux 2025-03-16 00:02:52 +01:00
parent 77b539522c
commit 55168d4091
Signed by: adyxax
GPG key ID: F92E51B86E07177E
2 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
GNUmakefile
View file

@ -37,8 +37,8 @@ push: tidy no-dirty check ## push changes to git remote
.PHONY: deploy .PHONY: deploy
deploy: build ## deploy changes to the production server deploy: build ## deploy changes to the production server
rsync ./ods root@ods.adyxax.org:/usr/local/bin/ rsync ./ods ods@ods.adyxax.org:
ssh root@ods.adyxax.org "systemctl restart ods" ssh ods@ods.adyxax.org "systemctl --user restart ods"
##### Utils #################################################################### ##### Utils ####################################################################
.PHONY: confirm .PHONY: confirm

7
README.md
View file

@ -16,6 +16,13 @@ help` if running BSD) to see the possible actions.
Use `make build` to build a static binary of the service, embedding everything. Use `make build` to build a static binary of the service, embedding everything.
## Configuration
ODS can be configured by setting the following environment variables:
- `ODS_DEBUG`: Set this to a non empty string to activate debug logs.
- `ODS_HOST`: Hostname or address to listen on, defaults to `127.0.0.1`.
- `ODS_PORT`: TCP port to listen on, defaults to `8080`.
## The dictionary ## The dictionary
The "Officiel Du Scrabble" (ODS for short) is what the official dictionary for The "Officiel Du Scrabble" (ODS for short) is what the official dictionary for