Personal/realms-wiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Git based wiki inspired by Gollum
72 commits 1 branch 0 tags 2.4 MiB
Go to file
Matthew Scragg 3f0a6dffad update requirements.txt
2014-09-04 07:27:41 -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
bower.json WIP 2014-08-20 10:28:25 -05:00
install.sh readme updated 2014-09-03 22:25:48 -05:00
LICENSE add license 2014-09-03 22:40:02 -05:00
manage.py create provision script, removed salt states 2014-09-02 14:07:14 -05:00
README.md updated readme 2014-09-03 22:32:40 -05:00
requirements.txt update requirements.txt 2014-09-04 07:27:41 -05:00
Vagrantfile fix cache issue, rename provision script 2014-09-03 09:26:53 -05:00

README.md

Realms Wiki Beta

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

Features

  • Built with Bootstrap 3
  • Currently Markdown (w/ HTML) only
  • Syntax highlighting (Ace Editor)
  • Live preview
  • Collaboration (TogetherJS)
  • Drafts saved to localstorage

Screenshots

TODO thumbnails here

Requirements

  • 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.

Installation

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

Running

Current there are different ways.

  • Daemon mode using upstart

sudo start realms-wiki

  • Foreground mode

realms-wiki run

  • Debug mode

realms-wiki runserver

Access from your browser

http://localhost:5000

Vagrant

Vagrantfile is included for development.

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