Git based wiki inspired by Gollum

Go to file

Matthew Scragg 7dfec15ae1 update readme		2014-09-04 08:59:19 -05:00
realms	removed unneeded files	2014-09-03 22:30:33 -05:00
.bowerrc	bower	2013-10-09 16:35:06 -05:00
.gitignore	create provision script, removed salt states	2014-09-02 14:07:14 -05:00
LICENSE	add license	2014-09-03 22:40:02 -05:00
README.md	update readme	2014-09-04 08:59:19 -05:00
Vagrantfile	fix cache issue, rename provision script	2014-09-03 09:26:53 -05:00
bower.json	WIP	2014-08-20 10:28:25 -05:00
install.sh	readme updated	2014-09-03 22:25:48 -05:00
manage.py	create provision script, removed salt states	2014-09-02 14:07:14 -05:00
requirements.txt	update requirements.txt	2014-09-04 07:27:41 -05:00

Realms Wiki Beta

Git based wiki written in Python Inspired by Gollum, Ghost, and Dillinger. Basic authentication and registration included.

Demo: http://realms.io This domain is being used temporarily as a demo so expect it to change.

Features

TODO thumbnails here

Python 2.7
Git
NodeJS (needed for bower/cleancss, distro packages shouldn't need this in future)

Optional

Nginx (if you want proxy requests, this is recommended)
Memcached or Redis, default is memonization
MariaDB, MySQL, Postgresql, or another database supported by SQLAlchemy, default is sqlite.
Anon or single user does not require a database.

Install script only tested with Ubuntu 14.04. Please refer to the script for package requisites if needed

git clone https://github.com/scragg0x/realms-wiki
cd realms-wiki
sudo bash install.sh

Nginx

sudo apt-get install -y nginx

TODO nginx config here

Current there are different ways.

sudo start realms-wiki

realms-wiki run

realms-wiki runserver

Access from your browser

Vagrantfile is included for development.

git clone https://github.com/scragg0x/realms-wiki
cd realms-wiki
vagrant up
vagrant ssh
realms-wiki runserver