</code></pre></div><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)</h3><divclass=highlight><pre><span></span><code>docker<spanclass=w></span>run<spanclass=w></span>-d<spanclass=w></span><spanclass=se>\</span>
</code></pre></div><h2id=parameters>Parameters</h2><p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)</h3><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>8888</code></td><td>the port for ldap auth daemon</td></tr><tr><tdalign=center><code>9000</code></td><td>the port for ldap login page</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)</h3><table><thead><tr><thalign=center>Env</th><th>Function</th></tr></thead><tbody><tr><tdalign=center><code>FERNETKEY=</code></td><td>Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications)</td></tr><tr><tdalign=center><code>CERTFILE=</code></td><td>Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon</td></tr><tr><tdalign=center><code>KEYFILE=</code></td><td>Optionally point this to the private key file, matching the certificate file referred to in CERTFILE</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3><table><thead><tr><thalign=center>Volume</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options</h4><table><thead><tr><thalign=center>Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><divclass=highlight><pre><span></span><code>-e<spanclass=w></span><spanclass=nv>FILE__PASSWORD</span><spanclass=o>=</span>/run/secrets/mysecretpassword
</code></pre></div><p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p><h2id=umask-for-running-applications>Umask for running applications</h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=docker-mods>Docker Mods</h2><p><ahref="https://mods.linuxserver.io/?mod=ldap-auth"title="view available mods for this container."><imgalt="Docker Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=ldap-auth&query=%24.mods%5B%27ldap-auth%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.</p><h2id=support-info>Support Info</h2><ul><li>Shell access whilst the container is running:</li><li><code>docker exec -it ldap-auth /bin/bash</code></li><li>To monitor the logs of the container in realtime:</li><li><code>docker logs -f ldap-auth</code></li><li>Container version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth</code></li><li>Image version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest</code></li></ul><h2id=versions>Versions</h2><ul><li><strong>25.05.23:</strong> - Rebase to Alpine 3.18, deprecate armhf.</li><li><strong>30.12.22:</strong> - Rebase to alpine 3.17.</li><li><strong>19.09.22:</strong> - Rebase to alpine 3.15.</li><li><strong>14.05.21:</strong> - Add linuxserver wheel index.</li><li><strong>12.02.21:</strong> - Clean up cargo/rust cache.</li><li><strong>10.02.21:</strong> - Rebasing to alpine 3.13.</li><li><strong>08.09.20:</strong> - Set form action correctly.</li><li><strong>30.07.20:</strong> - Fix bug related to unset optional <code>CERTFILE</code> and <code>KEYFILE</code> vars.</li><li><strong>27.07.20:</strong> - Add support for HTTP over SSL (HTTPS).</li><li><strong>21.07.20:</strong> - Add support for optional user defined fernet key.</li><li><strong>02.06.20:</strong> - Rebasing to alpine 3.12, serve login page at <code>/ldaplogin</code> as well as <code>/login</code>, to prevent clashes with reverese proxied apps.</li><li><strong>17.05.20:</strong> - Add support for self-signed CA certs.</li><li><strong>20.02.20:</strong> - Switch to python3.</li><li><strong>19.12.19:</strong> - Rebasing to alpine 3.11.</li><li><strong>01.07.19:</strong> - Fall back to base64 encoding when basic http auth is used.</li><li><strong>28.06.19:</strong> - Rebasing to alpine 3.10.</li><li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>22.02.19:</strong> - Rebasing to alpine 3.9.</li><li><strong>18.09.18:</strong> - Update pip</li><li><strong>14.09.18:</strong> - Add TZ parameter, remove unnecessary PUID/PGID params</li><li><strong>11.08.18:</strong> - Initial release.</li></ul></article></div></div></main><footerclass=md-footer><divclass="md-footer
