README.md 3.5 KB

🌩 Lightning Talk at the 34c3 🚀

Build Status

ShaarliGo

self-hosted microblogging inspired by http://sebsauvage.net/wiki/doku.php?id=php:shaarli. Destilled down to the bare minimum, with easy hosting and security in mind. No PHP, no DB, no server-side templating, JS optional.

Design Goals

  • backwards compatible posting (https://code.mro.name/mro/Shaarli-API-test)
  • trivial installation and minimal hosting requirements (run on simple hosted webspace),
  • keep server lean, especially for readers,
  • standards compliant (Atom, Atompub, WebSub),
  • easy migration from existing shaarlis,
  • run ok without javascript,
  • visitor reading operates on static flat files only (no server code),
  • secure against brute force login attacks,
  • easy translation & skinning,
  • leverage existing, widely deployed web tec (CGI, XSLT, HTML, CSS),
  • easy fail2ban integration / DOS mitigation,
Quality very good good normal irrelevant
Functionality ×
Reliability ×
Usability ×
Efficiency ×
Changeability ×
Portability ×

Dependencies

tl;dr: a webserver that can execute CGIs and serve files from disc.

ShaarliGo is an old-school CGI binary executable, so it needs a webserver to drive it. Example configurations come for Apache (see static/.htaccess) and Lighttpd (see static/app/lighttpd.conf).

As a self-contained, statically linked, Go executable, it has no software dependencies and can run on a variety of platforms.

It needs write access to it's webserver's filesystem location to unpack the web assets and update the content when posting.

Storage footprint is <25 KiB per post.

When posting a page, it is once accessed via HTTP GET to suggest title, tags and a thumbnail image URL.

Install / Update

Linux amd64:

  1. $ curl -L http://purl.mro.name/shaarligo_cgi.gz | tee shaarligo_cgi.gz | gunzip > shaarligo.cgi && chmod a+x shaarligo.cgi
  2. visit in your browser: http://my.web.space/subdir/shaarligo.cgi

done!

Or build from source at http://purl.mro.name/ShaarliGo

See example static/.htaccess or static/app/lighttpd.conf how to set up webserver integration.

Todos

  1. private posts,
  2. PuSH/PubSubhubbub / WebSub,
  3. import shaarlis (login?),
  4. pwd reset (maybe deleting from app/config.yaml is acceptable),
  5. images/enclosures,
  6. comments,
  7. trackback/pingback

Shaarli(OS|er) Compatibilty

see https://code.mro.name/mro/ShaarliOS/src/master/ios/ShaarliOS/API/ShaarliCmdUpdateEndpoint.m and https://code.mro.name/mro/Shaarli-API-test/src/master/tests/test-post.sh