clubstatusd

Crates.ioclubstatusd
lib.rsclubstatusd
version0.4.1
sourcesrc
created_at2019-08-23 16:17:50.053942
updated_at2022-04-02 01:31:19.043832
descriptionAn HTTP API which allows the folks in your hackerspace to track it's status, with privacy enabled. Features: ternary status (public, private, closed), announcements (who's coming, talks, etc), presence (who's in the space), restricted public API
homepage
repositoryhttps://gitlab.aachen.ccc.de/clubstatus/clubstatusd
max_upload_size
id159228
size5,585,258
Feiko Nanninga (clonejo)

documentation

README

Build status badge Maintenance status badge

Description

Implements a status API for hackerspaces. Most actions require authentication (HTTP Auth with a common password). Also supports announcements (for events or people announcing their future stay) and presence (people currently staying).

What data the daemon tracks and how the API looks is documented in the Specification.

Integrations

  • Publish status and presence changes via MQTT
  • Provide a SpaceAPI 0.13 compatible endpoint at /spaceapi if configured.

Dependencies

Build

Build dependencies: Rust and Cargo

To build, run cargo build --release

Dependency Graph

DAG of dependency crates created using cargo-deps

API examples

Create announcement

jq --null-input '{type: "announcement", method: "new", from: 1610612736, to: 1610612737, note: "2^29 * 3", user: "Hans", public: false}' \
  | curl http://localhost:8000/api/v0 -X PUT --data @- -v
Commit count: 0

cargo fmt