Outline Wiki 自托管安装与配置指南

1. 项目基础介绍和主要编程语言

项目基础介绍

Outline Wiki 是一个开源的团队知识管理工具，旨在帮助团队轻松创建、组织和共享知识。通过 Outline，用户可以创建文档、链接、嵌入多媒体内容，并与其他团队成员协作。

主要编程语言

该项目主要使用 Shell 和 Makefile 进行配置和部署。

2. 项目使用的关键技术和框架

关键技术和框架

• Docker: 用于容器化部署，确保环境一致性。
• Docker Compose: 用于定义和运行多容器 Docker 应用程序。
• OIDC (OpenID Connect): 用于用户身份验证和管理。
• Outline Wiki: 核心的 Wiki 系统。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

1. 安装 Docker 和 Docker Compose:

   • 确保你的系统上已经安装了 Docker 和 Docker Compose。如果没有安装，请参考官方文档进行安装。
   • Docker 安装指南: Docker 官方安装文档
   • Docker Compose 安装指南: Docker Compose 官方安装文档

2. 克隆项目仓库:

   git clone https://github.com/vicalloy/outline-docker-compose.git
   cd outline-docker-compose
   

详细的安装步骤

1. 配置文件设置:

   cp scripts/config.sh.sample scripts/config.sh
   vim scripts/config.sh
   

   • 编辑 scripts/config.sh 文件，根据你的需求更新配置。

2. 生成 Docker Compose 配置文件并启动服务:

   make install
   

   • 该命令会生成 Docker Compose 配置文件并启动服务。

3. 初始化 OIDC 服务器:

   make start
   

   • 该命令会启动 Outline Wiki 服务。

4. 访问 Outline Wiki:

   • 打开浏览器，访问 http://127.0.0.1:8888，登录到 Outline Wiki。
   • 打开 http://127.0.0.1:8888/uc/admin/auth/user/ 添加新用户。

其他操作

• 停止服务:

  make stop
  

• 清理配置文件:

  make clean
  

• 清理数据:

  make clean-data
  

通过以上步骤，你可以成功安装并配置一个自托管的 Outline Wiki 实例。