No description
Find a file
2018-11-13 13:04:52 -05:00
.github/ISSUE_TEMPLATE Create issue templates 2018-11-12 20:12:31 -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 Fix overflowing green bg in setup titles 2018-11-10 21:44:41 -05:00
keys Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
less Fully support single-user mode 2018-11-09 22:10:46 -05:00
page Add handler, page, template loading 2018-11-07 23:50:50 -05:00
pages Fully support single-user mode 2018-11-09 22:10:46 -05:00
parse Fix parse package import 2018-10-16 23:49:01 -04:00
static Fully support single-user mode 2018-11-09 22:10:46 -05:00
templates Add login link on single-user blog 2018-11-12 19:47:14 -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 Show number of followers on stats page 2018-11-10 20:56:36 -05:00
activitypub.go Fix Accept IDs 2018-11-12 19:31:21 -05:00
app.go Add --init-db flag to create schema in app 2018-11-13 13:04:52 -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 Use avatar as blog link social media image 2018-11-11 15:34:26 -05:00
CONTRIBUTING.md Explain where to post questions, feedback, bugs 2018-11-11 10:30:50 -05:00
database.go Include default posts.privacy value on post creation 2018-11-12 21:00:54 -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 Remove r.Host from server logs 2018-11-11 09:40:18 -05:00
hostmeta.go Add ActivityPub components, routes, handlers 2018-11-08 01:28:08 -05:00
keys.go Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
LICENSE Use AGPL 2018-10-29 10:06:45 -04:00
Makefile Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
nodeinfo.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
pad.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
postrender.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
posts.go Support retrieving posts as AS2 object 2018-11-10 01:29:48 -05:00
README.md Add --init-db flag to create schema in app 2018-11-13 13:04:52 -05:00
request.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
routes.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
schema.sql Provide default updated value 2018-11-13 08:52:42 -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 Fix template loading on Windows 2018-11-09 14:40:47 -05:00
unregisteredusers.go Improve sign up 2018-11-09 14:51:11 -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 on freenode

 

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.

Start a blog on our instance

Try the editor

Find another instance

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

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.

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) Configure your blog
./writefreely --config

# 3) Import the schema with:
./writefreely --init-db

# 4) Generate data encryption keys
./writefreely --gen-keys

# 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!

For running in production, see our guide.

Development

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

Prerequisites

Setting up

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

Configure your site, create your database, and import the schema as shown above. Then generate the remaining files you'll need:

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.