sweetroll

A website engine for the indie web with curved swords. Curved! Swords!

uses Git+JSON for storage
supports Micropub for posting, updating, deleting and undeleting
allows posting in CommonMark Markdown and other markup languages (powered by Pandoc)
sends and receives Webmentions, including Salmentions
supports the webmention-to-syndication / Syndicate by Reference process (Bridgy Publish)
sends PubSubHubbub notifications on new posts (for readers)
supports indie-config
has a JSON Web Tokens-based token-endpoint
extensible with JavaScript plugins
written in Haskell

I'm running it on my website.

Privacy notice: if you expose your website's git repo publicly, your "deleted" entries are not really deleted.

Usage

Installing Sweetroll on a server requires some UNIX sysadmin skills. If you can't do it, ask your friends for help or check out other IndieWeb projects: some of them have hosted versions, some run on shared PHP hosting.

First, you need to get a binary of Sweetroll. I haven't uploaded any yet, so you have to build from source.

Buliding from source

get stack (from your OS package manager or cabal install stack)
get bower (get node/npm from your OS package manager, npm install -g bower)
git clone the repo
cd into it
bower install
stack build

When it's done, it says where it put the binary (something like .stack-work/install/your-platform/some/versions/.../bin).

Running on a server

Copy the binary to the server (using scp, usually).

Create a user account on the server (for example, sweetroll).

Create a directory where your website's content files will be, and run git init there.

Make sure the user has read and write permissions on the directory.

And configure your favorite service management program (don't forget to replace everything with your values!) to run Sweetroll as that user!

Here's an example for runit:

#!/bin/sh

umask g+w
exec chpst -u sweetroll /home/sweetroll/.local/bin/sweetroll
        --https \ # this means HTTPS is *working*! i.e. you have it set up on your reverse proxy!
        --protocol=unix \ # will run on /var/run/sweetroll/sweetroll.sock by default; you can override with --socket
  # or: --protocol=http --port=3030 \
        --domain=unrelenting.technology \ # your actual domain!
        --repo="/home/sweetroll/repo" \ # the site directory! don't forget to run `git init` inside of it first
        --secret="GENERATE YOUR LONG PSEUDORANDOM VALUE!...2MGy9ZkKgzexRpd7vl8" 2>&1

(Use something like head -c 1024 < /dev/random | openssl dgst -sha512 to get the random value for the secret. No, not dynamically in the script. Copy and paste the value into the script. Otherwise you'll be logged out on every restart.)

Putting a reverse proxy in front of Sweetroll is not required, but you might want to run other software at different URLs, etc. I wrote 443d as a lightweight alternative to nginx.

After you start Sweetroll, open your new website. It should write the default configuration to conf/sweetroll.json in your site directory. Edit that file, you probably want to change some options.

Create a templates directory in your site directory. You can override the HTML templates you see in this repo's templates directory with your own using your templates directory. The templating engine is embedded JavaScript via lodash's _.template. You need to put your h-card and rel-me markup into templates/author.ejs.

Restart Sweetroll after any changes to the config file or the templates.

Use Micropub clients like Micropublish and Quill to post.

Development

Use stack to build (and bower to get front-end dependencies).
Use ghci to run tests and the server while developing (see the .ghci file).

The :serve command in ghci runs the server in test mode, which means you don't need to authenticate using IndieAuth.

$ bower install

$ stack build

$ stack test

$ (mkdir /tmp/sroll && cd /tmp/sroll && git init)

$ stack ghci --no-load
:serve

$ http -f post localhost:3000/login x=x | sed -Ee 's/.*access_token=([^&]+).*/\1/' > token

$ http -f post localhost:3000/micropub "Authorization: Bearer $(cat token)" h=entry content=HelloWorld

(the http command in the examples is HTTPie)

Libraries I made for this project

gitson, a git-backed storage engine
pcre-heavy, a usable regular expressions library
http-link-header, a parser for the Link header (RFC 5988)
microformats2-parser, a Microformats 2 parser
indieweb-algorithms, a collection of implementations of algorithms like authorship and link discovery
hs-duktape, Haskell bindings to duktape, a lightweight ECMAScript (JavaScript) engine

TODO

License

This is free and unencumbered software released into the public domain.
For more information, please refer to the UNLICENSE file or unlicense.org.

Failed to load latest commit information.
executable	stuff	Apr 2, 2016
library/Sweetroll	use browser caching for assets	May 17, 2016
templates	use browser caching for assets	May 16, 2016
test-suite	test fix	May 21, 2016
.ghci	test fix	May 21, 2016
.gitignore	fix context date and stuff	Mar 22, 2016
.mailmap	meta stuff	Feb 11, 2015
CODE_OF_CONDUCT.md	TODO stuff in README, new CoC	Feb 22, 2016
README.md	readme stuff	Apr 2, 2016
UNLICENSE	unlicense	Jul 27, 2015
bower.json	fix context date and stuff	Mar 22, 2016
icons.svg	put templates prelude into a js file; improve reactions count/facepil…	Mar 23, 2016
stack.yaml	update stackage	May 17, 2016
style.css	stackage nightly with aeson 0.11! also fix other stuff	Mar 26, 2016
sweetroll.cabal	stuff	Apr 1, 2016
update-icons.js	put templates prelude into a js file; improve reactions count/facepil…	Mar 23, 2016

myfreeweb/sweetroll

README.md