clonejo / clubstatusd

Keeps the status of your hackerspace (open/closed, presence, upcoming events). This is the backend part available through REST.

Home Page:https://gitlab.aachen.ccc.de/clubstatus

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

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

About

Keeps the status of your hackerspace (open/closed, presence, upcoming events). This is the backend part available through REST.

https://gitlab.aachen.ccc.de/clubstatus

License:Apache License 2.0


Languages

Language:Rust 100.0%