Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 146 lines (92 sloc) 4.112 kb
ebe279a @bobthecow awesomer readme
authored
1 [Genghis](http://genghisapp.com)
2 ================================
a08163e @bobthecow initial commit
authored
3
f1d0fbe @bobthecow A bit of reorganization…
authored
4 The single-file MongoDB admin app, by [Justin Hileman](http://justinhileman.info).
a08163e @bobthecow initial commit
authored
5
18a1add @bobthecow GitHub auto-links images if they're not in a link already
authored
6 [![Genghis](http://genghisapp.com/genghis.png)](http://genghisapp.com)
0dbff4a @bobthecow Actual initial commit.
authored
7
e0a1b52 @bobthecow Update install/requirements in README
authored
8 There are more ways to run Genghis than you can shake a stick at
9 ----------------------------------------------------------------
10
11
ebe279a @bobthecow awesomer readme
authored
12 ### Standalone
0dbff4a @bobthecow Actual initial commit.
authored
13
ebe279a @bobthecow awesomer readme
authored
14 If you installed Genghis as a Ruby gem, running Genghis standalone is easy:
7645d6a @bobthecow Mention PECL driver in README.
authored
15
ebe279a @bobthecow awesomer readme
authored
16 ```
17 $ genghisapp
18 ```
e0a1b52 @bobthecow Update install/requirements in README
authored
19
ebe279a @bobthecow awesomer readme
authored
20 If you didn't go the gem route, you can still run `genghis.rb` standalone:
21
22 ```
23 $ ruby genghis.rb
24 ```
25
26 `genghis.php` can also be run as a PHP 5.4 CLI SAPI standalone server:
27
28 ```
29 $ php -S localhost:8000 genghis.php
30 ```
31
32
33 ### In your LAMP stack
34
35 Simply drop `genghis.php` in a web-accessible directory on a LAMP server. Don't forget `.htaccess` for perty URLs!
36
37
38 ### With nginx and PHP-fpm (and friends)
39
40 You'll need [some fancy config action](https://github.com/bobthecow/genghis/wiki), but it's fairly straightforward.
41
42
43 ### In an existing Rack app
44
6a8f435 @bobthecow Update README, gemspec
authored
45 For a super basic Rack config, use a `config.ru` file like this:
46
47 ```rb
48 require 'genghis'
49
50 run Genghis::Server
51 ```
52
ebe279a @bobthecow awesomer readme
authored
53 If you want to load Genghis on a subpath, possibly alongside other apps, it's easy to do with Rack's `URLMap`:
54
55 ```rb
56 require 'genghis'
57
58 run Rack::URLMap.new \
59 '/' => Your::App.new,
f1d0fbe @bobthecow A bit of reorganization…
authored
60 '/genghis' => Genghis::Server.new
ebe279a @bobthecow awesomer readme
authored
61 ```
62
63
64 ### With Rails 3
65
66 You can even mount Genghis on a subpath in your existing Rails 3 app by adding `require 'genghis'` to the top of your
67 routes file (or in an intializer) and then adding this to `routes.rb`:
68
69 ```rb
f1d0fbe @bobthecow A bit of reorganization…
authored
70 mount Genghis::Server.new, :at => '/genghis'
ebe279a @bobthecow awesomer readme
authored
71 ```
72
73
74
75 Genghis Dependencies
76 --------------------
77
78
79 ### PHP
80
81 You will need [the PECL MongoDB driver](http://www.mongodb.org/display/DOCS/PHP+Language+Center).
82
83
84 ### Ruby
85
86 The easiest way to install Genghis and all dependencies is via RubyGems:
87
88 ```
89 $ gem install genghisapp
90 ```
91
92 Or you could check out a local copy of the Git repo and install dependencies via Bundler:
93
94 ```
95 $ gem install bundler
96 $ bundle install
97 ```
0dbff4a @bobthecow Actual initial commit.
authored
98
99
100
d098f05 @bobthecow Add a link to the wiki
authored
101 Configuration
102 -------------
103
104 Check [the Genghis wiki](https://github.com/bobthecow/genghis/wiki) for additional configuration information.
105
106
ebe279a @bobthecow awesomer readme
authored
107
0dbff4a @bobthecow Actual initial commit.
authored
108 License
109 -------
110
111 * Copyright 2011 [Justin Hileman](http://justinhileman.com)
3c0a94b @bobthecow Wow. That's a lot of licenses.
authored
112 * Distributed under the [MIT License](http://creativecommons.org/licenses/MIT/)
113
114
115 ### Genghis uses a number of amazing open source libraries, distributed under the following licenses
116
117 * [Apprise][apprise] — MIT License
118 * [Apprise Bootstrap][apprise-bootstrap] — Apache License v2.0
119 * [Backbone.js][backbone] — MIT License
120 * [CodeMirror][codemirror] — MIT-style License
121 * [Esprima][esprima] — "Simplified" BSD License (2-clause)
122 * [Hogan.js][hogan] — Apache License v2.0
123 * [hoverIntent][hoverintent] — MIT or GPLv2 License
124 * [jQuery][jquery] — MIT License
125 * [jQuery Hotkeys][hotkeys] — MIT or GPLv2 License
126 * [KEYS.css][keyscss] — MIT License
127 * [Modernizr][modernizr] — MIT or BSD (3-clause) License
128 * [TableSorter][tablesorter] — MIT or GPLv2 License
129 * [Twitter Bootstrap][bootstrap] — Apache License v2.0
130 * [Underscore.js][underscore] — MIT License
131
132 [apprise]: http://thrivingkings.com/apprise
133 [apprise-bootstrap]: https://github.com/bobthecow/apprise-bootstrap
134 [backbone]: http://backbonejs.org
135 [codemirror]: http://codemirror.net
136 [esprima]: http://esprima.org
137 [hogan]: http://twitter.github.com/hogan.js/
138 [hoverintent]: http://cherne.net/brian/resources/jquery.hoverIntent.html
139 [jquery]: http://jquery.com
140 [hotkeys]: https://github.com/jeresig/jquery.hotkeys
141 [keyscss]: http://michaelhue.com/keyscss
142 [modernizr]: http://modernizr.com
143 [tablesorter]: http://tablesorter.com
144 [bootstrap]: http://twitter.github.com/bootstrap/
145 [underscore]: http://underscorejs.org
Something went wrong with that request. Please try again.