Files
bincio-activity/docs/index.md
T
Davide Scaini 395182649b improve docs
2026-04-15 23:07:52 +02:00

1.7 KiB

BincioActivity Documentation

Welcome to BincioActivity — a federated, self-hosted activity stats platform. This documentation is organized by audience:

For Users

Getting Started — Extract your activities from Strava/Garmin, set up a local site, and deploy it.

User Guide — Upload activities, sync from Strava, edit titles/descriptions, manage photos, control privacy, configure your profile.

For Administrators

Admin Guide — Deploy a multi-user instance, manage users, reset passwords, monitor rebuild status.

Multi-user Deployment — Step-by-step setup with nginx, systemd, and multi-user architecture.

Single-user Deployment — Deploy as a read-only static site or with a local edit server.

For Developers

Developer Guide — Local setup, how to run tests, architecture overview, how to contribute.

Architecture — BAS data format, shard model, federation protocol, federation design.

API Reference — HTTP endpoints, request/response formats, authentication, rate limits.

CLI Reference — All bincio commands and options.


Status: This is early-stage, self-hosted software. See the GitHub repo for known issues and planned features.