erin/webring
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update readme with config instructions and stuff

Browse source
This commit is contained in:
Erin 2023-09-05 22:12:28 -04:00
parent 81a472f6e4
commit cb5778377e
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -2,10 +2,20 @@
## run it
npm i
no external dependencies! no need to `npm i`! woo!
cp webring.txt.sample webring.txt && $EDITOR webring.txt
npm run start
## configuration
the server listens on port `$PORT` (default 80) and loads the list of
participating sites from the file `$SITES_FILE` (default `webring.txt`).
the sites file is a newline-separated list of URLs; leading and trailing
whitespace, empty lines, and lines starting with `#` are ignored. you can test
out the format using [this regexr link](https://regexr.com/?expression=/^\s*([^%23\s].*)\s*$/gm&text=%23%20sample%20SITES_FILE%0A%0A%23%20my%20friend%20alice%20who%20is%20cool%0Ahttps%3A%2F%2Falices.awesome.website%0A%0A%23%20my%20other%20friend%20bob%20who%20is%20neat%20as%20well%0Ahttp%3A%2F%2Fsome.shared.domain%2F~bob%0A&tool=list&input=your.webring.server/next?from=$1\n).
## link to webring sites
participating sites should link to the endpoints `/prev?from=<site>` and