gol

README

gol - A Simple Golang Powered Logbook

Pronounced "goal" (/ɡoʊl/).

Build

To get started, download the latest release, unpack it somewhere and run the main binary in there.

$ source .env
$ make
$ ./main
Listening on http://0.0.0.0:5000

If you want to use ssl, you can generate a certificate and then start the server using the -ssl flag, passing the certificate and the private key to it:

$ ./main --ssl server.crt,server.key
Listening on https://0.0.0.0:5000

Install

make install

As Docker Container

• build the container docker build -t gol .
• run the container docker run -p 5000:5000 gol

Dependencies

gol uses the following libraries (which are awesome):

• blackfriday for rendering markdown
• bluemonday to sanitize html
• mux for routing (supports url parameters)
• pflag for posix-style command-line flags

Thanks for writing those libraries!

Development

If vim freezes for some seconds when you save a .go file, run this:

let g:syntastic_go_checkers = ['golint', 'govet', 'errcheck']

License

gol is licensed under the GNU GPL.