From 71de0a359ab540442bde89862d3f422fec4d500d Mon Sep 17 00:00:00 2001 From: fiftin Date: Sat, 1 Jun 2024 00:11:29 +0200 Subject: [PATCH] docs(examples): add readme --- examples/authentik_ldap/README.md | 28 ++++++++++++++++++++++++++++ examples/openldap/README.md | 5 +++-- 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 examples/authentik_ldap/README.md diff --git a/examples/authentik_ldap/README.md b/examples/authentik_ldap/README.md new file mode 100644 index 00000000..d46d299f --- /dev/null +++ b/examples/authentik_ldap/README.md @@ -0,0 +1,28 @@ +# Semaphore with Authentik LDAP example + + +1. Start stack by command: + ``` + echo "PG_PASS=$(openssl rand 36 | base64)" >> .env + echo "AUTHENTIK_SECRET_KEY=$(openssl rand 60 | base64)" >> .env + docker-compose up -d + ``` +2. Set up LDAP in Athentik according to the video tutorial [Authentik - LDAP Generic Setup](https://youtu.be/RtPKMMKRT_E). +3. Set up Athentik LDAP service: + 1. Copy `AUTHENTIK_TOKEN`. + 2. Stop stack by command: + + ``` + docker-compose down + ``` + 3. Update `AUTHENTIK_TOKEN` for LDAP service. + 4. Start stack again: + ``` + docker-compose up -d + ``` +4. Create new Semaphore project: + 1. Open http://localhost:3000 + 2. Login as `john` + 3. Create demo project + + diff --git a/examples/openldap/README.md b/examples/openldap/README.md index 2502dce2..5b76abcb 100644 --- a/examples/openldap/README.md +++ b/examples/openldap/README.md @@ -1,8 +1,9 @@ # Semaphore with OpenLDAP example 1. Start stack by command: - - ```docker-compose up``` + ``` + docker-compose up -d + ``` 2. Create new LDAP user: 1. Open https://localhost:6443 2. Login as `cn=admin,dc=example,dc=org` with password `admin`