No description
Find a file
Matt Baer 35ebbc1a10 Update Travis badge
Before, it used the develop branch
2018-11-08 13:00:52 -05:00
author Add author package 2018-10-16 23:27:04 -04:00
cmd/writefreely Create basic server 2018-10-15 14:44:15 -04:00
config Remove extraneous params in Sprintf calls 2018-11-08 12:32:38 -05:00
keys Add key generation script + keys folder 2018-10-15 14:10:34 -04:00
less Add LESS styles, fonts, icons, CSS generation 2018-11-07 22:33:13 -05:00
page Add handler, page, template loading 2018-11-07 23:50:50 -05:00
pages Add user-facing templates and pages 2018-11-08 01:13:00 -05:00
parse Fix parse package import 2018-10-16 23:49:01 -04:00
static Add ActivityPub components, routes, handlers 2018-11-08 01:28:08 -05:00
templates Add user management pages 2018-11-08 01:23:08 -05:00
.gitignore Clean up .gitignore 2018-10-16 20:41:54 -04:00
.travis.yml Add .travis.yml 2018-10-15 14:10:42 -04:00
account.go Add account handlers 2018-11-08 01:03:31 -05:00
activitypub.go Use hostname in AP requests' User-Agent header 2018-11-08 12:08:48 -05:00
app.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
auth.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
cache.go Add login and post cache helpers 2018-11-07 22:07:33 -05:00
collections.go Fix ActivityPub endpoint URLs 2018-11-08 11:26:02 -05:00
CONTRIBUTING.md Add contributing guidelines 2018-11-07 17:45:36 -05:00
database.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
errors.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
export.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
feed.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
handle.go Add handler, page, template loading 2018-11-07 23:50:50 -05:00
hostmeta.go Add ActivityPub components, routes, handlers 2018-11-08 01:28:08 -05:00
keys.go Add web session management 2018-10-16 20:31:07 -04:00
keys.sh Fix filename in email encryption key generation 2018-10-27 13:17:54 -04:00
LICENSE Use AGPL 2018-10-29 10:06:45 -04:00
Makefile Get dependencies before building 2018-11-08 12:56:14 -05:00
nodeinfo.go Remove extraneous params in Sprintf calls 2018-11-08 12:32:38 -05:00
pad.go Add editor 2018-11-08 00:11:42 -05:00
postrender.go Add backend post handling, endpoints, rendering 2018-11-07 23:43:11 -05:00
posts.go Add backend post handling, endpoints, rendering 2018-11-07 23:43:11 -05:00
README.md Update Travis badge 2018-11-08 13:00:52 -05:00
request.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
routes.go Relax root route matching 2018-11-08 10:39:45 -05:00
schema.sql Add database schema 2018-11-07 22:17:15 -05:00
session.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
sitemap.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
templates.go Add handler, page, template loading 2018-11-07 23:50:50 -05:00
unregisteredusers.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
users.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
webfinger.go Add ActivityPub components, routes, handlers 2018-11-08 01:28:08 -05:00

 

Write Freely


Latest release Go Report Card Build status

 

WriteFreely is a beautifully pared-down blogging platform that's simple on the surface, yet powerful underneath.

It's designed to be flexible and share your writing widely, so it's built around plain text and can publish to the fediverse via ActivityPub. It's easy to install and lightweight.

Note this is currently alpha software. We're quickly moving out of this v0.x stage, but while we're in it, there are no guarantees that this is ready for production use.

Features

  • Start a blog for yourself, or host a community of writers
  • Form larger federated networks, and interact over modern protocols like ActivityPub
  • Write on a dead-simple, distraction-free and super fast editor
  • Publish drafts and let others proofread them by sharing a private link
  • Build more advanced apps and extensions with the well-documented API

Quick start

First, download the latest release for your OS. It includes everything you need to start your blog.

Now extract the files from the archive, change into the directory, and do the following steps:

# 1) Log into MySQL and run:
# CREATE DATABASE writefreely;
#
# 2) Import the schema with:
mysql -u YOURUSERNAME -p writefreely < schema.sql

# 3) Configure your blog
./writefreely --config

# 4) Generate data encryption keys (especially for production)
./keys.sh

# 5) Run
./writefreely

# 6) Check out your site at the URL you specified in the setup process
# 7) There is no Step 7, you're done!

Development

Ready to hack on your site? Here's a quick overview.

Prerequisites

Setting up

go get github.com/writeas/writefreely/cmd/writefreely

Create your database, import the schema, and configure your site as shown above.

Now generate the CSS:

make install # Generates encryption keys; installs LESS compiler
make ui      # Generates CSS (run this whenever you update your styles)
make run     # Runs the application

License

Licensed under the AGPL.