sanspie/webring
1
0
Fork 0
mirror of https://github.com/Alexander-D-Karpov/webring.git synced 2026-03-16 22:07:41 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
not so small webring backend, written in go
32 Commits 2 Branches 32 Tags 254 KiB
Go 64.9%
HTML 17.2%
CSS 13.7%
Nix 2.3%
Makefile 1.5%
Other 0.4%
v-341e12e
Go to file
Damir Modyarov 341e12e611
refactor: Use URL struct in favicon downloader (#3)
2025-06-22 19:24:48 +03:00
.github/workflows fixed build 2024-11-12 19:10:28 +03:00
cmd/server feat: Implement slugs and id reordering (#2) 2025-06-19 14:34:18 +03:00
internal refactor: Use URL struct in favicon downloader (#3) 2025-06-22 19:24:48 +03:00
migrations feat: Implement slugs and id reordering (#2) 2025-06-19 14:34:18 +03:00
static Add source code link to footer 2024-07-17 17:00:36 +03:00
.env.template Improve site listing page design and content 2024-07-17 16:31:01 +03:00
.gitignore added favicon for sites, list all sites api and page, disabled cors for api, minor fixes 2024-07-17 02:48:53 +03:00
embedded.go added favicon for sites, list all sites api and page, disabled cors for api, minor fixes 2024-07-17 02:48:53 +03:00
go.mod added favicon for sites, list all sites api and page, disabled cors for api, minor fixes 2024-07-17 02:48:53 +03:00
go.sum added favicon for sites, list all sites api and page, disabled cors for api, minor fixes 2024-07-17 02:48:53 +03:00
Makefile Initial commit 2024-07-16 15:40:41 +03:00
README.md feat: Implement slugs and id reordering (#2) 2025-06-19 14:34:18 +03:00

README.md

Webring Relay Service

This project is a webring relay service built with Go. It manages a list of websites, checks their uptime, and provides a dashboard for administration.

Features

  • Dashboard for managing websites in the webring
  • Automatic uptime checking of websites (with proxy support)
  • API endpoints for navigating the webring
  • Basic authentication for the dashboard

Prerequisites

  • Go 1.16 or later
  • PostgreSQL database

Installation

edit .env to set correct path to database

go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
go mod tidy
cp .env.template .env
make migrate-up

Local Run

go run cmd/server/main.go

or download prebuild version

wget https://github.com/Alexander-D-Karpov/webring/releases/latest/download/webring
chmod +x webring
./webring

Usage

  • Access the dashboard at http://localhost:8080/dashboard (use the credentials set in your .env file)
  • API endpoints:
    • Next site: GET /{slug}/next/data
    • Previous site: GET /{slug}/prev/data
    • Random site: GET /{slug}/random/data
    • Full data for a site: GET /{slug}/data
  • Redirect endpoints:
    • Visit site: GET /{slug}
    • Next site: GET /{slug}/next
    • Previous site: GET /{slug}/prev
    • Random site: GET /{slug}/random