jmcarbo/wiki repository overview

⁠A smart wiki software by Go language.

• Go⁠ Programming Language
• Revel⁠ A high-productivity web framework for the Go language.
• GORM⁠ The fantastic ORM library for Golang, aims to be developer friendly.

⁠Features

• Show and edit pages by everybody
• Markdown editor
• Bracket link
  • ex) Make link of "Some Page": [[Some Page]]
• Revision and Diff

⁠Planned features

• Attachment file on local disk, Google Cloud Storage and Amazon S3.
• User authentication and permissions
• Detect editing page collision
• and more...

⁠Using on Dcoker

When you start container exposed port 9000, after open url http://localhost:9000/⁠ from your browser.

⁠Default, SQLite3 in container.

docker run -d -p 9000:9000 yujiod/wiki
# same above
docker run -d -p 9000:9000 -e DB_DRIVER=sqlite3 -e DB_SOURCE="./wiki.db" jmcarbo/wiki

⁠Using MySQL

docker run -d -p 9000:9000 -e DB_DRIVER=mysql -e DB_SOURCE="dbuser:dbpass@tcp(hostname:3306)/dbname?charset=utf8" jmcarbo/wiki

The Data Source Name, see Go-MySQL-Driver⁠.

⁠Using PostgreSQL

docker run -d -p 9000:9000 -e DB_DRIVER=postgres -e DB_SOURCE="host=hostname user=dbuser dbname=dbpass sslmode=disable" yujiod/wiki

The Connection String Parameters, see pq⁠.

⁠To activate NewRelic monitoring

docker run -d -p 9000:9000 -e NEWRELIC_LICENSE=XXXXXXXXXX jmcarbo/wiki 

⁠Using from source

You need Go⁠, install it before.

go get github.com/yujiod/wiki/app
go get github.com/revel/cmd/revel
revel run github.com/yujiod/wiki

⁠Build, install and run.

# Installing to /usr/local/wiki.
revel build github.com/jmcarbo/wiki /usr/local/wiki
/usr/local/wiki/run.sh

⁠Packaging for deploy

# Creating wiki.tar.gz
revel package github.com/jmcarbo/wiki

⁠License

Released under the MIT License⁠.