From 875e385f685c2bc4dfe3e196ff9410b47eac139a Mon Sep 17 00:00:00 2001 From: Dariusz Niemczyk Date: Sun, 23 Jul 2023 17:31:46 +0200 Subject: [PATCH] WIP new docs --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a098ef5..cad9d18 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ Please use Python3, for the love of `$deity`... ### Quick start 1. Run: - ```sh - ln -s docker-compose.dev-override.yml docker-compose.override.yml - docker-compose up --build - ``` + ```sh + ln -s docker-compose.dev-override.yml docker-compose.override.yml + docker-compose up --build + ``` 2. Run `docker-compose run --rm web python manage.py createsuperuser` -- now you can dev authenticate w/o SSO ### Build & run @@ -29,3 +29,13 @@ docker-compose build ### Troubleshooting - https://askubuntu.com/q/615394/413683 + +## New docs (WIP): + +Spejstore is a simple inventory system made for Warsaw Hackerspace purposes. Includes some features very specific to hswaw requirements, which are: + +- Label printing and label-system support (via `django-rest-api` api views and `SPEJSTORE_LABEL_API` env variable), using the [spejstore-labelmaker](https://code.hackerspace.pl/informatic/spejstore-labelmaker/) software +- Publically viewing all items and requiring users to sign in view oauth to manage inventory via `django-admin` +- Authorizing label printing via local network only, see `SPEJSTORE_LAN_ALLOWED_ADDRESS_SPACE` env variable + +Currently inventory is deployed under `inventory.waw.hackerspace.pl`, with a [Beyondspace NGINX configuration](https://cs.hackerspace.pl/hscloud/-/blob/hswaw/machines/customs.hackerspace.pl/beyondspace.nix), which allows the inventory to be accessible from outside of the Warsaw Hackerspace network with a necessary oauth authorization, but does not allow printing of labels without physically being in the local network of HSWAW.