Skip to content

Commit 9decb08

Browse files
committed
docs
1 parent 090a501 commit 9decb08

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Run a phpLDAPadmin docker image by replacing `ldap.example.com` with your ldap h
1515

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

18-
## Beginner Guide
19-
2018
### OpenLDAP & phpLDAPadmin in 1'
2119

2220
Example script:
@@ -37,6 +35,19 @@ Example script:
3735
echo "Login DN: cn=admin,dc=example,dc=org"
3836
echo "Password: admin"
3937

38+
39+
## Beginner Guide
40+
41+
### Use your own phpLDAPadmin config
42+
This image comes with a phpLDAPadmin config.php file that can be easily customized via environment variables for a quick bootstrap,
43+
but setting your own config.php is possible. 2 options:
44+
45+
- Link your config file at run time to `/container/service/phpldapadmin/assets/config.php` :
46+
47+
docker run -v /data/my-config.php:/container/service/phpldapadmin/assets/config.php --detach osixia:phpldapadmin:0.6.7
48+
49+
- Add your config file by extentending or cloning this image, please refer to the [Advanced User Guide](#advanced-user-guide)
50+
4051
### HTTPS
4152

4253
#### Use autogenerated certificate
@@ -61,6 +72,19 @@ Add --env PHPLDAPADMIN_HTTPS=false to the run command :
6172

6273
docker run --env PHPLDAPADMIN_HTTPS=false --detach osixia/phpldapadmin:0.6.7
6374

75+
### Debug
76+
77+
The container default log level is **info**.
78+
Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.
79+
80+
Example command to run the container in `debug` mode:
81+
82+
docker run --detach osixia/phpldapadmin:0.6.7 --loglevel debug
83+
84+
See all command line options:
85+
86+
docker run osixia/phpldapadmin:0.6.7 --help
87+
6488
## Environment Variables
6589

6690
Environment variables defaults are set in **image/environment/default.yaml**
@@ -169,6 +193,7 @@ Dockerfile example:
169193

170194
ADD https-certs /container/service/phpldapadmin/assets/apache2/certs
171195
ADD ldap-certs /container/service/ldap-client/assets/certs
196+
ADD my-config.php /container/service/phpldapadmin/assets/config.php
172197
ADD environment /container/environment/01-custom
173198

174199

@@ -188,7 +213,7 @@ Adapt Makefile, set your image NAME and VERSION, for example :
188213
NAME = billy-the-king/phpldapadmin
189214
VERSION = 0.1.0
190215

191-
Add your custom certificate and environment files...
216+
Add your custom certificate, environment files, config.php ...
192217

193218
Build your image :
194219

0 commit comments

Comments
 (0)