Files
2026-06-02 23:28:41 +02:00

2.0 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.

Mobile App

The mobile app (Expo/React Native) source code is now in the separate bincio_autarchive repository. See:

  • Mobile App Design — Architecture, Pyodide extraction, Karoo integration, sync protocol (reference documentation)
  • bincio_autarchive/DEVELOPMENT.md — Build & development instructions

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