SPSH-127 default developer keycloak and docs (#45)

* copy dev realm

* Add keycloak to compose with default realm

* Auth login service with secret

* Update realm and config

* Update CI

* Pin keycloak version

* Add documentation

* Fix tests

* Fix keycloak-connect config

.github/workflows/reusable_job_nest_test_sonarcloud.yml

@@ -23,7 +23,7 @@ jobs:
           fileName: 'secrets.json'
           fileDir: './config/'
           # These are placeholder secrets without any significance
-          encodedString: ewogICAgIkRCIjogewogICAgICAgICJTRUNSRVQiOiAiVmVyeSBoaWRkZW4gc2VjcmV0IgogICAgfSwKICAgICJLRVlDTE9BSyI6IHsKICAgICAgICAiQURNSU5fU0VDUkVUIjogIkNsaWVudCBTZWNyZXQiCiAgICB9Cn0=
+          encodedString: ewogICAgIkRCIjogewogICAgICAgICJTRUNSRVQiOiAiVmVyeSBoaWRkZW4gc2VjcmV0IgogICAgfSwKICAgICJLRVlDTE9BSyI6IHsKICAgICAgICAiQURNSU5fU0VDUkVUIjogIkFkbWluLUNsaWVudCBTZWNyZXQiLAogICAgICAgICJDTElFTlRfU0VDUkVUIjogIkNsaWVudCBTZWNyZXQiCiAgICB9Cn0=
       - name: Setup node
         uses: actions/setup-node@v3
         with:

README.md

@@ -15,6 +15,7 @@ We have the strategic goal SG-02 "stand-alone system". We want to succeed this g
 1. Run `npm ci` to install all dependencies
 2. Start the required services from the `compose.yaml` file
    * db
+   * keycloak
 3. Create a `.env` file and set the required environment variables from `env.config.ts`
 4. run `npm run setup` to initialize the DB
 5. Run `npm run start:debug` to start the server
@@ -59,6 +60,7 @@ We have the strategic goal SG-02 "stand-alone system". We want to succeed this g
 * Git conventions can be found [here](./docs/git.md)
 * Test conventions can be found [here](./docs/tests.md)
 * Configuration conventions can be found [here](./docs/config.md)
+* Authentication guides can be found [here](./docs/auth.md)
 
 ## Package (Create Docker Image )
 If you push a tag upstream a container will be created for you. (Check Github under Packages)

compose.yaml

@@ -17,3 +17,16 @@ services:
     environment:
       - KEYCLOAK_ADMIN=admin
       - KEYCLOAK_ADMIN_PASSWORD=admin
+  keycloak:
+    image: quay.io/keycloak/keycloak:22.0.3
+    environment:
+      - KEYCLOAK_ADMIN=admin
+      - KEYCLOAK_ADMIN_PASSWORD=admin
+    command:
+      - 'start-dev'
+      - '--import-realm'
+    ports:
+      - 8080:8080
+      - 8443:8443
+    volumes:
+      - ./dev-realm-spsh.json:/opt/keycloak/data/import/realm.json

config/config.dev.json

@@ -12,9 +12,11 @@
     },
     "KEYCLOAK": {
         "BASE_URL": "http://127.0.0.1:8080",
-        "ADMIN_REALM_NAME": "master",
-        "ADMIN_CLIENT_ID": "admin-cli",
-        "REALM_NAME": "schulportal",
-        "CLIENT_ID": "schulportal"
+        "ADMIN_REALM_NAME": "SPSH",
+        "ADMIN_CLIENT_ID": "spsh-admin",
+        "REALM_NAME": "SPSH",
+        "CLIENT_ID": "spsh",
+        "ADMIN_SECRET": "44abDqJk2qgwRbpGfO0VZx7DpXeFsm7R",
+        "CLIENT_SECRET": "YDp6fYkbUcj4ZkyAOnbAHGQ9O72htc5M"
     }
 }

config/config.test.json

@@ -12,9 +12,9 @@
     },
     "KEYCLOAK": {
         "BASE_URL": "http://127.0.0.1:8080",
-        "ADMIN_REALM_NAME": "master",
-        "ADMIN_CLIENT_ID": "admin-cli",
-        "REALM_NAME": "schulportal",
-        "CLIENT_ID": "schulportal"
+        "ADMIN_REALM_NAME": "SPSH",
+        "ADMIN_CLIENT_ID": "spsh-admin",
+        "REALM_NAME": "SPSH",
+        "CLIENT_ID": "spsh"
     }
 }