Nginx LDAP Auth Daemon is a reference implementation of a method for authenticating users who request protected resources from servers proxied by NGINX.
$ docker run --name nginx-ldap-auth-daemon bitnami/nginx-ldap-auth-daemon:latest$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-nginx-ldap-auth-daemon/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d- Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
- With Bitnami images the latest bug fixes and features are available as soon as possible.
- Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
- All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
- All Bitnami images available in Docker Hub are signed with Docker Content Trust (DCT). You can use
DOCKER_CONTENT_TRUST=1to verify the integrity of the images. - Bitnami container images are released daily with the latest distribution packages available.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
Subscribe to project updates by watching the bitnami/nginx-ldap-auth-daemon GitHub repo.
The recommended way to get the Bitnami NGINX LDAP Auth daemon Docker Image is to pull the prebuilt image from the Docker Hub Registry.
$ docker pull bitnami/nginx-ldap-auth-daemon:latestTo use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
$ docker pull bitnami/nginx-ldap-auth-daemon:[TAG]If you wish, you can also build the image yourself.
$ docker build -t bitnami/nginx-ldap-auth-daemon:latest 'https://github.com/bitnami/bitnami-docker-nginx-ldap-auth-daemon.git#master:0/debian-10'Using Docker container networking, a different server running inside a container can easily be accessed by your application containers and vice-versa.
Containers attached to the same network can communicate with each other using the container name as the hostname.
In this example, we will use a nginx http server to serve a example page, and a openldap server to authenticate the users.
$ mkdir app
$ cat << EOF > app/index.html
<html>
<body>
<h1>Hello world!.</h1>
</body>
</html>
EOF$ mkdir conf
$ cat << EOF > conf/ldap_nginx.conf
server {
listen 0.0.0.0:8080;
location = / {
auth_request /auth-proxy;
}
location = /auth-proxy {
internal;
proxy_pass http://nginx-ldap:8888;
# URL and port for connecting to the LDAP server
proxy_set_header X-Ldap-URL "ldap://openldap:1389";
# Base DN
proxy_set_header X-Ldap-BaseDN "dc=example,dc=org";
# Bind DN
proxy_set_header X-Ldap-BindDN "cn=admin,dc=example,dc=org";
# Bind password
proxy_set_header X-Ldap-BindPass "adminpassword";
}
}$ docker network create my-network --driver bridgeUse the --network <NETWORK> argument to the docker run command to attach the container to the my-network network.
$ docker run --detach --rm --name nginx-ldap \
--network my-network \
bitnami/nginx-ldap-auth-daemon:latestUse the --network <NETWORK> argument to the docker run command to attach the container to the my-network network.
$ docker run --detach --rm --name openldap \
--network my-network \
--env LDAP_ADMIN_USERNAME=admin \
--env LDAP_ADMIN_PASSWORD=adminpassword \
--env LDAP_USERS=customuser \
--env LDAP_PASSWORDS=custompassword \
bitnami/openldap:latestUse the --network <NETWORK> argument to the docker run command to attach the container to the my-network network.
$ docker run --detach --rm --name nginx \
--network my-network \
-p 8080:8080 \
-v $PWD/app:/app \
-v $PWD/conf/ldap_nginx.conf:/opt/bitnami/nginx/conf/server_blocks/ldap_nginx.conf \
bitnami/nginx:latestBrowse to http://locahost:8080/ , it will ask for credentials. Introduce customuser / custompassword and you will get the Hello world greetings.
When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named my-network. In this example we assume that you want to connect to the NGINX LDAP auth daemon server from your own custom nginx server which is identified in the following snippet by the service name mynginx.
version: '2'
services:
nginx-ldap:
image: bitnami/nginx-ldap-auth-daemon
ports:
- 8888:8888
nginx:
image: bitnami/nginx
ports:
- 8080:8080
volumes:
- ./app:/app
- ./conf/ldap_nginx.conf:/opt/bitnami/nginx/conf/server_blocks/ldap_nginx.conf
openldap:
image: bitnami/openldap
ports:
- '1389:1389'
- '1636:1636'
environment:
- LDAP_ADMIN_USERNAME=admin
- LDAP_ADMIN_PASSWORD=adminpassword
- LDAP_USERS=customuser
- LDAP_PASSWORDS=custompasswordThe Bitnami Docker NGINX LDAP auth daemon can be easily setup with the following environment variables, these variables will be ignored if a custom server block is mounted defining the corresponding values.
NGINXLDAP_PORT_NUMBER: The port where NGINX LDAP auth daemon is listening for requests. Default: 8888 (non privileged port)NGINXLDAP_LDAP_URI: LDAP URL beginning in the formldap[s]:/<hostname>:<port>. No defaults.NGINXLDAP_LDAP_BASE_DN: LDAP search base DN. No defaults.NGINXLDAP_LDAP_BIND_DN: LDAP bind DN. No defaults.NGINXLDAP_LDAP_BIND_PASSWORD: LDAP bind password. No defaults.NGINXLDAP_LDAP_FILTER: LDAP search filter. Defaults to(cn=%(username)s)NGINXLDAP_HTTP_REALM: HTTP auth realm. Defaults toRestricted.NGINXLDAP_HTTP_COOKIE_NAME: HTTP cookie name. No defaults.
The Bitnami NGINX LDAP auth daemon Docker image sends the container logs to stdout. To view the logs:
$ docker logs nginx-ldap-auth-daemonYou can configure the containers logging driver using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.
Bitnami provides up-to-date versions of NGINX LDAP auth daemon, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
$ docker pull bitnami/nginx-ldap-auth-daemon:latestStop the currently running container using the command
$ docker stop nginx-ldap-auth-daemon$ docker rm -v nginx-ldap-auth-daemonRe-create your container from the new image.
$ docker run --name nginx-ldap-auth-daemon bitnami/nginx-ldap-auth-daemon:latestWe'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:
- Host OS and version
- Docker version (
docker version) - Output of
docker info - Version of this container
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
Copyright (c) 2020 Bitnami
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.