开源项目 omnigollum 使用教程
omnigollumOmniauth authentication for gollum项目地址:https://gitcode.com/gh_mirrors/om/omnigollum
1. 项目的目录结构及介绍
omnigollum/
├── lib/
│ └── omnigollum.rb
├── config.ru
├── Gemfile
├── README.md
└── ...
- lib/: 包含项目的主要逻辑文件。
- omnigollum.rb: 项目的主要逻辑文件,负责配置和启动 OmniAuth。
- config.ru: 项目的启动文件,用于配置和启动应用程序。
- Gemfile: 项目的依赖管理文件,列出了项目所需的所有 gem。
- README.md: 项目的说明文档,包含项目的基本信息和使用说明。
2. 项目的启动文件介绍
config.ru 是项目的启动文件,负责配置和启动应用程序。以下是 config.ru
的基本内容:
# Load omnigollum library
require 'omnigollum'
# Load individual provider libraries
require 'omniauth/strategies/twitter'
require 'omniauth/strategies/open_id'
# Set configuration options
options = {
# OmniAuth::Builder block is passed as a proc
:providers => Proc.new do
provider :twitter, 'CONSUMER_KEY', 'CONSUMER_SECRET'
provider :open_id, OpenID::Store::Filesystem.new('/tmp')
end,
:dummy_auth => false
}
# :omnigollum options *must* be set before the Omnigollum extension is registered
Precious::App.set(:omnigollum, options)
# Register the Omnigollum extension
Precious::App.register Omnigollum::Sinatra
# Run the application
run Precious::App
3. 项目的配置文件介绍
Gemfile 是项目的依赖管理文件,列出了项目所需的所有 gem。以下是 Gemfile
的基本内容:
source 'https://rubygems.org'
gem 'gollum'
gem 'omniauth'
gem 'omniauth-twitter'
gem 'omniauth-open_id'
gem 'omnigollum'
- gollum: 项目的主要依赖,用于构建 wiki 系统。
- omniauth: 用于处理认证的 gem。
- omniauth-twitter: 用于 Twitter 认证的 gem。
- omniauth-open_id: 用于 OpenID 认证的 gem。
- omnigollum: 项目的主要 gem,用于在 gollum 中添加 OmniAuth 支持。
以上是开源项目 omnigollum 的基本使用教程,包含了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助!
omnigollumOmniauth authentication for gollum项目地址:https://gitcode.com/gh_mirrors/om/omnigollum