几分钟内使用 Wiki.js 设置您自己的 Wiki 的快速指南

几分钟内使用 Wiki.js 设置您自己的 Wiki 的快速指南

Wiki.js 是一款基于 Node.js 框架设计的功能丰富的开源 Wiki 应用。它提供丰富的编辑体验,支持 Markdown 和所见即所得 (WYSIWYG) 界面。此外,它还支持实时协作、版本控制以及多种身份验证方法,包括 Google 和 LDAP 集成。本指南将引导您完成使用 Docker 设置 Wiki.js 的必要步骤,让您只需几分钟即可部署自己的 Wiki。

通过 Docker Compose 设置 Wiki.js

使用 Docker 和 Docker Compose 设置 Wiki.js 的过程非常简单。首先创建一个名为 的新目录wikijs-docker并导航到该目录:

mkdir wikijs-docker && cd wikijs-docker

docker-compose.yml接下来,使用您喜欢的文本编辑器创建一个名为的文件:

nano docker-compose.yml

然后,将以下配置插入到文件中:

services: db: image: postgres:16 environment: POSTGRES_DB: wiki POSTGRES_PASSWORD: wikijsrocks POSTGRES_USER: wikijs restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data wiki: image: ghcr.io/requarks/wiki:2 depends_on: - db environment: DB_TYPE: postgres DB_HOST: db DB_PORT: 5432 DB_USER: wikijs DB_PASS: wikijsrocks DB_NAME: wiki restart: unless-stopped ports: - "80:3000" volumes: db-data:

保存并关闭文件后,通过执行以下命令启动容器:

docker compose up -d

运行 Docker 容器

安装过程完成后,在 Web 浏览器中导航至http://localhost。在这里,您需要提供管理员帐户详细信息,然后选择“安装”按钮开始安装:

开始安装 Wiki.js

完成安装后,使用您的凭据登录。

在 Wiki.js 中创建和管理页面

初始设置完成后,您可以建立主页以开始填充内容或访问管理面板来管理设置、用户和可用功能:

欢迎页面 Wiki.js

通过单击“创建主页”选项,系统将提示您选择适合您偏好的编辑器:

选择编辑器

接下来,定义页面的属性并点击“确定”按钮继续创建新页面:

设置页面属性

编写您想要的内容并单击“创建”按钮以完成页面创建:

创建页面 Wiki.js

管理和组织内容

您的仪表盘提供了一种便捷的方式,让您可以查看和修改现有页面,以及使用您选择的编辑器创建新页面。您可以通过重命名、移动或删除页面来组织内容,并使用标签进行有效分类。此外,侧边栏和搜索功能可以加快您 wiki 中特定页面的导航速度:

Wiki.js 仪表板

配置 Wiki.js 站点设置

在 Wiki.js 管理面板中,您可以灵活地配置站点设置,例如语言环境、导航结构、主题和标签。这些设置在定义 Wiki.js 实例的整体配置中起着至关重要的作用。

在“常规”选项卡下,您可以调整基本站点设置,包括站点标题、描述、默认主页和可见性设置(公开或私人):

常规设置

切换到“区域设置”选项卡以指定站点的默认语言、时区和日期/时间格式:

设置区域

要管理您的 wiki 的菜单结构并增强用户导航,请访问导航栏部分:

管理网站导航

“页面”选项卡中,您可以监督、编辑和组织所有 wiki 页面、创建新页面以及管理内容的层次结构:

管理页面

此外,在“标签”选项卡下,您可以创建和管理内容标签,从而增强页面的可搜索性。您还可以通过“主题”选项卡自定义wiki的美观元素,例如更改站点徽标、颜色、字体和布局样式。

管理主题

管理 Wiki 中的群组

“群组”部分允许您创建用户群组、指定成员并设置群组级别的权限来规范访问权限。这种组织方法有助于简化用户角色,并在整个 Wiki 中保持一致的访问权限管理。

团体

点击特定群组即可访问该群组的设置、权限、页面规则以及用户管理。通过“设置”选项卡,您可以调整选项,包括登录重定向 URL。

编辑群组设置

您还可以浏览“权限”“页面规则”“用户”部分,以优化组可以访问的内容并相应地分配用户。

Wiki.js 中的用户管理

要添加新用户,请转到“用户”部分,单击“新用户”按钮,然后填写必填字段。

完成后,选择“创建”“创建并关闭”以完成新用户设置:

创建用户

选择特定用户允许您查看和编辑他们的个人资料,分配用户组,定义身份验证方法(如密码或双因素身份验证),以及使用诸如停用验证删除之类的操作管理他们的状态:

用户创建

此外,您还可以更新他们的基本信息、扩展元数据(包括位置和职位),并查看他们的活动历史记录:

编辑用户

管理您的 Wiki 模块

模块是增强 Wiki.js 功能的增强功能。例如,Analytics模块允许您集成 Google Analytics 等工具来跟踪用户参与度和流量指标:

添加分析

利用“身份验证”选项卡建立和管理身份验证提供程序(本地登录、LDAP、OAuth)以及配置各种登录选项:

配置身份验证设置

您还可以打开或关闭评论系统并确定用户如何参与页面讨论:

将讨论添加到 Wiki

系统配置

通过配置渲染引擎、搜索索引和存储设置,管理内容的渲染、搜索索引和存储方式。例如,访问“渲染”选项卡来定制内容渲染,例如调整 Markdown 引擎设置或启用对图表和数学表达式的支持:

配置页面渲染

搜索引擎部分,您可以管理内部搜索索引选项和第三方搜索引擎集成:

配置搜索引擎

存储部分中,指定内容的备份和同步目标,使您能够管理媒体和页面附件的存储位置和方式(例如在本地文件系统或 AWS S3 上):

管理安全性和连接性

您可以通过配置 API 访问、设置电子邮件通知、调整安全策略以及启用 SSL 来保护 Wiki.js 实例的安全,从而获得安全体验。例如,处理API 令牌以将 Wiki.js 与其他应用程序集成:

管理 API 密钥

设置电子邮件配置以管理 Wiki.js 中的通知、邀请和密码恢复流程:

配置邮件设置

安全设置也可以进行微调,涵盖会话超时、密码策略和访问限制等方面:

配置安全设置

此外,您可以设置SSL/TLS证书以确保您的 Wiki.js 实例通过 HTTPS 安全运行:

管理 SSL/TLS 证书

此外,从系统信息部分验证您的 Wiki 信息,例如系统诊断、服务器规格和运行时环境统计信息:

验证系统信息

从“实用程序”选项卡执行维护活动,例如重新索引搜索结果、清除缓存数据或重置配置:

管理实用程序

最后,开发者工具提供高级资源,如 GraphQL 游乐场、日志调试功能或自定义脚本集成:

管理开发工具

现在您已经掌握了使用 Docker 设置 Wiki.js 的知识,您可以自信地使用此平台轻松创建内部文档、协作团队 wiki 或公共知识库。

来源和图片

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注