Skip to content

Commit af56bc7

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent 6f53691 commit af56bc7

File tree

1 file changed

+76
-36
lines changed

1 file changed

+76
-36
lines changed

‎readme-vars.yml

Lines changed: 76 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,97 @@ project_url: "https://github.com/nginxinc/nginx-ldap-auth"
66
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/ldap-auth-logo.png"
77
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012)."
88
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
9-
109
# supported architectures
1110
available_architectures:
12-
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
13-
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
14-
11+
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
12+
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
1513
# container parameters
1614
param_usage_include_ports: true
1715
param_container_name: "{{ project_name }}"
1816
param_ports:
19-
- { external_port: "8888", internal_port: "8888", port_desc: "the port for ldap auth daemon" }
20-
- { external_port: "9000", internal_port: "9000", port_desc: "the port for ldap login page" }
21-
17+
- {external_port: "8888", internal_port: "8888", port_desc: "the port for ldap auth daemon"}
18+
- {external_port: "9000", internal_port: "9000", port_desc: "the port for ldap login page"}
2219
# optional container parameters
2320
opt_param_usage_include_env: true
2421
opt_param_env_vars:
25-
- { env_var: "FERNETKEY", env_value: "", desc: "Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications)" }
26-
- { env_var: "CERTFILE", env_value: "", desc: "Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon" }
27-
- { env_var: "KEYFILE", env_value: "", desc: "Optionally point this to the private key file, matching the certificate file referred to in CERTFILE" }
28-
22+
- {env_var: "FERNETKEY", env_value: "", desc: "Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications)"}
23+
- {env_var: "CERTFILE", env_value: "", desc: "Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon"}
24+
- {env_var: "KEYFILE", env_value: "", desc: "Optionally point this to the private key file, matching the certificate file referred to in CERTFILE"}
2925
# application setup block
3026
app_setup_block_enabled: true
3127
app_setup_block: |
3228
- This container itself does not have any settings and it relies on the pertinent information passed through in http headers of incoming requests. Make sure that your webserver is set up with the right config.
3329
- Here's a sample config: [nginx-ldap-auth.conf](https://github.com/nginxinc/nginx-ldap-auth/blob/master/nginx-ldap-auth.conf).
3430
- Unlike the upstream project, this image encodes the cookie information with fernet, using a randomly generated key during container creation (or optionally user defined).
3531
- Also unlike the upstream project, this image serves the login page at `/ldaplogin` (as well as `/login`) to prevent clashes with reverse proxied apps that may also use `/login` for their internal auth.
36-
32+
# init diagram
33+
init_diagram: |
34+
"ldap-auth:latest": {
35+
docker-mods
36+
base {
37+
fix-attr +\nlegacy cont-init
38+
}
39+
docker-mods -> base
40+
legacy-services
41+
custom services
42+
init-services -> legacy-services
43+
init-services -> custom services
44+
custom services -> legacy-services
45+
legacy-services -> ci-service-check
46+
init-migrations -> init-adduser
47+
init-os-end -> init-config
48+
init-config -> init-config-end
49+
init-ldap-config -> init-config-end
50+
init-os-end -> init-crontab-config
51+
init-mods-end -> init-custom-files
52+
base -> init-envfile
53+
init-config -> init-ldap-config
54+
base -> init-migrations
55+
base -> init-mods
56+
init-config-end -> init-mods
57+
init-mods -> init-mods-end
58+
init-mods-package-install -> init-mods-end
59+
init-mods -> init-mods-package-install
60+
base -> init-os-end
61+
init-adduser -> init-os-end
62+
init-envfile -> init-os-end
63+
init-migrations -> init-os-end
64+
init-custom-files -> init-services
65+
init-mods-end -> init-services
66+
init-services -> svc-cron
67+
svc-cron -> legacy-services
68+
init-services -> svc-ldap-app
69+
svc-ldap-app -> legacy-services
70+
init-services -> svc-ldap-daemon
71+
svc-ldap-daemon -> legacy-services
72+
}
73+
Base Images: {
74+
"baseimage-alpine:3.20"
75+
}
76+
"ldap-auth:latest" <- Base Images
3777
# changelog
3878
changelogs:
39-
- { date: "30.06.24:", desc: "Rebase to Alpine 3.20."}
40-
- { date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
41-
- { date: "20.06.23:", desc: "Sync upstream changes, including the ability to disable referrals with `X-Ldap-DisableReferrals`." }
42-
- { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
43-
- { date: "30.12.22:", desc: "Rebase to alpine 3.17." }
44-
- { date: "19.09.22:", desc: "Rebase to alpine 3.15." }
45-
- { date: "14.05.21:", desc: "Add linuxserver wheel index." }
46-
- { date: "12.02.21:", desc: "Clean up cargo/rust cache." }
47-
- { date: "10.02.21:", desc: "Rebasing to alpine 3.13." }
48-
- { date: "08.09.20:", desc: "Set form action correctly." }
49-
- { date: "30.07.20:", desc: "Fix bug related to unset optional `CERTFILE` and `KEYFILE` vars." }
50-
- { date: "27.07.20:", desc: "Add support for HTTP over SSL (HTTPS)." }
51-
- { date: "21.07.20:", desc: "Add support for optional user defined fernet key." }
52-
- { date: "02.06.20:", desc: "Rebasing to alpine 3.12, serve login page at `/ldaplogin` as well as `/login`, to prevent clashes with reverese proxied apps." }
53-
- { date: "17.05.20:", desc: "Add support for self-signed CA certs." }
54-
- { date: "20.02.20:", desc: "Switch to python3." }
55-
- { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
56-
- { date: "01.07.19:", desc: "Fall back to base64 encoding when basic http auth is used." }
57-
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
58-
- { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
59-
- { date: "22.02.19:", desc: "Rebasing to alpine 3.9." }
60-
- { date: "18.09.18:", desc: "Update pip" }
61-
- { date: "14.09.18:", desc: "Add TZ parameter, remove unnecessary PUID/PGID params" }
62-
- { date: "11.08.18:", desc: "Initial release." }
79+
- {date: "30.06.24:", desc: "Rebase to Alpine 3.20."}
80+
- {date: "23.12.23:", desc: "Rebase to Alpine 3.19."}
81+
- {date: "20.06.23:", desc: "Sync upstream changes, including the ability to disable referrals with `X-Ldap-DisableReferrals`."}
82+
- {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
83+
- {date: "30.12.22:", desc: "Rebase to alpine 3.17."}
84+
- {date: "19.09.22:", desc: "Rebase to alpine 3.15."}
85+
- {date: "14.05.21:", desc: "Add linuxserver wheel index."}
86+
- {date: "12.02.21:", desc: "Clean up cargo/rust cache."}
87+
- {date: "10.02.21:", desc: "Rebasing to alpine 3.13."}
88+
- {date: "08.09.20:", desc: "Set form action correctly."}
89+
- {date: "30.07.20:", desc: "Fix bug related to unset optional `CERTFILE` and `KEYFILE` vars."}
90+
- {date: "27.07.20:", desc: "Add support for HTTP over SSL (HTTPS)."}
91+
- {date: "21.07.20:", desc: "Add support for optional user defined fernet key."}
92+
- {date: "02.06.20:", desc: "Rebasing to alpine 3.12, serve login page at `/ldaplogin` as well as `/login`, to prevent clashes with reverese proxied apps."}
93+
- {date: "17.05.20:", desc: "Add support for self-signed CA certs."}
94+
- {date: "20.02.20:", desc: "Switch to python3."}
95+
- {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
96+
- {date: "01.07.19:", desc: "Fall back to base64 encoding when basic http auth is used."}
97+
- {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
98+
- {date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
99+
- {date: "22.02.19:", desc: "Rebasing to alpine 3.9."}
100+
- {date: "18.09.18:", desc: "Update pip"}
101+
- {date: "14.09.18:", desc: "Add TZ parameter, remove unnecessary PUID/PGID params"}
102+
- {date: "11.08.18:", desc: "Initial release."}

0 commit comments

Comments
 (0)