A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Matt Baer 034db22f8c Break functionality out of Serve() func 4 years ago
.github Automatically assign "bug?" label to bug reports 5 years ago
author Fix IsValidUsername check when PagesParentDir isn't current dir 5 years ago
cmd/writefreely Break functionality out of Serve() func 4 years ago
config Support changing default landing path 4 years ago
key Move key generation and Keychain to key pkg 4 years ago
keys Move key generation to app from keys.sh 5 years ago
less Modified less/Makefile: added /bin/lessc path which is returned by which lessc in CentOS 7 when lessc is installed via npm. 5 years ago
migrations Run migrations on db initialization 5 years ago
page Link to version-specific writer's guide 5 years ago
pages Make WriteFreely spacing consistent 5 years ago
parse Describe package parse 5 years ago
static Fix draft post metadata 5 years ago
templates Fix draft post metadata 5 years ago
.dockerignore added .git to make builds cache more effectively and run faster 5 years ago
.gitignore Fix go-bindata error in Travis build 5 years ago
.travis.yml Fix go-bindata error in Travis build 5 years ago
AUTHORS.md Add @nkoehring to AUTHORS 5 years ago
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5 years ago
Dockerfile Install the writefreely cmd properly 5 years ago
LICENSE Use AGPL 5 years ago
Makefile Include -config and -init-db steps in make install 5 years ago
README.md Include -config and -init-db steps in make install 5 years ago
account.go Move key generation and Keychain to key pkg 4 years ago
activitypub.go Use db.isDuplicateKeyErr() in activitypub.go 4 years ago
admin.go Make App struct public 5 years ago
app.go Break functionality out of Serve() func 4 years ago
auth.go Fix spacing around copyright notices 5 years ago
cache.go Fix spacing around copyright notices 5 years ago
collections.go Make App struct public 5 years ago
config.ini.example Make WriteFreely spacing consistent 5 years ago
database-lib.go Allow compiling without go-sql-driver/mysql pkg 4 years ago
database-no-sqlite.go Allow compiling without go-sql-driver/mysql pkg 4 years ago
database-sqlite.go Allow compiling without go-sql-driver/mysql pkg 4 years ago
database.go Move key generation and Keychain to key pkg 4 years ago
docker-compose.yml Improved the Docker dev workflow slightly. 5 years ago
docker-setup.sh Improved the Docker dev workflow slightly. 5 years ago
errors.go Fix spacing around copyright notices 5 years ago
export.go Make App struct public 5 years ago
feed.go Make App struct public 5 years ago
go.mod Add `invites` flag in NodeInfo 5 years ago
go.sum Add `invites` flag in NodeInfo 5 years ago
handle.go Break functionality out of Serve() func 4 years ago
hostmeta.go Make App struct public 5 years ago
instance.go Fix spacing around copyright notices 5 years ago
invites.go Make App struct public 5 years ago
keys.go Break functionality out of Serve() func 4 years ago
nodeinfo.go Add `invites` flag in NodeInfo 5 years ago
pad.go Make App struct public 5 years ago
pages.go Make App struct public 5 years ago
postrender.go Make WriteFreely spacing consistent 5 years ago
posts.go Move static file ServeMux to App struct 4 years ago
read.go Make App struct public 5 years ago
request.go Fix spacing around copyright notices 5 years ago
routes.go Break functionality out of Serve() func 4 years ago
schema.sql Set up migrations table on initial setup 5 years ago
session.go Break functionality out of Serve() func 4 years ago
sitemap.go Make App struct public 5 years ago
sqlite.sql Set up migrations table on initial setup 5 years ago
templates.go Break functionality out of Serve() func 4 years ago
unregisteredusers.go Make App struct public 5 years ago
users.go Move key generation and Keychain to key pkg 4 years ago
webfinger.go Fix spacing around copyright notices 5 years ago

README.md

 

WriteFreely


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