A simple, SvelteKit-based webring for goats linking to your friends' sites!
git clone https://github.com/AndrewDTR/goated-webring
cd goated-webring
cp .env.example .env
# Change the ADMIN_PASS variable
Then, based on how you want to deploy:
Docker Compose
docker compose up -d
Node environments
npm install
npm run build
node --env-file=.env build
As an admin, you can access the settings by going to the /admin route and logging in using the password you set in your .env.
Here, you can change a few basic settings (see below), change the order of the sites in the ring, add sites manually, and create invites for members to add themselves.
The order of the sites determines their neighbors in the ring.
flowchart LR
A[Site 1] -->|next| B[Site 2]
B -->|next| C[Site 3]
C -->|next| A[Site 1]
Members of the ring can link to their neighbors by using the base link, the routes next and prev, and the query param site with their own URLs.
That is, if a ring was being hosted on https://ring.example.com/ and https://person.one/ wanted to link to their neighbors, they would hyperlink https://ring.example.com/prev?site=https://person.one and https://ring.example.com/next?site=https://person.one.
If you don't want to type those out by hand, these links are available at https://ring.example.com/links?site=https://person.one
Webring Name - The name of your webring, for branding purposes
Redirect Link - If you have the redirect option set to Redirect, the base link (and any invalid URLs) will redirect here. If not, it'll redirect to a landing page with everyone's links in a grid.
Hide wordmark - If you're using the landing page, this will get rid of a small icon at the bottom right saying "made with goated webring 🐐"