onasaft
/
go-webring
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A go program for managing a webring.
58 Commits
1 Branch
0 Tags
348 KiB
Go 48.9%
Makefile 20.2%
HTML 18.6%
CSS 12.3%
 
 
 
 
Go to file
tfasano1 c7624cc9a1 use csv instead of tsv 2023-06-09 15:32:51 -04:00
static add member table, fix off by one bug 2023-06-09 11:35:56 -04:00
.gitignore cleanup and update of readme and index 2023-06-09 11:35:56 -04:00
.pre-commit-config.yaml Add licenses for REUSE compliance 2023-06-09 11:35:56 -04:00
LICENSE Initial commit 2023-06-09 15:26:28 +00:00
Makefile Add Makefile, ignore build artefacts 2023-06-09 11:35:56 -04:00
README.md Readme 2023-06-09 11:35:56 -04:00
example-index.html add member table, fix off by one bug 2023-06-09 11:35:56 -04:00
funcs.go use csv instead of tsv 2023-06-09 15:32:51 -04:00
go.mod Add licenses for REUSE compliance 2023-06-09 11:35:56 -04:00
go.sum Add all of the flags 2023-06-09 11:35:56 -04:00
go.sum.license Add licenses for REUSE compliance 2023-06-09 11:35:56 -04:00
handlers.go add member table, fix off by one bug 2023-06-09 11:35:56 -04:00
list.txt use csv instead of tsv 2023-06-09 15:32:51 -04:00
main.go add member table, fix off by one bug 2023-06-09 11:35:56 -04:00

README.md

go-webring

A go program for managing a webring.

This is originally a fork of Amolith's go-webring, which is used for Fediring.

git clone https://git.sr.ht/~amolith/go-webring
cd go-webring
go build
cp example-index.html index.html
./go-webring

The service runs on port 2857, so you can have NginX/etc. proxy_pass to that port for the domain you want to use as a host.

The index.html is the main webpage of your ring. It can be customized to your liking and a list of the sites in the ring will be addedd in the place of the {{ . }}.

Pages

This program produces four main pages for use as links:

  • / -- The index. A mainpage in index.html where you can customize your webring homepage. This lists all sites in the webring automatically.
  • /next -- Go to the next site in the webring (from whichever site you are linked from).
  • /previous -- Go to the previous site in the webring.
  • /random -- Go to a random site in the webring.

If linked to /next or /previous without a HTTP referer in the webring, they will function like /random.

Static Files

  • /assets -- This is the route where you can access the static file server which will be serving the /static folder

Put css, js, images or anything else in /static and then access them with http under the /assets route.

Custom Usage

$ ./go-webring -h
Usage of ./go-webring
  -c, --columns int      Number of columns in the member table
  -i, --index string     Path to home page template (default "index.html")
  -l, --listen string    Host and port go-webring will listen on (default "127.0.0.1:2857")
  -m, --members string   Path to list of webring members (default "list.txt")