leomoonstudios/wiki-go

LeoMoon Wiki-Go

!https://github.com/leomoon-studios/wiki-go/actions/workflows/release-docker.yml/badge.svg !https://github.com/leomoon-studios/wiki-go/actions/workflows/release-binaries.yml/badge.svg ![demo]([***]

LeoMoon Wiki-Go是一个使用Go构建的现代化、功能丰富的无数据库平面文件维基平台。它提供了简洁直观的界面，用于创建和管理知识库、文档和协作内容，无需任何外部数据库。

无数据库。无冗余。零维护。只需Markdown。

非SSL设置的重要配置说明

如果您在不使用SSL/HTTPS的情况下运行Wiki-Go并遇到登录问题，需要在config.yaml文件中设置allow_insecure_cookies: true并重启Wiki-Go。原因如下：

1. 默认情况下，Wiki-Go为了安全会在Cookie上设置"Secure"标志
2. 浏览器会拒绝非HTTPS连接上的"Secure"Cookie
3. 这会导致纯HTTP设置下的登录无法正常工作

安全注意事项：仅在开发环境或受信任的内部网络中使用此设置。对于面向公众的维基，始终使用HTTPS。

功能特性

功能概览

• ✍️ 完整的Markdown编辑，支持表情符号、Mermaid图表和LaTeX数学公式
• 🔍 智能全文搜索，带有高亮显示和高级筛选
• 📁 具有版本历史的分层页面结构
• 👥 用户管理、访问控制和私有维基模式
• 💬 支持评论功能，包括审核和Markdown支持
• ⚡ 通过Docker或预构建二进制文件快速设置
• 🧩 自定义徽标、横幅、短代码等

非常适合内部文档、个人知识库或团队维基。

内容管理

• Markdown支持：使用Markdown语法编写内容，实现丰富的格式
• 表情符号短代码：在Markdown内容中使用:smile:等表情符号短代码
• 文件附件：上传和管理图像和文档（支持jpg、jpeg、png、gif、svg、txt、log、csv、zip、pdf、docx、xlsx、pptx、mp4）
• 分层组织：以嵌套目录的形式组织内容
• 版本历史：通过完整的修订历史跟踪更改并恢复以前的版本
• 文档管理：通过用户友好的界面创建、编辑和删除文档
• 文档排序和命名：通过slug名称控制侧边栏中的文档顺序：
  • 文档按其目录slug名称按字母顺序排序
  • 文档标题（在侧边栏和标题中显示）取自document.md中的第一个H1标题
  • 要手动排序文档，请在slug名称前加上数字（例如1-overview、2-installation、3-usage）
  • slug名称可以与显示的标题不同，允许有组织的结构同时保持可读的标题
  • 示例：名为1-getting-started的目录，其中document.md包含# Getting Started Guide，将在侧边栏中显示为"Getting Started Guide"，但会首先排序

协作与反馈

• 评论系统：通过功能齐全的评论系统启用文档讨论
• 评论中的Markdown：使用与文档中相同的Markdown语法格式化评论
• 评论审核：管理员可以删除不适当的评论
• 禁用评论：通过维基设置可以在系统范围内禁用评论

搜索与导航

• 全文搜索：强大的搜索功能，支持：
  • 精确短语匹配（使用引号）
  • 术语包含/排除
  • 高亮显示搜索结果
• 面包屑导航：清晰的路径可视化，便于导航
• 侧边栏导航：快速访问文档层次结构

用户体验

• 响应式设计：在桌面和移动设备上均可使用
• 深色/浅色主题：在深色和浅色模式之间切换
• 代码语法高亮：支持多种编程语言
• 数学公式渲染：通过MathJax支持LaTeX数学公式
• 图表：Mermaid图表集成，用于创建流程图、序列图等

管理功能

• 用户管理：创建和管理具有不同权限级别的用户
• 管理面板：通过Web界面配置维基设置
• 统计信息：跟踪文档指标和网站使用情况

高级功能

• 自定义短代码：使用特殊短代码扩展Markdown，如:::stats recent=5:::以获得额外功能
• 媒体嵌入：在文档中嵌入图像、视频和其他媒体
• 打印友好：针对文档打印进行了优化
• API访问：用于以编程方式访问维基内容的RESTful API

演示站点

您可以通过以下实时演示试用Wiki-Go。演示站点每小时重置一次，所有上传或编辑的内容将被自动清除。

• 🔗 URL: [***]
• 👤 用户: admin
• 🔒 密码: demo123

快速开始

Docker（快速测试）

bash
# 拉取最新镜像
docker pull leomoonstudios/wiki-go

# 使用默认配置运行
docker run -d \
  --name wiki-go \
  -p 8080:8080 \
  -v "$(pwd)/data:/wiki/data" \
  leomoonstudios/wiki-go

Docker Compose

选项1 – 纯HTTP（端口8080）

使用提供的docker-compose-http.yml：

bash
docker-compose -f docker-compose-http.yml up -d

这会在http://localhost:8080上启动Wiki-Go。当您在反向代理（Nginx/Traefik/Caddy）终止TLS时非常理想。如果代理到容器的连接是纯HTTP，请记住在`data/config.yaml`中设置`allow_insecure_cookies: true`。

nginx
server {
    listen 80;
    server_name wiki.example.com;

    # 将所有HTTP重定向到HTTPS（假设您在443端口使用Let's Encrypt）
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl http2;
    server_name wiki.example.com;

    ssl_certificate     /etc/letsencrypt/live/wiki.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/wiki.example.com/privkey.pem;

    # --- 代理到运行在HTTP上的Wiki-Go容器（端口8080）---
    location / {
        proxy_pass http://wiki-go:8080;

        # 推荐的头信息
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto https;
    }
}

yaml
  nginx:
    image: nginx:alpine
    container_name: wiki-nginx
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
      - /etc/letsencrypt:/etc/letsencrypt:ro
    depends_on:
      - wiki-go

选项2 – 原生HTTPS（端口443）

bash
# 将证书和密钥放在./ssl/中
mkdir -p ssl
docker-compose -f docker-compose-ssl.yml up -d

docker-compose-ssl.yml将主机端口443映射到容器端口443，并挂载您的证书/密钥。在应用配置中启用TLS（见下文）。

原生TLS配置

在data/config.yaml中设置：

yaml
server:
  host: 0.0.0.0
  port: 443            # 容器监听443端口
  allow_insecure_cookies: false
  ssl: true            # 启用内置HTTPS
  ssl_cert: /path/to/certificate.crt
  ssl_key:  /path/to/private.key

如果ssl: false（默认），应用将在port（默认8080）上提供纯HTTP，您可以改为在反向代理后面运行它。

GitHub发布的Docker镜像同时暴露8080和443端口，因此您可以在运行时选择任一方案。

二进制文件

从https://github.com/leomoon-studios/wiki-go/releases%E9%A1%B5%E9%9D%A2%E4%B8%8B%E8%BD%BD%E9%80%82%E7%94%A8%E4%BA%8E%E6%82%A8%E5%B9%B3%E5%8F%B0%E7%9A%84%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E3%80%82

bash
# 运行应用程序
./wiki-go  # Windows上为wiki-go.exe

从源代码构建

要求：

• Go 1.21或更高版本
• Git

bash
# 克隆仓库
git clone https://github.com/leomoon-studios/wiki-go.git
cd wiki-go

# 构建二进制文件
go build -o wiki-go

# 运行应用程序
./wiki-go  # Windows上为wiki-go.exe

配置

基本设置

配置存储在data/config.yaml中，首次运行时会自动创建带有默认值的配置文件。您可以修改此文件来自定义您的维基：

yaml
server:
    host: 0.0.0.0
    port: 8080
    # 设置为true时，允许通过非HTTPS连接发送Cookie。
    # 警告：仅在信任的环境（如没有HTTPS的家庭实验室）中启用此选项。
    # 这会通过允许Cookie以明文传输来降低安全性。
    allow_insecure_cookies: true
    # 启用原生TLS。当为true时，应用程序将使用提供的证书和密钥路径通过HTTPS运行。
    ssl: false
    ssl_cert:
    ssl_key:
wiki:
    root_dir: data
    documents_dir: documents
    title: "📚 Wiki-Go"
    owner: wiki.example.com
    notice: Copyright 2025 © All rights reserved.
    timezone: America/Vancouver
    private: false
    disable_comments: false
    disable_file_upload_checking: false
    enable_link_embedding: false
    hide_attachments: false
    disable_content_max_width: false
    max_versions: 10
    # 最大文件上传大小（MB）
    max_upload_size: 10
    # 维基界面的默认语言（en、es等）
    language: en
security:
    login_ban:
        # 启用针对暴力登录攻击的保护
        enabled: true
        # 触发禁令前的失败尝试次数
        max_failures: 3
        # 计数失败的时间窗口（秒）
        window_seconds: 30
        # 首次禁令的持续时间（秒）
        initial_ban_seconds: 60
        # 最大禁令持续时间（秒）（24小时）
        max_ban_seconds: 86400
users:
    - username: admin
      password: <bcrypt-hashed-password>
      is_admin: true

自定义

自定义Favicon

LeoMoon Wiki-Go带有默认favicon，但您可以轻松替换为自己的：

1. 要使用自定义favicon，请将文件放在data/static/目录中，并使用以下名称：

   • favicon.ico - 标准favicon格式（供旧浏览器使用）
   • favicon.png - PNG格式favicon
   • favicon.svg - SVG格式favicon（推荐用于所有尺寸的最佳质量）

2. 应用程序将自动检测并使用您的自定义favicon文件，无需重启。

SVG格式推荐用于favicon，因为它可以缩放到不同尺寸同时保持清晰的质量。

自定义徽标（可选）

您可以添加自定义徽标，显示在侧边栏中的维基标题上方：

1. 创建支持格式的徽标文件：

   • logo.svg - SVG格式（推荐用于最佳质量）
   • logo.png - PNG格式（替代选项）

2. 将徽标文件放在data/static/目录中。

3. 徽标将自动出现在侧边栏中的维基标题上方。

注意：

• 徽标显示为120×120像素，但会保持其宽高比
• SVG格式推荐用于在所有屏幕尺寸上获得最佳外观
• 无需配置更改或应用程序重启
• 如果不存在徽标文件，将只显示维基标题
• 如果同时存在logo.svg和logo.png，将使用logo.svg

全局横幅（可选）

您可以添加横幅图像，显示在所有文档的顶部：

1. 创建支持格式的横幅图像：

   • banner.png - PNG格式（推荐用于最佳质量）
   • banner.jpg - JPG格式（替代选项）

2. 将横幅文件放在data/static/目录中。

3. 横幅将自动出现在所有文档内容的顶部。

注意：

• 横幅以响应式宽度显示，最大高度为250px
• 横幅在适应不同屏幕尺寸时保持其宽高比
• 无需配置更改或应用程序重启
• 要删除横幅，只需从data/static/目录中删除文件
• 如果同时存在banner.png和banner.jpg，将使用banner.png

用户管理

LeoMoon Wiki-Go包含具有不同权限级别的用户管理系统：

• 管理员用户：可以创建、编辑和删除内容，管理用户和更改设置
• 普通用户：可以查看内容（在私有模式下）

默认管理员凭据为：

• 用户名：admin
• 密码：admin

建议首次登录后立即更改这些凭据。

安全性

• 认证：用户认证与安全密码哈希
• 登录速率限制：多次失败尝试后临时IP禁令，防止暴力***
• 私有模式：需要登录的可选私有维基模式
• 管理员控制：用于内容管理的单独管理员权限

使用方法

创建内容

1. 使用管理员凭据登录
2. 使用"新建"按钮创建新文档
3. 使用Markdown语法编写内容
4. 保存文档

组织内容

LeoMoon Wiki-Go允许您以层次结构组织内容：

1. 创建目录对相关文档进行分组
2. 在编辑模式下使用移动/重命名功能重新组织内容
3. 使用侧边栏或面包屑导航浏览内容

附加文件

您可以将文件附加到任何文档：

1. 导航到文档并进入编辑模式
2. 点击"附件"
3. 使用上传按钮上传文件
4. 使用"文件"选项卡在文档中插入文件链接

使用评论

评论系统允许用户提供反馈并参与讨论：

1. 导航到任何文档
2. 滚动到底部的评论部分
3. 已认证用户可以使用Markdown语法添加评论
4. 管理员可以删除任何评论
5. 可以通过管理员设置面板在系统范围内禁用评论

快捷键

Wiki-Go提供了几个键盘快捷键来提高工作效率：

常规快捷键

• Ctrl+E - 进入编辑模式
• Ctrl+S - 编辑模式下保存文档
• Ctrl+Shift+F - 聚焦搜索框
• Escape - 退出编辑模式或关闭对话框

编辑模式下的格式快捷键

• Ctrl+B - 切换粗体格式
• Ctrl+I - 切换斜体格式
• Ctrl+H - 切换/循环标题级别（# -> ## -> ### ... -> 纯文本）
• Ctrl+Q - 切换块引用
• Ctrl+/ - 切换代码格式（单行选择为内联代码，多行选择或无选择时为代码块）
• Ctrl+Shift+P - 预览切换
• Alt+Z - 切换自动换行

表格编辑

Wiki-Go包含强大的表格编辑功能和键盘快捷键：

导航

• Tab - 移动到下一个单元格（在行的最后一个单元格时创建新列）
• Shift+Tab - 移动到上一个单元格
• Enter - 移动到下方单元格/创建新行
• Ctrl+Enter - 在当前位置退出表格

箭头键导航

• Ctrl+Left - 移动到左侧单元格
• Ctrl+Right - 移动到右侧单元格
• Ctrl+Up - 移动到上方单元格
• Ctrl+Down - 移动到下方单元格

列/行对齐

• Shift+Ctrl+Left - 左对齐列
• Shift+Ctrl+Right - 右对齐列
• Shift+Ctrl+Up - 居中对齐列
• Shift+Ctrl+Down - 移除列对齐

移动列/行

• Alt+Up - 向上移动行
• Alt+Down - 向下移动行
• Alt+Left - 向左移动列
• Alt+Right - 向右移动列

技术细节

技术栈

• 后端：Go（Golang）
• 前端：HTML、CSS、JavaScript
• **