dash-annotations

README

Dash Annotations

a Dash 3 - Dash 5 compatible annotations server written in go. See the original annotation server in PHP.

features

• tiny footprint & minimal dependencies
• supports mysql & sqlite3
• full offline support (annotation rendering does not load bootstrap from cdn)

Usage

Assuming you're trying to get the annotations backend up and running for the first time:

• create a mysql db, I'll call mine dash3

• build the project:

  $ go build -o bin/server cmd/server/*.go
  

• start the api:

  $ ./bin/server -datasource="root@/dash3" -driver=mysql
  

• lastly, instruct dash to talk to your API instead of the public api:

  defaults write com.kapeli.dashdoc AnnotationsCustomServer "http://localhost:8000"
  

Running on OS X

The below file will setup a launchd configuration and launch the API using sqlite3 as storage engine - for a minimal dependency footprint.

sudo mkdir -p /var/run/rra.kapeli/
sudo chown $(whoami) /var/run/rra.kapeli/

cat <<EOF > $HOME/Library/LaunchAgents/rra.kapeli.annotations.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>KeepAlive</key>
  <true/>
  <key>Label</key>
  <string>rra.kapeli.annotations</string>
  <key>ProgramArguments</key>
  <array>
    <string>$GOPATH/src/github.com/nicolai86/dash-annotations/bin/server</string>
    <string>--driver=sqlite3</string>
    <string>--datasource=$HOME/Library/dash-annotations/dash.sqlite3</string>
    <string>--session.secret=1234123412341234</string>
    <string>--listen=127.0.0.1:54111</string>
  </array>
  <key>RunAtLoad</key>
  <true/>
  <key>WorkingDirectory</key>
  <string>/var/run/rra.kapeli</string>
  <key>StandardOutPath</key>
  <string>/var/run/rra.kapeli/stdout</string>
  <key>StandardErrorPath</key>
  <string>/var/run/rra.kapeli/stderr</string>
</dict>
</plist>
EOF

TODO

• forgotten password handling (request/ reset)
  • email sending
    • DKIM