gowiki

README

Gowiki

Gowiki is a single-file single-executable wiki which runs its own webserver.

Writing it was an experiment in determining the cowpaths of small but non-trivial web application development using gorilla, sqlx, and modl.

Features

Gowiki is a simple markdown wiki with the following features:

• markdown syntax w/ github style codeblocks
• distributable as a single binary which runs its own http server
• online customizable styles and page markup
• users and online user signup
• open or closed wikis, user page ownership
• ... by default it looks like my website

Gowiki does not:

• attempt to prevent multiple simultaneous edits
• auto-link WikiWeb style PageNames or require WikiCase urls

TODO:

• keep a revision history
• keep track of page references or interlinking
• add export options mentioned in /config/files

Installing

go get github.com/jmoiron/gowiki

Deployment

If your $GOPATH/bin is in your PATH, you can simply:

$ gowiki
Running in deployment mode with bundled resources.
Listening on :2222

GOWIKI_PORT controls the port to run on and GOWIKI_PATH controls the destination of the sqlite database.

Front this with nginx or whatever reverse proxy you like.

Updating

Gowiki will create static files for things like style sheets and page templates in its database which you can then edit online to modify the look and behavior of the wiki. This means that old wikis which run newer versions of gowiki might not look right. Gowiki will automatically re-seed these if they aren't there, so to refresh them, clear out the cache:

$ sqlite3 wiki.db
...
sqlite> delete from file;
sqlite>

Development

Gowiki can run in DEVELOP mode by switching a flag in the source. This will make it load static resources like javascript, css, and templates off the filesystem. To run in DEPLOY mode again, run bundle.sh to re-bundle the resource changes and then build with go build.