Merge pull request #86 from admisio/docs

Docs

docs/01_setup.md

@@ -0,0 +1,42 @@
+# Spuštění
+
+## Vytvoření docker sítě
+
+```bash
+docker network create -d bridge traefik_proxy
+```
+
+## Traefik
+
+```bash
+docker compose -f docker/traefik/docker-compose.yml up
+```
+
+Traefik běží na portu 80
+
+## Testy
+
+### Přihlášení
+
+Použijte `docker login` se svými přihlašovacími údaji
+
+```bash
+docker login
+```
+
+S GitHub tokenem
+
+```bash
+export CR_PAT=TOKEN_TU
+echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin
+```
+
+### Spuštění
+
+Nakonfigurujte šablonu: `docker/testy/docker-compose.yml` a spusťte ji
+
+```bash
+docker compose -f docker/testy/docker-compose.yml up
+```
+
+ - Migrace se spustí automaticky

docs/02_usersplit.md

@@ -0,0 +1,49 @@
+# Přidání uživatelů
+
+## Vstupní soubory
+
+1. **usersFile**:
+   Tento soubor obsahuje řádky, z nichž každý reprezentuje jednoho uživatele. Každý řádek by měl mít následující informace oddělené mezerou:
+
+    - `skupina`: Název skupiny, ke které bude uživatel patřit.
+    - `admin`: Uživatelské jméno administrátora této skupiny. Pokud administrátor s tímto jménem již existuje v databázi, bude použit. V opačném případě bude vytvořen nový administrátor.
+    - `username`: Uživatelské jméno nově vytvořeného uživatele.
+    - `heslo`: Heslo pro nově vytvořeného uživatele. Hesla jsou předpokládána ve stejném pořadí jako řádky v `passwordsFile`.
+
+2. **passwordsFile**:
+    Tento soubor obsahuje hesla pro administrátory. Hesla musí být na samostatných řádcích.
+
+    Musí zde být minimálně tolik hesel, kolik bude administrátorů
+
+3. **superadminFile**:
+    Tento soubor obsahuje heslo superadmina
+
+
+## Výstupní soubory
+
+1. **admins**
+    Tento soubor obsahuje řádky, z nichž každý reprezentuje jednoho uživatele a jeho heslo.
+
+
+
+## Spuštění
+### Navigace do adresáře se scriptem
+
+```
+cd packages/usersplit/
+```
+
+### Vytvoření .env
+
+Ke spuštění scriptu je potřeba .env s DATABASE_URL proměnnou
+
+```bash
+echo "DATABASE_URL=postgres://REDACTED:REDACTED@localhost:5432/postgres" > .env
+```
+
+### Instalace závislostí a spuštění
+
+```
+pnpm install && pnpm run main -u <Cesta k usersFile> -p <Cesta k passwordsFile> -s <Cesta k superadminFile> -o <Cesta k výstupnímu souboru admins>
+```
+

docs/03_create-test.md

@@ -0,0 +1,15 @@
+# Struktura Markdown souboru pro testy
+
+ - **Název testu:** Uveďte název testu, například: "Test z kybernetické bezpečnosti - Verze A | KB" (zkratka za | představuje obor ze kterého je daný test)
+
+ - **Popis testu:** Popište stručně obsah testu, jeho cíl a témata, která budou testována.
+
+ - **Otázky a odpovědi:** Každá otázka by měla obsahovat následující:
+    - *Číslo otázky:* Uveďte číslo otázky, například: "1."
+    - *Samotná otázka:* Formulujte otázku s dostatečným detaily.
+    - *Možnosti odpovědí:* Uveďte možné odpovědi, označte správnou odpověď. Správnou odpověď označte hvězdičkami *ODPOVĚĎ* (stejně jako kurzíva v markdownu)
+    - Volitelně, můžete vložit obrázky (např. snímky, schémata) pomocí syntaxe ![Popis obrázku](data:image/png;base64, base64 image).
+    - Uveďte vhodný kód nebo ukázky kódu, pokud jsou součástí otázky ohraničený ``` ```
+
+
+## Testy pro rok 2023 byly vytvářeny na základě šablony