logicaldoc/logicaldoc-ce

LogicalDOC Community Edition (LogicalDOC CE)

!Docker pulls !Docker Stars !License

镜像概述

LogicalDOC Community Edition (简称LogicalDOC CE) 是一个开源文档管理软件平台。它基于主流Java框架构建，结合Google GWT等先进展示技术，打造了灵活且功能强大的文档管理平台，满足高可用性和复杂管理需求。LogicalDOC既是文档管理系统也是协作系统，具备丰富功能，可帮助组织和个人安全地组织、索引、检索、控制和分发重要业务文档。

该镜像需要连接外部数据库才能运行，支持MySQL、MariaDB、PostgreSQL、MS SQL和Oracle等多种数据库管理系统。

!LogicalDOC CE

• SourceForge项目：[***]
• 手册：[***]
• 论坛：[***]

核心功能和特性

• 文档管理与协作：提供文档组织、索引、检索、版本控制、权限管理和分发功能
• Web-based界面：无需安装客户端，通过浏览器即可访问
• 多数据库支持：兼容MySQL、MariaDB、PostgreSQL、MS SQL和Oracle
• 开源免费：100%免费软件，基于LGPL v3许可证
• 灵活配置：支持通过环境变量自定义内存分配、数据库连接等参数
• 数据持久化：可通过Docker卷实现配置和文档数据的持久化存储

使用场景和适用范围

适用于需要高效管理和协作文档的各类组织（企业、团队、机构）和个人，尤其适合：

• 需要集中管理大量电子文档的团队
• 要求文档版本控制和访问权限管理的组织
• 希望通过Web界面实现跨设备、跨地点文档协作的用户
• 需要支持多种数据库环境的灵活部署场景

详细使用方法和配置说明

如何使用本镜像

启动链接到MySQL容器的LogicalDOC实例

1. 启动MySQL容器

Shell
docker run -d --name=mysql-ld -e MYSQL_ROOT_PASSWORD=mypassword -e MYSQL_DATABASE=logicaldoc -e MYSQL_USER=ldoc -e MYSQL_PASSWORD=changeme mysql:8.0 --default-authentication-plugin=mysql_native_password

2. 启动LogicalDOC容器

Shell
docker run -d -p 8080:8080 --link mysql-ld logicaldoc/logicaldoc-ce

本镜像暴露8080端口（LogicalDOC服务端口），默认应用LogicalDOC配置。

之后，通过浏览器访问 http://localhost:8080 或 http://主机IP:8080。默认用户名和密码为 admin / admin。

注意： 在最新版本的MySQL中，需要启用原生认证，否则LogicalDOC无法连接。只需在容器启动命令中添加默认认证插件参数：

Shell
docker run -d --name=mysql-ld -e MYSQL_ROOT_PASSWORD=mypassword -e MYSQL_DATABASE=logicaldoc -e MYSQL_USER=ldoc -e MYSQL_PASSWORD=changeme mysql:8.0.23 --default-authentication-plugin=mysql_native_password

或使用最新MySQL 8镜像：

Shell
docker run -d --name=mysql-ld -e MYSQL_ROOT_PASSWORD=mypassword -e MYSQL_DATABASE=logicaldoc -e MYSQL_USER=ldoc -e MYSQL_PASSWORD=changeme mysql:latest --default-authentication-plugin=mysql_native_password

启动带有自定义设置的LogicalDOC实例

Shell
docker run -d -p 8080:8080 -e LDOC_MEMORY=4000 --link mysql-ld logicaldoc/logicaldoc-ce

此命令将启动与上述相同的镜像，但为LogicalDOC分配4000 MB内存。

若要使用外部数据库而非链接的mysql-ld容器，可通过DB_HOST指定主机名、DB_PORT指定端口，以及DB_USER和DB_PASSWORD指定用户名和密码（若与默认不同）：

console
$ docker run -d -p 8080:8080 -e DB_HOST=10.1.2.3 -e DB_PORT=3306 -e DB_USER=... -e DB_PASSWORD=... logicaldoc/logicaldoc-ce

配置和文档的持久化

以守护进程模式启动并挂载卷以持久化配置和文档：

console
$ docker run -d --name logicaldoc-ce --restart=always -p 8080:8080 -v logicaldoc-conf:/opt/logicaldoc/conf -v logicaldoc-repo:/opt/logicaldoc/repository --link mysql-ld logicaldoc/logicaldoc-ce

所有文档文件将存储在logicaldoc-repo卷中，配置文件存储在logicaldoc-conf卷中。

logicaldoc-conf卷的物理路径为/var/lib/docker/volumes/logicaldoc-conf/_data，logicaldoc-repo卷的物理路径为/var/lib/docker/volumes/logicaldoc-repo/_data。

环境变量

LogicalDOC镜像使用环境变量实现特定配置：

• LDOC_MEMORY：分配给LogicalDOC的内存（MB），默认2000
• DB_ENGINE：数据库类型，可选值：mysql（默认）、mssql、oracle、postgres
• DB_HOST：数据库服务器主机，默认'mysql-ld'
• DB_PORT：数据库通信端口，默认3306
• DB_NAME：数据库名称，默认'logicaldoc'
• DB_INSTANCE：部分数据库需要指定实例
• DB_USER：数据库用户名，默认'ldoc'
• DB_PASSWORD：数据库密码，默认'changeme'
• DB_MANUALURL：使用DB_URL时必须设为true，默认'false'
• DB_URL：数据库JDBC连接URL（需将DB_MANUALURL设为'true'）

使用Oracle或MS SQL作为数据库引擎

在以下地址可找到配置为使用Oracle数据库或MS SQL（Microsoft SQL Server）的容器示例，其中部分示例显式使用DB_URL和DB_MANUALURL属性进行数据库配置： [***]

停止和启动容器

假设已为容器分配别名"logicaldoc-ce"：

• 停止容器：

console
$ docker stop logicaldoc-ce

• 重新启动容器：

console
$ docker start logicaldoc-ce

配置修改

（需先通过卷分配启用数据持久化）

要编辑配置文件，通过以下命令查看logicaldoc-conf卷的物理路径：

console
$ docker volume inspect logicaldoc-conf

输出示例：

console
    [
        {
            "Name": "logicaldoc-conf",
            "Driver": "local",
            "Mountpoint": "/var/lib/docker/volumes/logicaldoc-conf/_data",
            "Labels": null,
            "Scope": "local"
        }
    ]

此时logicaldoc-conf卷的物理路径为/var/lib/docker/volumes/logicaldoc-conf/_data。

执行备份

要备份现有数据，先查看logicaldoc-conf和logicaldoc-repo卷的物理路径：

console
$ docker volume inspect logicaldoc-conf

输出示例：

console
    [
        {
            "Name": "logicaldoc-conf",
            "Driver": "local",
            "Mountpoint": "/var/lib/docker/volumes/logicaldoc-conf/_data",
            "Labels": null,
            "Scope": "local"
        }
    ]

执行备份：

console
$ sudo tar -zcvf backup.tar.gz /var/lib/docker/volumes/logicaldoc-conf/_data /var/lib/docker/volumes/logicaldoc-repo/_data
$ sudo chown `whoami` backup.tar.gz

若使用外部PostgreSQL/MySQL数据库或数据库容器，还需使用其各自的备份方法进行数据库备份。

从备份恢复

将备份归档解压到原始Docker卷：

console
$ sudo tar -xvzf backup.tar.gz -C /

构建镜像

1. 克隆仓库：

console
$ git clone https://github.com/logicaldoc/logicaldoc-ce.git

2. 进入克隆的仓库目录：

console
$ cd logicaldoc-ce

3. 执行Docker构建命令：

console
$ docker build -t logicaldoc/logicaldoc-ce .

或使用APT缓存加速构建：

console
$ docker build -t logicaldoc/logicaldoc-ce --build-arg APT_PROXY=172.18.0.1:3142 .

将IP地址172.18.0.1替换为运行这些命令的Docker主机IP地址。

使用Docker Compose

要使用提供的Docker Compose文件部署完整生产环境：

console
$ docker-compose -f docker-compose.yml up -d

此Docker Compose文件将创建2个容器：

• MySQL作为数据库
• LogicalDOC CE使用上述服务容器

停止栈：

console
$ docker-compose -f docker-compose.yml stop

栈还会创建三个卷来存储每个容器的数据：

• ldoc_conf - LogicalDOC配置卷（不使用Docker Compose时通常名为logicaldoc-conf）
• ldoc_repository - LogicalDOC文档和搜索索引数据卷（不使用Docker Compose时通常名为logicaldoc-repo）
• ldoc_db - 数据库卷（此处为MySQL）

Docker Compose的停止与启动

• 停止服务：

console
$ docker-compose -f docker-compose.yml stop

• 重新启动服务：

console
$ docker-compose -f docker-compose.yml start

• 删除已停止的容器：

console
$ docker-compose -f docker-compose.yml rm -v

• 销毁容器和所有创建的卷：

console
$ docker-compose -f docker-compose.yml down -v

Docker Compose示例

更多docker-compose示例可在GitHub上的容器仓库中找到：https://github.com/logicaldoc/logicaldoc-ce

使用docker stack deploy或docker-compose部署

logicaldoc-ce的示例stack.yml文件：

yaml
version: "3.1"

services:

  logicaldoc:
    depends_on:
      - mysql-ld
    command: ["./wait-for-it.sh", "mysql-ld:3306", "-t", "30", "--", "/opt/logicaldoc/start-logicaldoc.sh", "run"]
    image: logicaldoc/logicaldoc-ce
    ports:
      - 8080:8080
    environment:
      - LDOC_MEMORY=2000

  mysql-ld: 
    image: mysql:8.0
    command: --default-authentication-plugin=mysql_native_password
    environment:
      - MYSQL_ROOT_PASSWORD=example
      - MYSQL_DATABASE=logicaldoc
      - MYSQL_USER=ldoc
      - MYSQL_PASSWORD=changeme

运行 docker stack deploy -c stack.yml logicaldocce，等待完全初始化后，访问 http://swarm-ip:8080、http://localhost:8080 或 http://主机IP:8080（根据实际情况）。

Shell访问

为了调试和维护，可能需要访问容器shell。如果使用Docker 1.3.0或更高版本，可以通过docker exec启动bash访问运行中的容器shell。

假设已为容器分配别名"logicaldoc-ce"：

bash
docker exec -it logicaldoc-ce bash