Emi/faery-ring
1
1
Fork 1
Code Issues Pull requests Releases 2 Activity

Expand on the README to include how members link up

Browse source
This commit is contained in:
Emi Simpson 2021-11-09 13:15:00 -05:00
parent 7b96cc86e4
commit 076c5308f3
Signed by: Emi
GPG key ID: A12F2C2FFDC3D847
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -40,6 +40,7 @@ Faery Rings is licensed under the CNPL, which forbids the use of Faery Ring for
Running Faery Ring is pretty easy. First, make a `.txt` file somewhere, and fill it with all of the sites in your ring, one per line. Leave out the protocol (https://) and a trailing slash, so that it looks something like this: Running Faery Ring is pretty easy. First, make a `.txt` file somewhere, and fill it with all of the sites in your ring, one per line. Leave out the protocol (https://) and a trailing slash, so that it looks something like this:
``` ```
www.dragoness.space
emii.gay emii.gay
garlic.garden/onionring garlic.garden/onionring
queerings.gay queerings.gay
@ -56,7 +57,7 @@ faery-ring /path/to/domains.txt
docker run -v /path/to/domains.txt:/domains.txt -p 3243:3243 alch0emi/faery-ring docker run -v /path/to/domains.txt:/domains.txt -p 3243:3243 alch0emi/faery-ring
``` ```
Right now, Faery Ring always binds to port 3243, but this might change in the future, who knows. Anyway, now you can point your webserver at Faery Ring and be on your way! The config below is for Caddy, but any webserver that supports reverse proxies will work! Right now, Faery Ring always binds to port 3243, but this might change in the future, who knows. Anyway, now you can point your webserver at Faery Ring! The config below is for Caddy, but any webserver that supports reverse proxies will work!
```Caddyfile ```Caddyfile
your.web.site { your.web.site {
@ -64,3 +65,5 @@ your.web.site {
reverse_proxy /prev/* localhost:3243 reverse_proxy /prev/* localhost:3243
} }
``` ```
Now your webring members can add links on their page to `https://your.web.site/next/\<their\_domain>` `https://your.web.site/prev/\<their\_domain>` in order to build the ring. For example, whoever runs the page at www.dragoness.space would add a link to `https://your.web.site/next/www.dragoness.space` and `https://your.web.site/prev/www.dragoness.space`