Skip to content

roelrymenants/liddly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

liddly

A tiddlywiki server to run from dropbox

This little server program has been designed with the express purpose of hosting it's database on a file share like dropbox, google drive, or CIFS/NFS.

It is meant to be run as a single instance wherever you are and closed when you leave.

Usage

Running liddly will start an http server on port 8080. The default browser will open automatically. Tiddlers are saved in a sqlite db (tiddlers.db) in the working directory.

To allow running from dropbox, a lock file (tiddlers.lock) is placed in the working directory. This avoids multiple instances (possibly on different machines) accessing the database simultaneously.

In order to allow a preemptive workflow, any new instance will create tiddlers.shutdown and exit. Running instances will react by properly shutting down (removing lock file and shutdown file). After the lock file and shutdown file have disappeared, you can start the local instance again.

See also liddly --help for more options

Building

Prerequisites:

  • golang v1.8.1
  • github.com/rakyll/static
  • Everything necessary to compile github.com/mattn/go-sqlite3
$ go get github.com/rakyll/statik
$ go get github.com/roelrymenants/liddly
$ cd $GOPATH/src/github.com/roelrymenants/liddly
$ go generate
$ go install github.com/roelrymenants/liddly

#TiddlyWiki

The web folder contains an empty version of tiddlywiki with the tiddlyweb/tiddlyspaces plugin already installed. See tiddlywiki.license for copyright and licensing.