帮酷LOGO
  • 显示原文与译文双语对照的内容
文章标签:Frontend  维基  API  GIT  LOC  POW  Local  
Gollum with HTTP authentication for multi-users on web.

  • 源代码名称:gollum
  • 源代码网址:http://www.github.com/gollum/gollum
  • gollum源代码文档
  • gollum源代码下载
  • Git URL:
    git://www.github.com/gollum/gollum.git
  • Git Clone代码到本地:
    git clone http://www.github.com/gollum/gollum
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/gollum/gollum
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • --是一个基于git的Wiki

    描述

    Gollum是一个构建在Git之上的简单wiki系统。 Gollum Wiki只是一个特定性质的git知识库( 无论是裸还是普通):

    • 除非仓库是裸的,否则存储库的Gollum内容是人类可以编辑的。 页面是唯一的文本文件,可以按照你选择的任何方式组织到目录中。 其他内容也可以包括,例如图片。pdf和页面的页眉/页脚。
    • Gollum页面:
      • 可以在各种标记中编写。
      • 可以使用你喜欢的系统编辑器或者 IDE ( 更改后将显示更改) 编辑,也可以使用内置的web界面进行编辑。
      • 可以在所有版本的( 提交) 中显示。

    Gollum可以作为web服务器( 使用网络界面) 或者"控制台模式"启动,在这里你可以使用预定义的API来查询和操作存储库。 有关更多信息,请参见运行和节的

    有关gollum和陷阱功能的更多信息:

    视频

    系统要求

    支持操作系统 ruby 适配器
    unix/linux类似ruby 1.9.3 +除了 RJGit是的
    unix/linux类似 ( 1.9 3+兼容)RJGit是的
    Windowsruby 1.9.3 +除了 RJGit不是
    Windows ( 1.9 3+兼容)RJGitalmost1

    备注:

    • 仍然有些 Bug,这个设置还没有准备好进行生产。 你可以通过元问题跟踪支持 Windows的进度。

    安装

    根据操作系统,软件包管理器和 ruby 安装而有所不同。 通常,你应该先安装 ruby 然后再安装。

    • 最好通过 RVM 或者选择的软件包管理器来安装 ruby 。
    • Gollum最好通过RubyGems安装:
    [sudo] gem install gollum

    在这里可以看到单个系统的安装示例:。

    备注:

    • 无论使用哪个 ruby 实现,Gollum都附带适当的默认git适配器。 因此,above 安装过程对于MRI和JRuby都很常见。
    • 如果要从源代码安装:
      • 可以选择卸载以前版本的Gollum:
         [sudo] gem uninstall -aIx gollum
      • 安装 Bundler
      • 导航到克隆的Gollum源。
      • 安装依赖项:
         [sudo] bundle install
      • 构建:
         rake build
      • 并安装:
         [sudo] gem install --no-document pkg/gollum*.gem

    标记

    :目前提供支持以下标记:

    由于所有标记都由 github标记 gem 呈现,因此你可以通过附加安装轻松地添加对其他标记的支持:

    默认情况下,Gollum附带 kramdown gem 以呈现 Markdown 。 但是,你可以使用任何 Markdown 呈现器支持来支持 github 。 要记住的是,列表中的第一个已经安装的呈现器将被使用。 因此,如果安装 github/markdown,就不会使用 redcarpet

    运行

    简单:

    • 通过 命令行 导航到你的git仓库( 维基) 。
    • 运行:gollum
    • 在浏览器中打开 http://localhost:4567

    这将启动一个运行,的web服务器( 启动程序),你可以以在它的中查看和编辑你的wiki 。

    从源运行

    • git clone https://github.com/gollum/gollum
    • cd gollum
    • [sudo] bundle install ( 未必是必要的) 。
    • bundle exec bin/gollum
    • ,假设目标 wiki ( git仓库) 是项目存储库本身。 如果不是,执行 bundle exec bin/gollum <path-to-wiki> 改为改为。
    • 在浏览器中打开 http://localhost:4567

    rack

    Gollum还可以与任何兼容的兼容的web服务器服务器运行。 更多关于这个的信息。

    rack,带有认证服务器

    Gollum也可以与( 中央身份验证服务) SSO ( 单一登录) 服务器一起运行。 稍微调整一下,这就增加了基本的用户支持。 若要查看示例和说明,请在这里导航

    Docker

    Gollum也可以通过 Docker 运行。 更多关于这个的信息。

    电子邮件服务

    Gollum也可以作为服务运行。 更多关于这个的信息。

    配置

    Gollum带有以下 命令行 选项:

    选项参数说明
    --host[HOST ]指定要侦听的主机名或者IP地址。 默认值:0.0.0.0. 1
    --port[PORT ]指定要绑定Gollum的端口。 默认值:4567
    --config[FILE ]指定gollum文件配置的路径。
    --ref[REF ]指定要服务器的git branch 。 默认值:master
    --adapter[ADAPTER ]使用特定的git适配器启动 Gollum 。 默认值:grit. 2
    --bare告诉Gollum应该将git存储库视为裸的。 这仅在使用默认粒度适配器时才有必要。
    --base-path[PATH ]指定所有 Gollum url ( 路径信息)的前导部分。 将这个设置为 /wiki 将使wiki在 http://localhost:4567/wiki/ 下。 默认值:/
    --page-file-dir[PATH ]指定所有页面的子目录。 如果设置,Gollum将只提供来自该目录及其子目录的页面。 默认值:存储库 root 。
    --css告诉Gollum在每个页面中插入定制的CSS 。 使用存储库 root.3, 5 中的custom.css
    --js告诉Gollum在每个页面中插入定制的JS 。 使用存储库 root.3, 5 中的custom.js
    --emoji解析和解释表情符号( 比如 。
    --no-edit禁用编辑页面的功能。
    --live-preview启用页面编辑器中的实时预览功能。
    --no-live-preview禁用页面编辑器中的实时预览功能。
    --allow-uploads[MODE ]启用文件上传如果设置为 dir,in将把所有上传都存储在存储库 root 中的/uploads/ 目录中。 如果设置为 page,Gollum将存储当前编辑的page.4 上的每个上传
    --mathjax启用 MathJax ( 呈现数学方程式) 。 默认情况下,将 TeX-AMS-MML_HTMLorMML 配置与 autoload-all extension.5 一起使用
    --irb在"控制台模式"中启动 Gollum,使用一个预定义的API插件。
    --h1-title告诉Gollum使用第一个 <h1> 作为页面标题。
    --show-all告诉Gollum也在文件视图中显示文件。 默认情况下,只显示有效页。
    --collapse-tree当打开文件视图时,告诉,collapse 文件树。 默认情况下,树展开。
    --user-icons[MODE ]让Gollum使用历史视图的特定用户图标。 可以设置为 gravataridenticon 或者 none 。 默认值:none
    --mathjax-config[FILE ]指定自定义MathJax配置的路径。 如果未指定,则使用存储库 root 中的mathjax.config.js 文件。
    --template-dir[PATH ]指定自定义 mustache 模板目录。
    --help在 命令行 上显示选项列表。
    --version显示Gollum的当前版本。

    备注:

    • 0.0.0.0 IP地址允许远程访问。 如果你想让Gollum变成个人维基,使用 127.0.0.1
    • 在使用 --adapter 之前,你应该先读一下这篇文章。
    • 使用 --css 或者 --js 时,必须将各个文件提交到git存储库,或者者将 302重定向到创建页面。
    • 文件可以通过拖放到编辑器区域( 这是默认的编辑器,而不是实时预览编辑器)的文本上进行简单上传。
    • 在使用这些相关的安全注释之前,请先阅读。

    配置文件

    当使用 --config 选项时,可以定制Gollum的某些内部部件。 这在我们的wiki中用于某些用户级别的修改,其中定制支持的标记可能会突出显示。

    对gollum文件的配置和 rack 文件( config.ru ) 配置的所有更改都进行了收费。



    文章标签:API  GIT  POW  LOC  Local  维基  Frontend  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语