Simple, federated blogging. https://writefreely.org
Matt Baer 16c856ec27 Merge branch 'readme-downloads' 1 week ago
.github Add Pull Request template 1 month ago
author Support user invites 1 month ago
cmd/writefreely Fix spacing around copyright notices 1 month ago
config Merge pull request #68 from writeas/user-invites 4 weeks ago
keys Move key generation to app from keys.sh 3 months ago
less Fixes indentation 1 month ago
migrations Set up migrations table on initial setup 4 weeks ago
page Fix spacing around copyright notices 1 month ago
pages Support user invites 1 month ago
parse Describe package parse 1 month ago
static Add numeric avatars 1 month ago
templates Clean up resource URLs on collection-tags template 2 weeks ago
.dockerignore added .git to make builds cache more effectively and run faster 3 months ago
.gitignore Ignore all .ini files 4 weeks ago
.travis.yml Add .travis.yml 4 months ago
AUTHORS.md Add @nkoehring to AUTHORS 4 weeks ago
CONTRIBUTING.md Explain where to post questions, feedback, bugs 3 months ago
Dockerfile Deploy the app in the proper dir for dependency management 1 month ago
LICENSE Use AGPL 3 months ago
Makefile Add make release-linux command 1 month ago
README.md Merge branch 'readme-downloads' 1 week ago
account.go Support user invites 1 month ago
activitypub.go Fix AP follower INSERT with SQLite 1 month ago
admin.go Support user invites 1 month ago
app.go Fix hashes in code blocks rendered as hashtags 2 weeks ago
auth.go Fix spacing around copyright notices 1 month ago
cache.go Fix spacing around copyright notices 1 month ago
collections.go Add numeric avatars 1 month ago
config.ini.example Improved the Docker dev workflow slightly. 3 months ago
database-no-sqlite.go Support building without SQLite support 1 month ago
database-sqlite.go Fix tagged posts SQLite query 1 month ago
database.go Support user invites 1 month ago
docker-compose.yml Improved the Docker dev workflow slightly. 3 months ago
docker-setup.sh Improved the Docker dev workflow slightly. 3 months ago
errors.go Fix spacing around copyright notices 1 month ago
export.go Fix spacing around copyright notices 1 month ago
feed.go Fix hashes in code blocks rendered as hashtags 2 weeks ago
go.mod Support Go modules 1 week ago
go.sum Support Go modules 1 week ago
handle.go Send correct status on 410/500 in handleHTTPError 1 month ago
hostmeta.go Fix spacing around copyright notices 1 month ago
instance.go Fix spacing around copyright notices 1 month ago
invites.go Support user invites 1 month ago
keys.go Generate encryption keys in configured directory 1 month ago
nodeinfo.go Set PublicReader value in nodeinfo 3 weeks ago
pad.go Fix spacing around copyright notices 1 month ago
pages.go Fix spacing around copyright notices 1 month ago
postrender.go Fix hashes in code blocks rendered as hashtags 2 weeks ago
posts.go Fix hashes in code blocks rendered as hashtags 2 weeks ago
read.go Fix hashes in code blocks rendered as hashtags 2 weeks ago
request.go Fix spacing around copyright notices 1 month ago
routes.go Support user invites 1 month ago
schema.sql Set up migrations table on initial setup 4 weeks ago
session.go Fix spacing around copyright notices 1 month ago
sitemap.go Fix spacing around copyright notices 1 month ago
sqlite.sql Set up migrations table on initial setup 4 weeks ago
templates.go Support configuring resource directories 1 month ago
unregisteredusers.go Support user invites 1 month ago
users.go Support user invites 1 month ago
webfinger.go Fix spacing around copyright notices 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="https://github.com/writeas/writefreely/releases/latest">
    <img src="https://img.shields.io/github/downloads/writeas/writefreely/total.svg" />
</a>
<a href="https://hub.docker.com/r/writeas/writefreely/">
    <img src="https://img.shields.io/docker/pulls/writeas/writefreely.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.

Try the editor

Find an 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
  • Organize posts with hashtags
  • Create static pages
  • 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

Hosting

We offer two kinds of hosting services that make WriteFreely deployment painless: Write.as for individuals, and WriteFreely.host for communities. Besides saving you time, as a customer you directly help fund WriteFreely development.

Write.as

Start a personal blog on Write.as, our flagship instance. Built to eliminate setup friction and preserve your privacy, Write.as helps you start a blog in seconds. It supports custom domains (with SSL) and multiple blogs / pen names per account. Read more here.

WriteFreely.host

WriteFreely.host makes it easy to start a close-knit community — to share knowledge, complement your Mastodon instance, or publish updates in your organization. We take care of the hosting, upgrades, backups, and maintenance so you can focus on writing.

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) (if you chose Multi-user setup) 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 -d 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.