Simple, federated blogging. https://writefreely.org
Matt Baer fdbefa806f
Merge pull request #95 from TeDomum/master
4 days ago
.github Automatically assign "bug?" label to bug reports 1 month ago
author Fix IsValidUsername check when PagesParentDir isn't current dir 1 month ago
cmd/writefreely Fix spacing around copyright notices 3 months ago
config Make WriteFreely spacing consistent 1 week ago
keys Move key generation to app from keys.sh 5 months ago
less Fix excessive p spacing in blockquotes 1 week ago
migrations Run migrations on db initialization 1 week ago
page Link to version-specific writer's guide 1 week ago
pages Make WriteFreely spacing consistent 1 week ago
parse Describe package parse 3 months ago
static Fix draft post metadata 1 week ago
templates Fix draft post metadata 1 week ago
.dockerignore added .git to make builds cache more effectively and run faster 5 months ago
.gitignore Fix go-bindata error in Travis build 2 weeks ago
.travis.yml Fix go-bindata error in Travis build 2 weeks ago
AUTHORS.md Add @nkoehring to AUTHORS 2 months ago
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5 months ago
Dockerfile Install the writefreely cmd properly 4 days ago
LICENSE Use AGPL 5 months ago
Makefile Include -config and -init-db steps in make install 1 week ago
README.md Include -config and -init-db steps in make install 1 week ago
account.go Support user invites 3 months ago
activitypub.go Fix AP follower INSERT with SQLite 3 months ago
admin.go Support changing instance page titles 1 week ago
app.go Run migrations on db initialization 1 week ago
auth.go Fix spacing around copyright notices 3 months ago
cache.go Fix spacing around copyright notices 3 months ago
collections.go Add numeric avatars 3 months ago
config.ini.example Make WriteFreely spacing consistent 1 week ago
database-no-sqlite.go Support building without SQLite support 3 months ago
database-sqlite.go Fix tagged posts SQLite query 3 months ago
database.go Support changing instance page titles 1 week ago
docker-compose.yml Improved the Docker dev workflow slightly. 5 months ago
docker-setup.sh Improved the Docker dev workflow slightly. 5 months ago
errors.go Fix spacing around copyright notices 3 months ago
export.go Fix spacing around copyright notices 3 months ago
feed.go Fix hashes in code blocks rendered as hashtags 2 months ago
go.mod Add `invites` flag in NodeInfo 1 week ago
go.sum Add `invites` flag in NodeInfo 1 week ago
handle.go Send correct status on 410/500 in handleHTTPError 3 months ago
hostmeta.go Fix spacing around copyright notices 3 months ago
instance.go Fix spacing around copyright notices 3 months ago
invites.go Support user invites 3 months ago
keys.go Generate encryption keys in configured directory 3 months ago
nodeinfo.go Add `invites` flag in NodeInfo 1 week ago
pad.go Fix spacing around copyright notices 3 months ago
pages.go Make WriteFreely spacing consistent 1 week ago
postrender.go Make WriteFreely spacing consistent 1 week ago
posts.go Revert "Support new commentsEnabled property" 1 week ago
read.go Fix hashes in code blocks rendered as hashtags 2 months ago
request.go Fix spacing around copyright notices 3 months ago
routes.go Move instance page editing to dedicated section 2 weeks ago
schema.sql Set up migrations table on initial setup 2 months ago
session.go Fix spacing around copyright notices 3 months ago
sitemap.go Fix spacing around copyright notices 3 months ago
sqlite.sql Set up migrations table on initial setup 2 months ago
templates.go Make WriteFreely spacing consistent 1 week ago
unregisteredusers.go Support user invites 3 months ago
users.go Support user invites 3 months ago
webfinger.go Fix spacing around copyright notices 3 months ago

README.md

 

<a href="https://writefreely.org"><img src="https://writefreely.org/img/writefreely.svg" width="350px" alt="WriteFreely" /></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? Get started with our developer guide.

Docker

Read about using Docker in the documentation.

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.