mirror of
https://github.com/linuxserver/docker-documentation.git
synced 2026-02-19 18:14:15 +08:00
Bot Updating Documentation
This commit is contained in:
LinuxServer-CI
parent
82bb29b380
commit
43fc165b24
@ -1,8 +1,17 @@
|
||||
# linuxserver/ldap-auth
|
||||
# [linuxserver/ldap-auth](https://github.com/linuxserver/docker-ldap-auth)
|
||||
|
||||
[](https://github.com/linuxserver/docker-ldap-auth) [](https://github.com/linuxserver/docker-ldap-auth/releases) [](https://github.com/linuxserver/docker-ldap-auth/packages) [](https://gitlab.com/Linuxserver.io/docker-ldap-auth/container_registry) [](https://quay.io/repository/linuxserver.io/ldap-auth) [](https://microbadger.com/images/linuxserver/ldap-auth) [](https://hub.docker.com/r/linuxserver/ldap-auth) [](https://hub.docker.com/r/linuxserver/ldap-auth) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ldap-auth/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ldap-auth/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-ldap-auth)
|
||||
[](https://github.com/linuxserver/docker-ldap-auth/releases)
|
||||
[](https://github.com/linuxserver/docker-ldap-auth/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-ldap-auth/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/ldap-auth)
|
||||
[](https://microbadger.com/images/linuxserver/ldap-auth "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/ldap-auth)
|
||||
[](https://hub.docker.com/r/linuxserver/ldap-auth)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ldap-auth/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ldap-auth/latest/index.html)
|
||||
|
||||
[Ldap-auth](https://github.com/nginxinc/nginx-ldap-auth) 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\).
|
||||
[Ldap-auth](https://github.com/nginxinc/nginx-ldap-auth) 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).
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
@ -13,18 +22,19 @@ Simply pulling `linuxserver/ldap-auth` should retrieve the correct image for you
|
||||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=ldap-auth \
|
||||
-e TZ=Europe/London \
|
||||
@ -34,6 +44,7 @@ docker create \
|
||||
linuxserver/ldap-auth
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
@ -55,37 +66,41 @@ services:
|
||||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `8888` | the port for ldap auth daemon |
|
||||
| `9000` | the port for ldap login page |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
|
||||
|
||||
|
||||
|
||||
## Application Setup
|
||||
|
||||
* 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.
|
||||
* Here's a sample config: [nginx-ldap-auth.conf](https://github.com/nginxinc/nginx-ldap-auth/blob/master/nginx-ldap-auth.conf).
|
||||
- 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.
|
||||
- Here's a sample config: [nginx-ldap-auth.conf](https://github.com/nginxinc/nginx-ldap-auth/blob/master/nginx-ldap-auth.conf).
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=ldap-auth "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=ldap-auth)
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
@ -109,4 +124,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||
* **18.09.18:** - Update pip
|
||||
* **14.09.18:** - Add TZ parameter, remove unnecessary PUID/PGID params
|
||||
* **11.08.18:** - Initial release.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user