infrastructure/nodered_ldap_self_service
2
0
Fork 0
Code Issues 6 Pull Requests Actions Projects Releases 4 Wiki Activity

docs(docker): added script docs

Browse Source 
!3 #4 #5
This commit is contained in:
Jon Lockwood
2023-08-15 16:53:51 +09:30
parent 7824842cec
commit 6c88529a73
3 changed files with 46 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/projects/ldap_self_service/docker.md Normal file
View File

@ -0,0 +1,35 @@
---
title: LDAP Self Service Docker Image
description: How to use No Fuss Computings NodeRED LDAP Self Service Docker Image.
date: 2023-08-15
template: project.html
about: https://gitlab.com/nofusscomputing/projects/nodered_ldap_self_service
---
[This docker image](https://hub.docker.com/r/nofusscomputing/ldap-selfservice) is designed to be behind a reverse-proxy. The proxy will be the service that provides ingress logging and `HTTPS` termination. NodeRED serves the the Self-Service site on `HTTP/80` at the `/` path with `/admin` path available for administering the flows. If when starting the docker container you specify an environmental variable of `NODE_RED_CREDENTIAL_SECRET` it will be used by NodeRED to decrypt your `flows_cred.json` file.
Data for the container is stored in two volumes `/data` and `/usr/src/node-red`. The repo does contain a `flows_cred.json` file, however this is our credential file. It's recommended that you log into the flows admin and set the credentials to your desired values. Export it and as part of the deployment process, mount a read-only copy of your `flows_cred.json` file to path `/data/flows_cred.json` within the container.
!!! danger "Security"
Path `/admin` should not be made publically available, as access to this path grants full access to the backend as well as access to passwords and secrets from your `flows_cred.json` file.
## Docker Hub
!!! info
The docker image is available via `docker pull nofusscomputing/ldap-selfservice` available tags are detailed below
Available tags for the docker image is as follows:
- `dev` The current working head of the repositories `development` branch.
- `{\d}.{\d}.{\d}rc{\d}` The tag on the repositories `development` branch.
- `{\d}.{\d}.{\d}` The tag on the repositories `master` branch. _considered stable_
- `latest` The current working head of the repositories `master` branch. _considered stable_
## Flow Credentials
You can edit these from within the flow administration or use the included scripts and manually edit the `json` file. Within the container these scripts are stored in `/bin` as such can be called from any path. To decrypt `flows_cred,json` use `decrypt-flows-cred.sh /data` (you will be prompted for the decryption password) and this will output a file called `flows_cred.json.tmp` containing the decrypted `flows_cred.json`. to encrypt the temp `flows_cred.json.tmp` back into `flows_cred.json` use command `encrypt-flows-cred.sh /data`, (you will be prompted for the encryption password)

28
docs/projects/ldap_self_service/index.md
View File

@ -35,6 +35,8 @@ General Features:
- Remove expired sessions
- scripts to (en/de)crypt the `flows_cred.json`
## Usage
@ -42,30 +44,8 @@ There are two ways to use this NodeRed flow:
1. Clone to the data directory of your NodeRED insance
1. Use our pre-built docker image
### Docker Image
!!! info
The docker image is available via `docker pull nofusscomputing/ldap-selfservice` available tags are detailed below
Available tags for the docker image is as follows:
- `dev` The current working head of the repositories `development` branch.
- `{\d}.{\d}.{\d}rc{\d}` The tag on the repositories `development` branch.
- `{\d}.{\d}.{\d}` The tag on the repositories `master` branch. _considered stable_
- `latest` The current working head of the repositories `master` branch. _considered stable_
[This docker image](https://hub.docker.com/r/nofusscomputing/ldap-selfservice) is designed to be behind a reverse-proxy. The proxy will be the service that provides ingress logging and `HTTPS` termination. NodeRED serves the the Self-Service site on `HTTP/80` at the `/` path with `/admin` path available for administering the flows. If when starting the docker container you specify an environmental variable of `NODE_RED_CREDENTIAL_SECRET` it will be used by NodeRED to decrypt your `flows_cred.json` file.
Data for the container is stored in two volumes `/data` and `/usr/src/node-red`. The repo does contain a `flows_cred.json` file, however this is our credential file. It's recommended that you log into the flows admin and set the credentials to your desired values. Export it and as part of the deployment process, mount a read-only copy of your `flows_cred.json` file to path `/data/flows_cred.json` within the container.
1. [Use our pre-built docker image](docker.md)
!!! danger "Security"
Path `/admin` should not be made publically available, as access to this path grants full access to the backend as well as access to passwords and secrets from your `flows_cred.json` file.
if you choose your own NodeRED instance to deploy LDAP Self-Service, Care must be taken to ensure that the path the flows admin is on not be publically available, as access to this path grants full access to the backend as well as access to passwords and secrets from your `flows_cred.json` file.

11
mkdocs.yml
View File

@ -9,19 +9,22 @@ edit_uri: '/-/ide/project/nofusscomputing/projects/nodered_ldap_self_service/edi
nav:
- Home: index.md
- Articles:
- Articles:
- articles/index.md
- Projects:
- Projects:
- projects/index.md
- projects/ldap_self_service/index.md
- Operations:
- docker:
- projects/ldap_self_service/docker.md
- Operations:
- operations/index.md
- Contact Us: contact.md