cardkey

The self-service cardkey management system for the hackerspace! It lets people self-serve card activation/deactivation, handles chat announcements for door taps, and eventually strives to have other door-related self-serve features.

Contributors

Prerequisites

• Go
• Docker (and maybe podman, but untested)

To work on specific features, you may also need:

• Door controller (Omni Security) credentials

Getting Started

1. Clone the repository

2. Start the development environment

   docker compose up -d
   

   This will start PostgreSQL and Keycloak services with pre-configured test users and groups.

3. Create your configuration file

   cp cardkey.sample.json cardkey.json
   

   Update any necessary settings in cardkey.json.

4. Run the thing

   go run cmd/cardkey/main.go
   

5. Access:

   • The web app at http://localhost:8080
   • The admin interface at http://localhost:8080/admin (log in with jane)
   • Keycloak at http://localhost:8081

Test Users

• Regular member: john/password
• Member who also is in the admin group: jane/password
• Real Keycloak admin: admin/admin