# Summary

**Scuttleblog** creates a blog from a [Scuttlebutt][] journal,
using [Scuttlebot][] and [Hugo][].

[Scuttlebutt]: https://www.scuttlebutt.nz/
[Scuttlebot]: http://scuttlebot.io/
[Hugo]: https://gohugo.io/


## Goals

* Visitors from Web 1.0 can read your blog.
* You can write your blog using a typical Scuttlebutt client,
    such as Patchwork.
* You can write your blog without
    a persistent or frequent internet connection,
    and without direct contact with whoever hosts your blog.
* You can manage day-to-day aspects of your blog,
    such as its name and description,
    using a typical Scuttlebutt client,
    such as Patchwork.
* Scuttlebutt acts as the comments section.


### Semi-goals

Nice to have, but not why we're here.

* Acts as a window into the wider Scuttleverse social network.
* Gracefully handles awkwardly-formatted posts.


# Use it

## Set up

1. On Ubuntu 17.10:
    install using install.sh.
2. Tell conf.py your Scuttlebutt user identity.


## Update the blog

Periodically:

1. Run scuttleblog.py.
2. (Optionally,
    run `hugo server` from inside hugo/
    and view a preview with Hugo's internal web server.)
3. Sync the contents of hugo/public/ to your server.


# How it works

* Scuttleblog starts Scuttlebot,
    and uses it to fetch the specified identity's posts and metadata.
* It manipulates the data into the format Hugo expects for a blog.
* Then it runs Hugo to generate the blog.