docs: 更新说明文档

This commit is contained in:
2023-09-25 14:25:47 +08:00
parent c6299b6e83
commit d36efe4c25
+27 -25
View File
@@ -14,11 +14,10 @@
* 镜像地址:
* 阿里云: registry.cn-shenzhen.aliyuncs.com/colovu/openldap:2.5
* Docker Hub: colovu/openldap:2.5
* Colovu Registry: docker.colovu.com/colovu/openldap:2.5
* 依赖镜像:colovu/debian:12
> 后续相关命令行默认使用`[Colovu Registry](https://docker.colovu.com)`镜像服务器做说明
> 后续相关命令行默认使用 Aliyun ACR 镜像服务器做说明
## TL;DR
@@ -26,9 +25,12 @@ Docker 快速启动命令:
```shell
# 从 Registry 服务器下载镜像并启动
$ docker run -it docker.colovu.com/colovu/openldap:2.5 /bin/bash
$ docker run -d --name imgname registry.cn-shenzhen.aliyuncs.com/colovu/openldap:2.5
```
- `registry.cn-shenzhen.aliyuncs.com/colovu/imgname:<TAG>`:镜像名称及版本标签 TAG;标签不指定时默认使用最新版本
Docker-Compose 快速启动命令:
```shell
@@ -53,16 +55,14 @@ $ docker-compose up -d
### 数据卷
镜像默认提供以下数据卷定义,默认数据分别存储在自动生成的应用名对应`openldap`子目录中
镜像默认提供以下数据卷定义:
```shell
/var/datalog # 数据操作日志文件
/srv/conf # 配置文件
/srv/data # 数据文件,主要存放应用数据
/srv/cert # 证书文件存放目录
/var/log # 日志输出
/var/run # 系统运行时文件,如 PID 文件
/srv/openldap/conf # 配置文件
/srv/openldap/data # 数据文件,主要存放应用数据
/srv/openldap/cert # 证书文件存放目录
/srv/openldap/log # 日志输出
/var/run/openldap # 系统运行时文件,如 PID 文件
```
如果需要持久化存储相应数据,需要**在宿主机建立本地目录**,并在使用镜像初始化容器时进行映射。宿主机相关的目录中如果不存在对应应用`openldap`的子目录或相应数据文件,则容器会在初始化时创建相应目录及文件。
@@ -86,13 +86,24 @@ $ docker network create my-network --driver bridge
```shell
$ docker run --detach --rm --name openldap \
--network my-network \
--env LDAP_ROOT=dc=example,dc=org \
--env LDAP_ROOT_PASSWORD=rootpassword \
--env LDAP_BIND_UID=bind \
--env LDAP_BIND_PASSWORD=bindpassword \
--env LDAP_USERS=customuser \
--env LDAP_PASSWORDS=custompassword \
docker.colovu.com/colovu/openldap:2.5
registry.cn-shenzhen.aliyuncs.com/colovu/openldap:2.5
```
则 OpenLDAP 容器初始化完成后,相关配置信息如下:
- RootDNcn=root,dc=example,dc=org
- RootPassword: rootpassword
- BindDN: uid=bind,ou=Manager,dc=example,dc=org
- BindPassword: bindpassword
- UserDN: uid=customuser,ou=Manager,dc=example,dc=org
- UserPassword: custompassword
### 启动 MariaDB Galera 容器
使用之前定义的`my-network`网络初始化 MariaDB Galera 容器:
@@ -109,7 +120,7 @@ $ docker run --detach --rm --name mariadb-galera \
--env LDAP_BASE=dc=example,dc=org \
--env LDAP_BIND_DN=uid=bind,ou=Manager,dc=example,dc=org \
--env LDAP_BIND_PASSWORD=bindpassword \
bitnami/mariadb-galera:2.5
bitnami/mariadb-galera
```
### 启动 MariaDB client 容器验证
@@ -119,7 +130,7 @@ $ docker run --detach --rm --name mariadb-galera \
```shell
$ docker run -it --rm --name mariadb-client \
--network my-network \
bitnami/mariadb-galera:2.5 mysql -h mariadb-galera -u customuser -D customdatabase -pcustompassword
bitnami/mariadb-galera mysql -h mariadb-galera -u customuser -D customdatabase -pcustompassword
```
## 容器配置
@@ -127,7 +138,7 @@ $ docker run -it --rm --name mariadb-client \
在初始化 `OpenLDAP` 容器时,如果没有预置配置文件,可以在命令行中设置相应环境变量对默认参数进行修改。类似命令如下(配置环境变量`APP_ENV_KEY_NAME`的值为`key_value`):
```shell
$ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/openldap
$ docker run -d -e "APP_ENV_KEY_NAME=key_value" registry.cn-shenzhen.aliyuncs.com/openldap:2.5
```
### 常规配置参数
@@ -136,7 +147,7 @@ $ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/openldap
- `LDAP_ROOT`:默认值:**dc=example,dc=org**。设置数据库根 DN
- `LDAP_ORGNIZATION_NAME`:默认值:**Colovu Lab**。设置数据库所属组织名
- `LDAP_ROOT_USERNAME`:默认值:**root**。设置 RootDN 用户名
- `LDAP_ROOT_UID`:默认值:**root**。设置 RootDN 用户名
- `LDAP_ROOT_PASSWORD`:默认值:**rootpassword**。设置 RootDN 用户密码
- `LDAP_BIND_UID`:默认值:**bind**。设置 Binder 用户 UID
- `LDAP_BIND_PASSWORD`:默认值:**bindpassword**。设置 Binder 用户密码
@@ -203,15 +214,6 @@ $ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/openldap
- 2023/8/1 (2.5): 更新版本,基于 OpenLDAP 2.5.16LTS),Debian 12。
## 其他
- Berkeley DB 6http://download.oracle.com/berkeley-db/db-6.2.32.tar.gz
- Berkeley DB 5http://download.oracle.com/berkeley-db/db-5.3.28.tar.gz
- Berkeley DB 4http://download.oracle.com/berkeley-db/db-4.8.30.tar.gz
- LDAP (2.4.59)https://www.openldap.org/software/download/OpenLDAP/openldap-release/openldap-2.4.59.tgz
- LDAP LTS (2.5.16)https://www.openldap.org/software/download/OpenLDAP/openldap-release/openldap-2.5.16.tgz
----
本文原始来源 [Endial Fang](https://github.com/colovu) @ [Github.com](https://github.com)