Skip to content

Commit

Permalink
Merge branch 'hotfix-0.7.2' into stable
Browse files Browse the repository at this point in the history
  • Loading branch information
BertrandGouny committed Sep 4, 2018
2 parents 887d2b6 + 1bdf477 commit 96fb8ee
Show file tree
Hide file tree
Showing 6 changed files with 162 additions and 91 deletions.
117 changes: 85 additions & 32 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,113 @@
# Changelog
All notable changes to this project will be documented in this file.

## 0.7.1
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.7.2] - 2018-09-04
### Added
- Ability to sepcifiy different values for ldap 'host' and 'name' #46

## [0.7.1] - 2017-12-05
### Added
- Opcache config

### Changed
- Optimise apache config
- Add opcache config
- Upgrade baseimage: web-baseimage:1.1.1
- Upgrade baseimage to web-baseimage:1.1.1

## 0.7.0
## [0.7.0] - 2017-07-19
### Added
- add config.php in config folder
- Upgrade baseimage: web-baseimage:1.1.0 (debian stretch, php7)

## 0.6.12
### Changed
- Upgrade baseimage to web-baseimage:1.1.0 (debian stretch, php7)

## [0.6.12] - 2017-03-27
### Changed
- Upgrade baseimage to web-baseimage:1.0.0

### Fixed
- Fixes Parse error: syntax error, unexpected '}' in config.php on line 68 #23
- Upgrade baseimage: web-baseimage:1.0.0

## 0.6.11
- Upgrade baseimage: web-baseimage:0.1.10
## [0.6.11] - 2016-09-02
### Changed
- Upgrade baseimage to web-baseimage:0.1.10

## 0.6.10
## [0.6.10] - 2016-07-26
### Added
- Add PHPLDAPADMIN_SERVER_PATH environment variable

## 0.6.9
- Upgrade baseimage: web-baseimage:0.1.10
## [0.6.9] - 2016-06-09
### Changed
- Upgrade baseimage to web-baseimage:0.1.10

## 0.6.8
- Upgrade baseimage: web-baseimage:0.1.9
## [0.6.8] - 2016-02-20
### Changed
- Upgrade baseimage to web-baseimage:0.1.9

## 0.6.7
- Upgrade baseimage: web-baseimage:0.1.8
## [0.6.7] - 2016-01-25
### Changed
- Upgrade baseimage to web-baseimage:0.1.8

## 0.6.6
- Upgrade baseimage: web-baseimage:0.1.7
## [0.6.6] - 2015-12-16
### Added
- Makefile with build no cache

## 0.6.5
- Upgrade baseimage: web-baseimage:0.1.6
### Changed
- Upgrade baseimage to web-baseimage:0.1.7

## 0.6.4
- Upgrade baseimage: web-baseimage:0.1.5
- Remove listen on http when https is enable
## [0.6.5] - 2015-11-20
### Changed
- Upgrade baseimage to web-baseimage:0.1.6

## [0.6.4] - 2015-11-19
### Changed
- Upgrade baseimage to web-baseimage:0.1.5
- externalise ldap-client config from phpLdapAdmin

## 0.6.3
- Upgrade baseimage: web-baseimage:0.1.3
### Removed
- Remove listen on http when https is enable

## [0.6.3] - 2015-10-26
### Changed
- Upgrade baseimage to web-baseimage:0.1.3

## 0.6.2
## [0.6.2] - 2015-08-21
### Changed
- Better way to add custom config

## 0.6.1
- Upgrade baseimage: web-baseimage:0.1.1
## [0.6.1] - 2015-08-20
### Changed
- Upgrade baseimage to web-baseimage:0.1.1
- Rename environment variables

## 0.6.0
## [0.6.0] - 2015-07-24
### Changed
- Use new baseimage: light-baseimage

## 0.5.1
## [0.5.1] - 2015-05-17
### Fixed
- Fix #1 (can't activate SSL with own certificates)

## 0.5.0
- New version initial release
## [0.5.0] - 2015-03-03
New version initial release, no changelog before this sorry.

[0.7.2]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.7.1...v0.7.2
[0.7.1]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.7.0...v0.7.1
[0.7.0]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.12...v0.7.0
[0.6.12]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.11...v0.6.12
[0.6.11]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.10...v0.6.11
[0.6.10]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.9...v0.6.10
[0.6.9]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.8...v0.6.9
[0.6.8]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.7...v0.6.8
[0.6.7]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.6...v0.6.7
[0.6.6]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.5...v0.6.6
[0.6.5]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.4...v0.6.5
[0.6.4]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.3...v0.6.4
[0.6.3]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.2...v0.6.3
[0.6.2]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.1...v0.6.2
[0.6.1]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.6.0...v0.6.1
[0.6.0]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.5.1...v0.6.0
[0.5.1]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.5.0...v0.5.1
[0.5.0]: https://github.com/osixia/docker-phpLDAPadmin/compare/v0.1.0...v0.5.0
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
NAME = osixia/phpldapadmin
VERSION = 0.7.1
VERSION = 0.7.2

.PHONY: build build-nocache test tag-latest push push-latest release git-tag-version

Expand Down
93 changes: 55 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,43 @@

[hub]: https://hub.docker.com/r/osixia/phpldapadmin/

Latest release: 0.7.1 - phpLDAPadmin 1.2.3 (with php7 patch) - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/phpldapadmin/) 
Latest release: 0.7.2 - phpLDAPadmin 1.2.3 (with php7 patch) - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/phpldapadmin/) 

**A docker image to run phpLDAPadmin.**
> [phpldapadmin.sourceforge.net](http://phpldapadmin.sourceforge.net)
- [Quick start](#quick-start)
- [OpenLDAP & phpLDAPadmin in 1'](#openldap--phpldapadmin-in-1)
- [Beginner Guide](#beginner-guide)
- [Use your own phpLDAPadmin config](#use-your-own-phpldapadmin-config)
- [HTTPS](#https)
- [Use autogenerated certificate](#use-autogenerated-certificate)
- [Use your own certificate](#use-your-own-certificate)
- [Disable HTTPS](#disable-https)
- [Fix docker mounted file problems](#fix-docker-mounted-file-problems)
- [Debug](#debug)
- [Environment Variables](#environment-variables)
- [Set your own environment variables](#set-your-own-environment-variables)
- [Use command line argument](#use-command-line-argument)
- [Link environment file](#link-environment-file)
- [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)
- [Advanced User Guide](#advanced-user-guide)
- [Extend osixia/phpldapadmin:0.7.1 image](#extend-osixiaphpldapadmin070-image)
- [Make your own phpLDAPadmin image](#make-your-own-phpldapadmin-image)
- [Tests](#tests)
- [Kubernetes](#kubernetes)
- [Under the hood: osixia/web-baseimage](#under-the-hood-osixiaweb-baseimage)
- [Changelog](#changelog)
- [osixia/phpldapadmin](#osixiaphpldapadmin)
- [Quick start](#quick-start)
- [OpenLDAP & phpLDAPadmin in 1'](#openldap--phpldapadmin-in-1)
- [Beginner Guide](#beginner-guide)
- [Use your own phpLDAPadmin config](#use-your-own-phpldapadmin-config)
- [HTTPS](#https)
- [Use autogenerated certificate](#use-autogenerated-certificate)
- [Use your own certificate](#use-your-own-certificate)
- [Disable HTTPS](#disable-https)
- [Fix docker mounted file problems](#fix-docker-mounted-file-problems)
- [Debug](#debug)
- [Environment Variables](#environment-variables)
- [Set your own environment variables](#set-your-own-environment-variables)
- [Use command line argument](#use-command-line-argument)
- [Link environment file](#link-environment-file)
- [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)
- [Advanced User Guide](#advanced-user-guide)
- [Extend osixia/phpldapadmin:0.7.2 image](#extend-osixiaphpldapadmin072-image)
- [Make your own phpLDAPadmin image](#make-your-own-phpldapadmin-image)
- [Tests](#tests)
- [Kubernetes](#kubernetes)
- [Under the hood: osixia/web-baseimage](#under-the-hood-osixiaweb-baseimage)
- [Security](#security)
- [Changelog](#changelog)

## Quick start

Run a phpLDAPadmin docker image by replacing `ldap.example.com` with your ldap host or IP :

docker run -p 6443:443 \
--env PHPLDAPADMIN_LDAP_HOSTS=ldap.example.com \
--detach osixia/phpldapadmin:0.7.1
--env PHPLDAPADMIN_LDAP_HOSTS=ldap.example.com \
--detach osixia/phpldapadmin:0.7.2

That's it :) you can access phpLDAPadmin on [https://localhost:6443](https://localhost:6443)

Expand All @@ -49,7 +51,7 @@ Example script:

#!/bin/bash -e
docker run --name ldap-service --hostname ldap-service --detach osixia/openldap:1.1.8
docker run --name phpldapadmin-service --hostname phpldapadmin-service --link ldap-service:ldap-host --env PHPLDAPADMIN_LDAP_HOSTS=ldap-host --detach osixia/phpldapadmin:0.7.1
docker run --name phpldapadmin-service --hostname phpldapadmin-service --link ldap-service:ldap-host --env PHPLDAPADMIN_LDAP_HOSTS=ldap-host --detach osixia/phpldapadmin:0.7.2

PHPLDAP_IP=$(docker inspect -f "{{ .NetworkSettings.IPAddress }}" phpldapadmin-service)

Expand All @@ -66,7 +68,7 @@ but setting your own config.php is possible. 2 options:

- Link your config file at run time to `/container/service/phpldapadmin/assets/config/config.php` :

docker run --volume /data/my-config.php:/container/service/phpldapadmin/assets/config/config.php --detach osixia/phpldapadmin:0.7.1
docker run --volume /data/my-config.php:/container/service/phpldapadmin/assets/config/config.php --detach osixia/phpldapadmin:0.7.2

- Add your config file by extending or cloning this image, please refer to the [Advanced User Guide](#advanced-user-guide)

Expand All @@ -75,7 +77,7 @@ but setting your own config.php is possible. 2 options:
#### Use autogenerated certificate
By default HTTPS is enable, a certificate is created with the container hostname (it can be set by docker run --hostname option eg: phpldapadmin.my-company.com).

docker run --hostname phpldapadmin.my-company.com --detach osixia/phpldapadmin:0.7.1
docker run --hostname phpldapadmin.my-company.com --detach osixia/phpldapadmin:0.7.2

#### Use your own certificate

Expand All @@ -85,22 +87,22 @@ You can set your custom certificate at run time, by mounting a directory contain
--env PHPLDAPADMIN_HTTPS_CRT_FILENAME=my-cert.crt \
--env PHPLDAPADMIN_HTTPS_KEY_FILENAME=my-cert.key \
--env PHPLDAPADMIN_HTTPS_CA_CRT_FILENAME=the-ca.crt \
--detach osixia/phpldapadmin:0.7.1
--detach osixia/phpldapadmin:0.7.2

Other solutions are available please refer to the [Advanced User Guide](#advanced-user-guide)

#### Disable HTTPS
Add --env PHPLDAPADMIN_HTTPS=false to the run command :

docker run --env PHPLDAPADMIN_HTTPS=false --detach osixia/phpldapadmin:0.7.1
docker run --env PHPLDAPADMIN_HTTPS=false --detach osixia/phpldapadmin:0.7.2

### Fix docker mounted file problems

You may have some problems with mounted files on some systems. The startup script try to make some file adjustment and fix files owner and permissions, this can result in multiple errors. See [Docker documentation](https://docs.docker.com/v1.4/userguide/dockervolumes/#mount-a-host-file-as-a-data-volume).

To fix that run the container with `--copy-service` argument :

docker run [your options] osixia/phpldapadmin:0.7.1 --copy-service
docker run [your options] osixia/phpldapadmin:0.7.2 --copy-service

### Debug

Expand All @@ -109,11 +111,11 @@ Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.

Example command to run the container in `debug` mode:

docker run --detach osixia/phpldapadmin:0.7.1 --loglevel debug
docker run --detach osixia/phpldapadmin:0.7.2 --loglevel debug

See all command line options:

docker run osixia/phpldapadmin:0.7.1 --help
docker run osixia/phpldapadmin:0.7.2 --help

## Environment Variables

Expand Down Expand Up @@ -166,10 +168,20 @@ See how to [set your own environment variables](#set-your-own-environment-variab

If you want to set this variable at docker run command add the tag `#PYTHON2BASH:` and convert the yaml in python:

docker run --env PHPLDAPADMIN_LDAP_HOSTS="#PYTHON2BASH:[{'ldap.example.org': [{'server': [{'tls': True}]},{'login': [{'bind_id': 'cn=admin,dc=example,dc=org'}]}]}, 'ldap2.example.org', 'ldap3.example.org']" --detach osixia/phpldapadmin:0.7.1
docker run --env PHPLDAPADMIN_LDAP_HOSTS="#PYTHON2BASH:[{'ldap.example.org': [{'server': [{'tls': True}]},{'login': [{'bind_id': 'cn=admin,dc=example,dc=org'}]}]}, 'ldap2.example.org', 'ldap3.example.org']" --detach osixia/phpldapadmin:0.7.2

To convert yaml to python online: http://yaml-online-parser.appspot.com/

If you would like to skip the display name == hostname element of the above use the **PHPLDAPADMIN_LDAP_HOSTS_FRIENDLY** environmental variable. This then uses the top most name as the display name of the server. You will then need to add host to the yaml within the server section. Note this is a global setting, if you do it for one server, you must do it for all. eg
```yaml
- Primary:
- server:
- host: ldap-master.example.org
- Backup:
- server:
- host: 192.168.0.100
```

Apache :
- **PHPLDAPADMIN_SERVER_ADMIN**: Server admin email. Defaults to `webmaster@example.org`
- **PHPLDAPADMIN_SERVER_PATH**: Server path (usefull if behind a reverse proxy). Defaults to `/phpldapadmin`
Expand Down Expand Up @@ -203,14 +215,14 @@ Other environment variables:
Environment variables can be set by adding the --env argument in the command line, for example:

docker run --env PHPLDAPADMIN_LDAP_HOSTS="ldap.example.org" \
--detach osixia/phpldapadmin:0.7.1
--detach osixia/phpldapadmin:0.7.2

#### Link environment file

For example if your environment file is in : /data/environment/my-env.yaml

docker run --volume /data/environment/my-env.yaml:/container/environment/01-custom/env.yaml \
--detach osixia/phpldapadmin:0.7.1
--detach osixia/phpldapadmin:0.7.2

Take care to link your environment file to `/container/environment/XX-somedir` (with XX < 99 so they will be processed before default environment files) and not directly to `/container/environment` because this directory contains predefined baseimage environment files to fix container environment (INITRD, LANG, LANGUAGE and LC_CTYPE).

Expand All @@ -220,13 +232,13 @@ This is the best solution if you have a private registry. Please refer to the [A

## Advanced User Guide

### Extend osixia/phpldapadmin:0.7.1 image
### Extend osixia/phpldapadmin:0.7.2 image

If you need to add your custom TLS certificate, bootstrap config or environment files the easiest way is to extends this image.

Dockerfile example:

FROM osixia/phpldapadmin:0.7.1
FROM osixia/phpldapadmin:0.7.2
MAINTAINER Your Name <your@name.com>

ADD https-certs /container/service/phpldapadmin/assets/apache2/certs
Expand Down Expand Up @@ -289,6 +301,11 @@ A kubernetes example is available in **example/kubernetes**
This image is based on osixia/web-baseimage.
More info: https://github.com/osixia/docker-web-baseimage

## Security
If you discover a security vulnerability within this docker image, please send an email to the Osixia! team at security@osixia.net. For minor vulnerabilities feel free to add an issue here on github.

Please include as many details as possible.

## Changelog

Please refer to: [CHANGELOG.md](CHANGELOG.md)
2 changes: 1 addition & 1 deletion example/kubernetes/phpldapadmin-rc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ spec:
spec:
containers:
- name: phpldapadmin
image: osixia/phpldapadmin:0.7.1
image: osixia/phpldapadmin:0.7.2
volumeMounts:
- name: phpldapadmin-certs
mountPath: /container/service/phpldapadmin/assets/apache2/certs
Expand Down
Loading

0 comments on commit 96fb8ee

Please sign in to comment.