mirror of
https://github.com/Alexander-D-Karpov/webring.git
synced 2026-03-16 22:07:41 +03:00
not so small webring backend, written in go
bf62b8f427
* major changes
Introduce full user system and approval workflow
——————————————————————————————————————————
Login & sessions
Telegram one‑click login (/login → /auth/telegram) with HMAC verification
New users and sessions tables; telegram_id now optional, TTL‑based cleanup job
Secure session_id cookie (configurable TTL and Secure/SameSite flags)
User dashboard (/user)
Lists the member’s sites and their uptime status
Forms to submit new site or update requests; validation and slug/url sanitisation
View pending requests with change diff
Request storage
update_requests table captures create/update ops as JSONB “changed_fields”
Admin review
/admin/requests interface to approve / reject queued requests
Approval auto‑creates sites (with ordered display_order) or patches existing ones, then refreshes favicon
Super‑admin panel
/admin/setup lists all users, toggle is_admin and forcibly logs them out
Notifications
On every new request, all admins with a Telegram ID receive a Markdown summary via bot API
Public UI tweaks
Header shows login/logout, role‑aware links and call‑to‑action cards
/submit page creates a queued request
Config & env
Added TELEGRAM_BOT_TOKEN, TELEGRAM_BOT_USERNAME, SESSION_TTL_HOURS, SESSION_SECURE_COOKIE
.env.template updated accordingly
Migrations 004–010
Users, sessions, foreign key on sites, display_order, update_requests, telegram_id nullability
BREAKING CHANGE
Environment must supply Telegram bot credentials
Database must be migrated; existing “dashboard” auth remains but admin routes are now session‑protected where applicable
|
||
|---|---|---|
| .github/workflows | ||
| cmd/server | ||
| docs | ||
| internal | ||
| migrations | ||
| static | ||
| .air.toml | ||
| .env.template | ||
| .gitguardian.yml | ||
| .gitignore | ||
| .golangci.yml | ||
| Dockerfile | ||
| embedded.go | ||
| go.mod | ||
| go.sum | ||
| Makefile | ||
| 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.envfile) - 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
- Next site:
- Redirect endpoints:
- Visit site:
GET /{slug} - Next site:
GET /{slug}/next - Previous site:
GET /{slug}/prev - Random site:
GET /{slug}/random
- Visit site: