Gollum 项目安装与使用教程

Gollum 项目安装与使用教程

gollum项目地址:https://gitcode.com/gh_mirrors/goll/gollum

1. 项目的目录结构及介绍

Gollum 项目的目录结构如下：

gollum/
├── bin/
│   └── gollum
├── lib/
│   └── gollum
├── spec/
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
└── Rakefile

目录结构介绍：

• bin/: 包含 Gollum 的可执行文件 gollum，用于启动 Gollum 服务。
• lib/: 包含 Gollum 的核心代码库。
• spec/: 包含项目的测试文件。
• Gemfile: 定义了项目所需的 Ruby 依赖包。
• Gemfile.lock: 记录了当前项目依赖包的具体版本。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。
• Rakefile: 用于定义项目的 Rake 任务。

2. 项目的启动文件介绍

Gollum 的启动文件位于 bin/ 目录下，文件名为 gollum。该文件是一个 Ruby 脚本，用于启动 Gollum 服务。

启动文件介绍：

• gollum: 这是一个可执行的 Ruby 脚本，用于启动 Gollum 服务。你可以通过命令 ./bin/gollum 来启动 Gollum。

3. 项目的配置文件介绍

Gollum 项目没有专门的配置文件，但可以通过命令行参数或环境变量来进行配置。以下是一些常用的配置选项：

常用配置选项：

• --port: 指定 Gollum 服务的端口号，例如 --port 4567。
• --base-path: 指定 Gollum 服务的根路径，例如 --base-path /wiki。
• --wiki-dir: 指定 Wiki 页面的存储目录，例如 --wiki-dir /path/to/wiki。

示例命令：

./bin/gollum --port 4567 --base-path /wiki --wiki-dir /path/to/wiki

通过以上命令，你可以启动一个运行在 4567 端口，根路径为 /wiki，并且 Wiki 页面存储在 /path/to/wiki 目录下的 Gollum 服务。

gollum项目地址:https://gitcode.com/gh_mirrors/goll/gollum