Gollum Wiki 配置中 base_path 参数的正确使用方法

Gollum Wiki 是一个基于 Git 的轻量级 Wiki 系统，允许用户通过简单的文本文件创建和管理 Wiki 内容。在配置 Gollum 时，base_path 参数是一个常见但容易配置错误的选项，本文将详细介绍其正确使用方法。

base_path 参数的作用

base_path 参数用于指定 Gollum Wiki 的 URL 前缀路径。这个参数的主要用途包括：

1. 当 Gollum 不是部署在网站根目录时，可以指定子目录路径
2. 在同一域名下部署多个 Gollum 实例
3. 与其他 Web 应用共存时避免路径冲突

常见配置错误

在配置文件中，开发者经常会犯以下错误：

1. 在路径前添加斜杠 /，如 /wiki，这会导致重定向错误
2. 路径中包含特殊字符或空格
3. 路径配置与反向代理设置不匹配

正确配置方法

正确的 base_path 配置应该遵循以下格式：

base_path: "wiki"

而不是：

base_path: "/wiki"  # 错误写法，会导致重定向问题

配置示例

以下是一个完整的 Gollum 配置示例，展示了 base_path 的正确用法：

wiki_options = {
  base_path: "wiki",
  allow_editing: true,
  h1_title: true,
  emoji: true,
  user_icons: "identicon",
  index_page: 'README'
}

Precious::App.set(:wiki_options, wiki_options)

注意事项

1. Git 适配器配置：在配置文件中，不应保留示例中的 Gollum::GIT_ADAPTER = "my" 行，除非你确实需要自定义 Git 适配器。保留这行会导致 Gollum 无法使用默认的 Git 功能。

2. 与反向代理配合使用：如果你使用 Nginx 或 Apache 作为反向代理，需要确保代理配置与 base_path 设置一致。

3. 浏览器缓存：修改 base_path 后，建议清除浏览器缓存，以避免旧路径被缓存导致访问问题。

总结

正确配置 base_path 参数对于 Gollum Wiki 的正常运行至关重要。记住路径前不应添加斜杠，同时确保与其他配置项协调一致。通过遵循这些最佳实践，你可以轻松地将 Gollum Wiki 部署到任何子路径下，而不会遇到重定向或其他访问问题。