Simple, federated blogging. https://writefreely.org
Matt Baer dad79adfd2 Update features list 16 hours ago
.github/ISSUE_TEMPLATE Create issue templates 1 month ago
author Reserve "community" username 4 days ago
cmd/writefreely Add make release 3 weeks ago
config Add Reader section 4 days ago
keys Move key generation to app from keys.sh 1 month ago
less Support editing About and Privacy pages from Admin panel 3 weeks ago
page Add handler, page, template loading 1 month ago
pages Show stats on About page if public_stats enabled 1 week ago
parse Fix parse package import 1 month ago
static Add missing CSS for highlightjs 4 days ago
templates Add Reader section 4 days ago
.dockerignore added .git to make builds cache more effectively and run faster 3 weeks ago
.gitignore Support custom SQLite database file name 1 week ago
.travis.yml Add .travis.yml 2 months ago
AUTHORS.md Add @koehn to AUTHORS 2 weeks ago
CONTRIBUTING.md Explain where to post questions, feedback, bugs 1 month ago
Dockerfile Add openssl and root anchors for federation queries 1 week ago
LICENSE Use AGPL 1 month ago
Makefile Switch to xgo for cross-compilation 6 days ago
README.md Update features list 15 hours ago
account.go Add basic admin dashboard with app stats 3 weeks ago
activitypub.go Only log ActivityPub info when debugging 2 weeks ago
admin.go Add Reader section 4 days ago
app.go Check database connection on startup 1 day ago
auth.go Fill in remaining missing pieces 1 month ago
cache.go Add login and post cache helpers 1 month ago
collections.go Remove code for CodeHighlighting UI 3 weeks ago
config.ini.example Improved the Docker dev workflow slightly. 4 weeks ago
database.go Add Reader section 4 days ago
docker-compose.yml Improved the Docker dev workflow slightly. 4 weeks ago
docker-setup.sh Improved the Docker dev workflow slightly. 4 weeks ago
errors.go Fill in remaining missing pieces 1 month ago
export.go Fix Novel blog post order in feeds and outbox 3 weeks ago
feed.go Fix Novel blog post order in feeds and outbox 3 weeks ago
handle.go Add basic admin dashboard with app stats 3 weeks ago
hostmeta.go Add ActivityPub components, routes, handlers 1 month ago
instance.go Show instance stats on About page 3 weeks ago
keys.go Move key generation to app from keys.sh 1 month ago
nodeinfo.go Add site_description config value 1 week ago
pad.go Fix editing metadata on single-user instances 1 week ago
pages.go Support editing About and Privacy pages from Admin panel 3 weeks ago
postrender.go Fully support single-user mode 1 month ago
posts.go Fix editing metadata on single-user instances 1 week ago
read.go Add Reader section 4 days ago
request.go Add collection handlers, routes, feeds, sitemaps 1 month ago
routes.go Add Reader section 4 days ago
schema.sql Make accesstokens.user_agent NULL by default 5 days ago
session.go Add collection handlers, routes, feeds, sitemaps 1 month ago
sitemap.go Fix Novel blog post order in feeds and outbox 3 weeks ago
sqlite.sql Make accesstokens.user_agent NULL by default 5 days ago
templates.go Rename render.tmpl to post-render.tmpl 3 weeks ago
unregisteredusers.go Improve sign up 1 month ago
users.go Add basic admin dashboard with app stats 3 weeks ago
webfinger.go Add ActivityPub components, routes, handlers 1 month ago

README.md

 

<a href="https://writefreely.org"><img src="https://writefreely.org/img/writefreely.svg" width="350px" alt="Write Freely" /></a>


<a href="https://github.com/writeas/writefreely/releases/">
    <img src="https://img.shields.io/github/release/writeas/writefreely.svg" alt="Latest release" />
</a>
<a href="https://goreportcard.com/report/github.com/writeas/writefreely">
    <img src="https://goreportcard.com/badge/github.com/writeas/writefreely" alt="Go Report Card" />
</a>
<a href="https://travis-ci.org/writeas/writefreely">
    <img src="https://travis-ci.org/writeas/writefreely.svg" alt="Build status" />
</a>
<a href="http://webchat.freenode.net/?channels=writefreely">
    <img alt="#writefreely on freenode" src="https://img.shields.io/badge/freenode-%23writefreely-blue.svg" />
</a>

 

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 light enough to run on a Raspberry Pi.

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 fast, dead-simple, and distraction-free editor
  • Format text with Markdown, and organize posts with hashtags
  • Publish drafts and let others proofread them by sharing a private link
  • Create multiple lightweight blogs under a single account
  • Export all data in plain text files
  • Read a stream of other posts in your writing community
  • Build more advanced apps and extensions with the well-documented API
  • Designed around user privacy and consent

Quick start

WriteFreely has minimal requirements to get up and running — you only need to be able to run an executable.

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

# 2) (if you chose MySQL in the previous step) Log into MySQL and run:
# CREATE DATABASE writefreely;

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

Packages

WriteFreely is available in these package repositories:

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

Docker

Using Docker for Development

If you'd like to use Docker as a base for working on a site's styles and such, you can run the following from a Bash shell.

Note: This process is intended only for working on site styling. If you'd like to run Write Freely in production as a Docker service, it'll require a little more work.

The docker-setup.sh script will present you with a few questions to set up your dev instance. You can hit enter for most of them, except for "Admin username" and "Admin password." You'll probably have to wait a few seconds after running docker-compose up -d for the Docker services to come up before running the bash script.

docker-compose up -d
./docker-setup.sh

Now you should be able to navigate to http://localhost:8080 and start working!

When you're completely done working, you can run docker-compose down to destroy your virtual environment, including your database data. Otherwise, docker-compose stop will shut down your environment without destroying your data.

Using Docker for Production

Write Freely doesn't yet provide an official Docker pathway to production. We're working on it, though!

Contributing

We gladly welcome contributions to WriteFreely, whether in the form of code, bug reports, feature requests, translations, or documentation improvements.

Before contributing anything, please read our Contributing Guide. It describes the correct channels for submitting contributions and any potential requirements.

License

Licensed under the AGPL.