diff --git a/Home.md b/Home.md deleted file mode 100644 index 6edf0edb..00000000 --- a/Home.md +++ /dev/null @@ -1,3 +0,0 @@ -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vulputate tincidunt sollicitudin. Quisque sit amet leo sed nunc eleifend rhoncus in consectetur leo. Vivamus posuere semper convallis. Duis malesuada lacus sed erat lobortis tincidunt mattis ligula consectetur. Sed aliquam vulputate eros at euismod. Aenean egestas lorem ligula, quis faucibus turpis. Curabitur a eros in ipsum gravida ornare. Sed elementum enim vel mi scelerisque dapibus. Nulla id libero ligula, quis tempus sem. Morbi nec felis tortor, ac cursus risus. Mauris elementum tortor id lacus eleifend non lobortis tellus pharetra. Etiam posuere cursus vestibulum. $x \lt y$ - -Morbi tincidunt dolor vel massa dictum volutpat. Vestibulum quis nibh metus, id tincidunt nisl. Vivamus eget sem ac risus eleifend rhoncus at eu nisl. Nunc elit massa, vulputate ac gravida eget, condimentum quis justo. Integer scelerisque, libero vel consequat ultricies, eros libero sagittis libero, pellentesque bibendum quam massa ut orci. Maecenas sit amet urna eget quam aliquam posuere. Nulla facilisi. Duis imperdiet augue sit amet metus ornare et hendrerit dui feugiat. Aenean a lacus neque. Sed eu enim tincidunt dolor pharetra porttitor. Vestibulum ut felis dui, rutrum iaculis orci. Duis eu bibendum tortor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse mollis sagittis purus sit amet sollicitudin. Phasellus vel interdum erat. \ No newline at end of file diff --git a/README.md b/README.md index 7e04c898..8022b102 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -gollum -- A wiki built on top of Git +gollum -- A git-based Wiki ==================================== [![Gem Version](https://badge.fury.io/rb/gollum.svg)](http://badge.fury.io/rb/gollum) @@ -7,181 +7,208 @@ gollum -- A wiki built on top of Git ## DESCRIPTION -**New: Gollum is now [compatible with JRuby](https://github.com/gollum/gollum/wiki/Git-adapters#rjgit-java). Just run `gem install gollum` to install.** +Gollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository (either bare or regular) of a specific nature: +* A Gollum repository's contents are human-editable, unless the repository is bare. Pages are unique text files which may be organized into directories any way you choose. Other content can also be included, for example images, PDFs and headers/footers for your pages. +* Gollum pages: + * May be written in a variety of [markups](#markups). + * Can be edited with your favourite system editor or IDE (changes will be visible after committing) or with the built-in web interface. + * Can be displayed in all versions (commits). -Gollum is a simple wiki system built on top of Git. +Gollum can be launched either as a webserver (with the web interface) or in "console mode", where you can use a predefined API to query and manipulate the repository. For more information, see the [Running](#running) and [Configuration](#configuration) sections. -Gollum wikis are simply Git repositories that adhere to a specific format. -Gollum pages may be written in a variety of formats and can be edited in a -number of ways depending on your needs. You can edit your wiki locally: +For more information on Gollum's capabilities and pitfalls: -* With your favorite text editor or IDE (changes will be visible after committing). -* With the built-in web interface. -* With the Gollum Ruby API. - -Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses -[TomDoc](http://tomdoc.org/) for inline documentation. +1. [Syntax/capability overview for pages](https://github.com/gollum/gollum/wiki). +2. [Known limitations](https://github.com/gollum/gollum/wiki/Known-limitations). +3. [Security overview](https://github.com/gollum/gollum/wiki/Security). ## SYSTEM REQUIREMENTS -- Python 2.5+ (2.7.3 recommended) -- Ruby 1.9.3+ (1.9.3 recommended) (JRuby compatible!) -- Unix like operating system (OS X, Ubuntu, Debian, and more) -- Will not work on Windows with the default [grit](https://github.com/github/grit) adapter, but might work via JRuby (please let us know!) +| Operating System | Ruby | Adapters | Supported | +| ---------------- | -------------- | ------------------ | --------- | +| Unix/Linux-like | Ruby 1.9.3+ | all except [RJGit](https://github.com/repotag/rjgit) | yes | +| Unix/Linux-like | [JRuby](https://github.com/jruby/jruby) (1.9.3+ compatible) | [RJGit](https://github.com/repotag/rjgit) | yes | +| Windows | Ruby 1.9.3+ | all except [RJGit](https://github.com/repotag/rjgit) | no | +| Windows | [JRuby](https://github.com/jruby/jruby) (1.9.3+ compatible) | [RJGit](https://github.com/repotag/rjgit) | almost1 | -## SECURITY +**Notes:** -Don't enable `--custom-css`, `--custom-js` or `--mathjax-config` unless you trust every user who has the ability to edit the wiki. -A better solution with more security is being tracked in [#665](https://github.com/gollum/gollum/issues/665). +1. There are still some bugs and this setup is not ready for production yet. You can track the progress at #1044. ## INSTALLATION -The best way to install Gollum is with RubyGems: +Varies depending on operating system, package manager and Ruby installation. Generally, you should first install Ruby and then Gollum. -```bash -$ [sudo] gem install gollum -``` -You may first need to install some additional [development packages](https://github.com/gollum/gollum/wiki/Installation) for your OS. +1. Ruby is best installed either via [RVM](https://rvm.io/) or a package manager of choice. +2. Gollum is best installed via RubyGems: + ``` + [sudo] gem install gollum + ``` -If you're installing from source, you can use [Bundler][bundler] to pick up all the -gems: +Installation examples for individual systems can be seen [here](https://github.com/gollum/gollum/wiki/Installation). -```bash -$ bundle install -``` +**Notes:** +* Whichever Ruby implementation you're using, Gollum ships with the appropriate default git adapter. So the above installation procedure is common for both MRI and JRuby. +* If you're installing from source: + * Optionally uninstall any previous versions of Gollum: + ``` + [sudo] gem uninstall -aIx gollum + ``` + * Install [Bundler](http://bundler.io/). + * Navigate to the cloned source of Gollum. + * Install dependencies: + ``` + [sudo] bundle install + ``` + * Build: + ``` + rake build + ``` + * And install: + ``` + [sudo] gem install --no-ri --no-rdoc pkg/gollum*.gem + ``` -In order to use the various formats that Gollum supports, you will need to -separately install the necessary dependencies for each format. You only need -to install the dependencies for the formats that you plan to use. +### Markups -* [AsciiDoc](http://asciidoctor.org) -- `gem install asciidoctor` -* [Creole](http://www.wikicreole.org/) -- `gem install creole` -* [Markdown](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet` -* [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) -- `gem install github-markdown` -* [Org](http://orgmode.org/) -- `gem install org-ruby` -* [Pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML` comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN. +Gollum presently ships with support for the following markups: +* [Markdown](http://daringfireball.net/projects/markdown/syntax) * [RDoc](http://rdoc.sourceforge.net/) -* [ReStructuredText](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils` -* [Textile](http://en.wikipedia.org/wiki/Textile_(markup_language)) -- `gem install RedCloth` -* [MediaWiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth` -[bundler]: http://gembundler.com/ - - -## SYNTAX - -Gollum supports a variety of formats and extensions (Markdown, MediaWiki, Textile, …). -On top of these formats Gollum lets you insert headers, footers, links, image, math and more. - -Check out the [Gollum Wiki](https://github.com/gollum/gollum/wiki) for all of Gollum's formats and syntactic options. +Since all markups are rendered by the [github-markup](https://github/com/github/markup) gem, you can easily add support for other markups by additional installation: +* [AsciiDoc](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) -- `[sudo] gem install asciidoctor` +* [Creole](http://www.wikicreole.org/wiki/CheatSheet) -- `[sudo] gem install creole` +* [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) -- `[sudo] gem install github-markdown` +* [MediaWiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `[sudo] gem install wikicloth` +* [Org](http://orgmode.org/worg/dev/org-syntax.html) -- `[sudo] gem install org-ruby` +* [Pod](http://perldoc.perl.org/perlpod.html) -- requires Perl >= 5.10 (the `perl` command must be available on your command line) + * Lower versions should install `Pod::Simple` from CPAN. +* [ReStructuredText](http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html) -- requires python >= 2 (the `python2` command must be available on your command line) + * Note that Gollum will also need you to install `docutils` for your Python 2. Installation procedure can, again, vary depending on operating system and package manager. +* [Textile](http://redcloth.org/hobix.com/textile/quick.html) -- `[sudo] gem install RedCloth` +By default, Gollum ships with the `kramdown` gem to render Markdown. However, you can use any [Markdown renderer supported by github-markup](https://github.com/github/markup/blob/master/lib/github/markup/markdown.rb). The thing to remember is that the first installed renderer from the list will be used. So, for example, `redcarpet` will NOT be used if `github/markdown` is installed. ## RUNNING -To view and edit your Gollum repository locally via the built in web -interface, simply install the Gollum gem, navigate to your repository via the -command line, and run the executable: +Simply: + +1. Navigate to your git repository (wiki) via the command line. +2. Run: `gollum`. +3. Open `http://localhost:4567` in your browser. + +If you wish to run from source, simply: + +1. Navigate to your git repository (wiki) via the command line. +2. Run: `bundle exec bin/gollum` +3. Open `http://localhost:4567` in your browser. + +This will start up a web server (WEBrick) running Gollum with a web interface, where you can view and edit your wiki. + +### Rack + +Gollum can also be ran with any [rack-compatible web server](https://github.com/rack/rack#supported-web-servers). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Rack). + +### Docker + +Gollum can also be ran via [Docker](https://www.docker.com/). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Docker). + +### Service + +Gollum can also be ran as a service. More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-as-a-service). + +## CONFIGURATION + +Gollum comes with the following command line options: + +| Option | Arguments | Description | +| ----------------- | --------- | ----------- | +| --host | [HOST] | Specify the hostname or IP address to listen on. Default: `0.0.0.0`.1 | +| --port | [PORT] | Specify the port to bind Gollum with. Default: `4567`. | +| --gollum-path | [PATH] | Specify path to the Gollum git repository. Default: current working directory. | +| --config | [CONFIG] | Path to the configuration file. | +| --ref | [REF] | Specify the git branch to serve. Default: `master`. | +| --bare | none | Tell Gollum that the git repository should be treated as bare. This is only necessary when using the default grit adapter. | +| --base-path | [PATH] | Specify the leading portion of all page URLs. Default: `/`. For example, if set to `wiki`, all pages will be accessible under `http://localhost:4567/wiki/` by default. | +| --page-file-dir | [PATH] | Specify the subdirectory for all pages. If set, Gollum will only serve pages from this directory. Default: repository root. | +| --css | none | Tell Gollum to inject custom CSS into each page. Uses `custom.css` from repository root.2,4 | +| --js | none | Tell Gollum to inject custom JS into each page. Uses `custom.js` from repository root.2,4 | +| --no-edit | none | Disables the feature of editing pages. | +| --live-preview | none | Enables the live preview feature in page editor. | +| --no-live-preview | none | Disables the live preview feature in page editor. | +| --allow-uploads | [MODE] | Enables file uploads. If set to `dir`, Gollum will store all uploads in the `/uploads/` directory. If set to `page`, Gollum will store each upload at the same location as the page that is currently being edited.3 | +| --template-dir | [PATH] | Specify custom mustache template directory. | +| --show-all | none | Tell Gollum to also show files in the file view. By default, only valid pages are shown. | +| --collapse-tree | none | Tell Gollum to collapse the file tree, when the file view is opened. By default, the tree is expanded. | +| --mathjax | none | Enables MathJax (renders mathematical equations). By default, uses the `TeX-AMS-MML_HTMLorMML` config with the `autoload-all` extension.4 | +| --mathjax-config | [PATH] | Specify path for custom MathJax config. By default, uses `mathjax.config.js` from repository root. | +| --h1-title | none | Tell Gollum to use the first `

` as page title. | +| --adapter | [ADAPTER] | Tell Gollum to use a specific git adapter. Default: `grit`.5 | +| --user-icons | [MODE] | Tell Gollum to use specific user icons. Can be set to `gravatar`, `identicon` or `none`. Default: `none`. | +| --irb | none | Tell Gollum to launch in console mode, with [this API](https://github.com/gollum/gollum-lib/) being available. | +| --help | none | Display the list of options no the command line. | +| --version | none | Display the current version of Gollum. | + +**Notes:** + +1. The `0.0.0.0` IP address allows remote access. Should you wish for Gollum to turn into a personal Wiki, use `127.0.0.1`. +2. When `--css` or `--js` is used, respective files must be committed to your git repository or you will get a 302 redirect to the create a page. +3. Files can be uploaded simply by dragging and dropping them onto the editor's text area (this is, however exclusive to the default editor, not the live preview editor). +4. Read the relevant [Security note](https://github.com/gollum/gollum/wiki/Security#custom-cssjs--mathjax-config) before using these. +5. Before using `--adapter`, you should probably read [this](https://github.com/gollum/gollum/wiki/Git-adapters) first. + +### Config file + +When `--config` option is used, certain inner parts of Gollum can be customized. This is used throughout our wiki for certain user-level alterations, among which [customizing supported markups](https://github.com/gollum/gollum/wiki/Formats-and-extensions) will probably stand out. + +**All of the mentioned alterations work both for Gollum's config file (`config.rb`) and Rack's config file (`config.ru`).** + +## HOW TO CONTRIBUTE + +1. Fork and clone Gollum. +2. Create a thoughtfully named topic branch to contain your changes. +3. If you haven't installed dependencies yet, navigate to your clone and execute: + ``` + [sudo] bundle install + ``` +4. Hack away. +5. Add your own tests and make sure they're all still passing. +6. If some of your changes deserve a mention on Gollum's home page, edit the README accordingly. +7. If necessary, rebase your commits into logical chunks, without errors. +8. Push the branch to your fork on GitHub. +9. Create a pull request for Gollum. + +**Notes:** +* Do not change Gollum's version numbers, we will do that on our own. + +### Running tests + +1. Install [Bundler](http://bundler.io/). +2. Navigate to the cloned source of Gollum. +3. Install dependencies: + ``` + [sudo] bundle install + ``` +4. Run the tests: + ``` + bundle exec rake test + ``` + +### Working with test repositories + +An example of how to add a test file to the bare repository lotr.git. -```bash -$ gollum ``` - -This will start up a web server running the Gollum frontend and you can view -and edit your wiki at http://localhost:4567. To get help on the command line -utility, you can run it like so: - -```bash -$ gollum --help +mkdir tmp +cd tmp +git clone ../lotr.git/ +git log +echo "test" > test.md +git add . +git commit -am "Add test" +git push ../lotr.git/ master ``` -This will show you the options you can pass as arguments to the `gollum` command: - -```bash -Options: - --port [PORT] Bind port (default 4567). - --host [HOST] Hostname or IP address to listen on (default 0.0.0.0). - --version Display current version. - --config [CONFIG] Path to additional configuration file. - --adapter [ADAPTER] Git adapter to use in the backend. Defaults to grit. - --irb Start an irb process with gollum loaded for the current wiki. - --css Inject custom css. Uses custom.css from root repository. - --js Inject custom js. Uses custom.js from root repository. - --template-dir [PATH] Specify custom template directory. - --page-file-dir [PATH] Specify the sub directory for all page files (default: repository root). - --base-path [PATH] Specify the base path for the served pages (default: /) Example: --base-path wiki yields the home page accessible at http://localhost:4567/wiki/. - --gollum-path [PATH] Specify the path to the git repository to be served. - --ref [REF] Specify the repository ref to use (default: master). - --bare Specify that the repository is bare (only necessary when using the grit adapter). - --no-edit Restricts editing capability through frontend. - --no-live-preview Disables livepreview. - --live-preview Enables livepreview. - --allow-uploads [MODE] Allows file uploads. Modes: dir (default, store all uploads in the same directory), page (store each upload at the same location as the page). - --mathjax Enables mathjax for rendering mathematical equations. Uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension by default. - --mathjax-config [SOURCE] Inject custom mathjax config file. Uses mathjax.config.js from root repository by default. - --user-icons [SOURCE] Set the history user icons. Valid values: gravatar, identicon, none. Default: none. - --show-all Shows all files in file view. By default only valid pages are shown. - --collapse-tree Collapse file view tree. By default, expanded tree is shown. - --h1-title Sets page title to value of first h1. -``` - -Note that the gollum server will not run on Windows because of [an issue](https://github.com/rtomayko/posix-spawn/issues/9) with posix-spawn (which is used by Grit). - -### RACK - -You can also run gollum with any rack-compatible server by configuring a `config.ru` -file. This allows you to utilize any Rack middleware like Rack::Auth, OmniAuth, etc. See below for an example of a `config.ru`. You can define all the [options available on the command line](#running) by configuring the app's `:wiki_options` hash. See [here](https://github.com/gollum/gollum/wiki/Using-Gollum-with-Rack) for the names of the options corresponding to the command line switches. - -```ruby -#!/usr/bin/env ruby -require 'rubygems' -require 'gollum/app' - -gollum_path = File.expand_path(File.dirname(__FILE__)) # CHANGE THIS TO POINT TO YOUR OWN WIKI REPO -Precious::App.set(:gollum_path, gollum_path) -Precious::App.set(:default_markup, :markdown) # set your favorite markup language -Precious::App.set(:wiki_options, {:universal_toc => false}) -run Precious::App -``` - -Your Rack middleware can pass author details to Gollum in a Hash in the session under the 'gollum.author' key. - -## CONFIG FILE - -Gollum optionally takes a `--config file`. See [config.rb](https://github.com/gollum/gollum/blob/master/config.rb) for an example. - -## CUSTOM CSS/JS - -The `--css` flag will inject `custom.css` from the root of your git repository into each page. `custom.css` must be commited to git or you will get a 302 redirect to the create page. - -The `--js` flag will inject `custom.js` from the root of your git repository into each page. `custom.js` must be commited to git or you will get a 302 redirect to the create page. - - -## API DOCUMENTATION - -The [Gollum API](https://github.com/gollum/gollum-lib/) allows you to retrieve -raw or formatted wiki content from a Git repository, write new content to the -repository, and collect various meta data about the wiki as a whole. - - -## CONTRIBUTE - -If you'd like to hack on Gollum, start by forking the repo on GitHub: - -http://github.com/gollum/gollum - -To get all of the dependencies, install the gem first. The best way to get -your changes merged back into core is as follows: - -1. Clone down your fork -1. Create a thoughtfully named topic branch to contain your change -1. Hack away -1. Add tests and make sure everything still passes by running `rake` -1. If you are adding new functionality, document it in the README -1. Do not change the version number, I will do that on my end -1. If necessary, rebase your commits into logical chunks, without errors -1. Push the branch up to GitHub -1. Send a pull request to the gollum/gollum project. - ## RELEASING Gollum uses [Semantic Versioning](http://semver.org/). @@ -190,47 +217,15 @@ Gollum uses [Semantic Versioning](http://semver.org/). For z releases: -```bash -$ rake bump -$ rake release +``` +rake bump +rake release ``` For x.y releases: -```bash -Update VERSION in lib/gollum.rb -$ rake gemspec -$ rake release ``` - -## BUILDING THE GEM FROM MASTER - -```bash -$ gem uninstall -aIx gollum -$ git clone https://github.com/gollum/gollum.git -$ cd gollum -gollum$ rake build -gollum$ gem install --no-ri --no-rdoc pkg/gollum*.gem -``` - -## RUN THE TESTS - -```bash -$ bundle install -$ bundle exec rake test -``` - -## WORK WITH TEST REPOS - -An example of how to add a test file to the bare repository lotr.git. - -```bash -$ mkdir tmp; cd tmp -$ git clone ../lotr.git/ . -Cloning into '.'... -done. -$ git log -$ echo "test" > test.md -$ git add . ; git commit -am "Add test" -$ git push ../lotr.git/ master +# First update VERSION in lib/gollum.rb and then: +rake gemspec +rake release ``` diff --git a/config.rb b/config.rb deleted file mode 100644 index 3f28df94..00000000 --- a/config.rb +++ /dev/null @@ -1,28 +0,0 @@ -# Example gollum config -# gollum ../wiki --config config.rb -# -# or run from source with -# -# bundle exec bin/gollum ../wiki/ --config config.rb - -# Remove const to avoid -# warning: already initialized constant FORMAT_NAMES -# -# only remove if it's defined. -# constant Gollum::Page::FORMAT_NAMES not defined (NameError) -Gollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES -# limit to one format -Gollum::Page::FORMAT_NAMES = { :markdown => "Markdown" } - -=begin -Valid formats are: -{ :markdown => "Markdown", - :textile => "Textile", - :rdoc => "RDoc", - :org => "Org-mode", - :creole => "Creole", - :rest => "reStructuredText", - :asciidoc => "AsciiDoc", - :mediawiki => "MediaWiki", - :pod => "Pod" } -=end diff --git a/docs/sanitization.md b/docs/sanitization.md deleted file mode 100644 index e23c5dba..00000000 --- a/docs/sanitization.md +++ /dev/null @@ -1,33 +0,0 @@ -Sanitization Rules -================== - -Gollum uses the [Sanitize](http://wonko.com/post/sanitize) gem for HTML -sanitization. Below you find the default allowed tags, attributes, and protocols, as well as directions to customize these settings. - -# Default Settings - -## ALLOWED TAGS - -a, abbr, acronym, address, area, b, big, blockquote, br, button, caption, center, cite, code, col, colgroup, dd, del, dfn, dir, div, dl, dt, em, fieldset, font, form, h1, h2, h3, h4, h5, h6, hr, i, img, input, ins, kbd, label, legend, li, map, menu, ol, optgroup, option, p, pre, q, s, samp, select, small, span, strike, strong, sub, sup, table, tbody, td, textarea, tfoot, th, thead, tr, tt, u, ul, var - -## ALLOWED ATTRIBUTES - -a href, abbr, accept, accept-charset, accesskey, action, align, alt, axis, border, cellpadding, cellspacing, char, charoff, class, charset, checked, cite, clear, cols, colspan, color, compact, coords, datetime, dir, disabled, enctype, for, frame, headers, height, hreflang, hspace, id, img src, ismap, label, lang, longdesc, maxlength, media, method, multiple, name, nohref, noshade, nowrap, prompt, readonly, rel, rev, rows, rowspan, rules, scope, selected, shape, size, span, start, summary, tabindex, target, title, type, usemap, valign, value, vspace, width - -## ALLOWED PROTOCOLS - -* a href: http, https, mailto, ftp, irc, apt, :relative -* img src: http, https, :relative -* form action: http, https, :relative - -# Customizing - -To customize these settings, edit your `config.rb` file along the following lines (be sure to run gollum with the `--config` option): - -```ruby -sanitizer = Gollum::Sanitization.new -sanitizer.protocols['a']['href'].concat ['ssh', 'vnc'] # Protocols -sanitizer.elements.concat ['customtag1', 'customtag2'] # Tags -sanitizer.attributes['a'].push 'target' # Attributes -Precious::App.set(:wiki_options, {:sanitization => sanitizer}) -```