🌺 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. http://purl.mro.name/ShaarliGo/

Marcus Rohrmoser b5995ec2b9 add a (javascript generated) emoji favicon. 2 months ago
static b5995ec2b9 add a (javascript generated) emoji favicon. 2 months ago
testdata a7bd7a293e 🐳. 9 months ago
.gitattributes c87dc3136a fix github language detection 8 months ago
.gitignore 1a0cc356c4 💄. 11 months ago
.travis.yml 5e1e949e08 Revert "pin yaml version. https://github.com/go-yaml/yaml/issues/341" 7 months ago
README.md b294ed6204 purge github mentions 3 months ago
ShaarliGo.go b294ed6204 purge github mentions 3 months ago
ShaarliGo_test.go b294ed6204 purge github mentions 3 months ago
api0.go b294ed6204 purge github mentions 3 months ago
api0_test.go 0b1fbb2815 (C) 2018 10 months ago
atom.go 490e123999 - combine css into one 2 months ago
atom_test.go b56e3cc783 iso8601 is now just a named type (with some convenience to feel a bit like a time.Time). 8 months ago
ban.go 0b1fbb2815 (C) 2018 10 months ago
ban_test.go 2fcf9bc1d0 test yaml datetime 8 months ago
bindata.go b5995ec2b9 add a (javascript generated) emoji favicon. 2 months ago
build.sh 278596c978 rename ‚pub/posts‘ to ‚=/p and according. 7 months ago
cgi-fake.sh f82137e2c2 - rename, 2nd. 1 year ago
comb.go b56e3cc783 iso8601 is now just a named type (with some convenience to feel a bit like a time.Time). 8 months ago
comb_test.go 0b1fbb2815 (C) 2018 10 months ago
config-core.go 34e1d51072 gently towards skinning. 10 months ago
config-core_test.go 0b1fbb2815 (C) 2018 10 months ago
config.go b294ed6204 purge github mentions 3 months ago
config_test.go 0b1fbb2815 (C) 2018 10 months ago
doap.rdf 3bab1ac86e add a doap. 4 months ago
feedwriter.go 66d4460221 make internal uri order stable and explicit (easier testing). 6 months ago
feedwriter_test.go 66d4460221 make internal uri order stable and explicit (easier testing). 6 months ago
flow.dot f82137e2c2 - rename, 2nd. 1 year ago
http.go 0fbd0e3a95 minor 8 months ago
mini-build.sh 278596c978 rename ‚pub/posts‘ to ‚=/p and according. 7 months ago
post-test.sh 2c5481d0e5 - trailing slashes 1 year ago
search.go b56e3cc783 iso8601 is now just a named type (with some convenience to feel a bit like a time.Time). 8 months ago
search_test.go 73954ebca2 fix #tag substring search. refs #1 10 months ago
tools.go 06da0b2b01 🐳. 7 months ago
tools_test.go 84f7c63b73 tweak imports and visuals a bit. refs #3 10 months ago
version.go 3e7a1b2d0b CSS colors & line-wrap tweaks, prepare to directly serve gz pre-compressed content. 7 months ago

README.md

🌩 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://git.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://git.mro.name/mro/ShaarliOS/src/master/ios/ShaarliOS/API/ShaarliCmdUpdateEndpoint.m and https://git.mro.name/mro/Shaarli-API-test/src/master/tests/test-post.sh