Git Product home page Git Product logo

gowiki's Introduction

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 -h
Usage of ./gowiki:
  -db="./wiki.db": path for wiki db
  -debug=false: run with debug mode
  -del-static=false: delete db-cached static files
  -load-static=false: reload db-cached static files
  -port="2222": port to run on

If no options are chosen, static files are loaded as necessary and the wiki is run in deploy mode.

gowiki's People

Contributors

gabeeden avatar jmoiron avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gowiki's Issues

nothing happened after running go get

2018-04-17 15:27:46 [cch@h034 ~]$ go version
go version go1.9.1 linux/amd64
2018-04-17 15:27:48 [cch@h034 ~]$ go get github.com/jmoiron/gowiki

the just nothing happened ...no error , no meesage ...
any suggestions ?

Couldn't build apllication in Windows

When I try to get application I've got the following error:

> go get github.com/jmoiron/gowiki
# github.com/mattn/go-sqlite3
exec: "gcc": executable file not found in %PATH%

I have no gcc compilator in Windows. :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.