No description
Find a file
Matt Baer aedb05080c Support ?landing=1 to always show landing page
This supports admins previewing changes to the landing page.

Ref T565
2019-06-27 16:38:24 -04:00
.github Automatically assign "bug?" label to bug reports 2019-03-14 09:43:48 -04:00
author Fix IsValidUsername check when PagesParentDir isn't current dir 2019-03-06 10:44:32 -05:00
cmd/writefreely Save config via Apper interface from Admin dash 2019-06-13 21:56:13 -04:00
config Support changing default landing path 2019-06-13 13:47:27 -04:00
key Add TODO for multierror 2019-06-14 19:12:14 -04:00
keys Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
less Add spacing around time element on index pages 2019-06-01 09:26:58 -04:00
migrations Run migrations on db initialization 2019-04-15 13:48:19 -04:00
page Link to version-specific writer's guide 2019-04-11 13:52:10 -04:00
pages Support ?landing=1 to always show landing page 2019-06-27 16:38:24 -04:00
parse Describe package parse 2019-01-18 11:36:56 -05:00
scripts fix: update script: non-standard version numbers 2019-06-14 17:26:56 -07:00
static Move MathJax to git submodule 2019-05-14 07:50:37 -04:00
templates Remove langs list from post-render as it does not actually 2019-06-27 18:15:58 +03:00
.dockerignore added .git to make builds cache more effectively and run faster 2018-11-22 06:56:29 -06:00
.gitignore Fix go-bindata error in Travis build 2019-04-06 10:45:19 -04:00
.gitmodules Use HTTP for MathJax submodule 2019-05-14 07:58:36 -04:00
.travis.yml Fix go-bindata error in Travis build 2019-04-06 10:45:19 -04:00
account.go Move key generation and Keychain to key pkg 2019-06-13 13:47:28 -04:00
activitypub.go Fix more missing hostNames 2019-06-20 21:08:30 -04:00
activitypub_test.go fixes issue #100 - can't follow from pubgate 2019-05-21 07:02:35 -07:00
admin.go Support changing landing conf val from Admin UI 2019-06-16 17:38:34 -04:00
app.go Support ?landing=1 to always show landing page 2019-06-27 16:38:24 -04:00
auth.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
AUTHORS.md Add @nkoehring to AUTHORS 2019-01-24 17:24:07 -05:00
bindata-lib.go Include schema.sql when built with wflib tag 2019-06-13 20:25:30 -04:00
cache.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
collections.go Remove global hostName var 2019-06-14 18:54:04 -04:00
config.ini.example Make WriteFreely spacing consistent 2019-04-11 21:33:33 -04:00
CONTRIBUTING.md Explain where to post questions, feedback, bugs 2018-11-11 10:30:50 -05:00
database-lib.go Allow compiling without go-sql-driver/mysql pkg 2019-06-13 13:47:27 -04:00
database-no-sqlite.go Allow compiling without go-sql-driver/mysql pkg 2019-06-13 13:47:27 -04:00
database-sqlite.go Allow compiling without go-sql-driver/mysql pkg 2019-06-13 13:47:27 -04:00
database.go Fix #96 2019-06-27 18:15:58 +03:00
docker-compose.yml Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
docker-setup.sh Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
Dockerfile Install the writefreely cmd properly 2019-04-19 13:05:01 +02:00
errors.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
export.go Merge branch 'develop' into librarization 2019-06-13 20:44:55 -04:00
feed.go Remove global hostName var 2019-06-14 18:54:04 -04:00
go.mod Add go-bindata as a module dependency 2019-05-17 16:22:44 -07:00
go.sum Add go-bindata as a module dependency 2019-05-17 16:22:44 -07:00
handle.go Save config via Apper interface from Admin dash 2019-06-13 21:56:13 -04:00
hostmeta.go Make App struct public 2019-05-12 17:19:38 -04:00
instance.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
invites.go Make App struct public 2019-05-12 17:19:38 -04:00
keys.go Break functionality out of Serve() func 2019-06-13 18:50:23 -04:00
LICENSE Use AGPL 2018-10-29 10:06:45 -04:00
Makefile Construct version from annotated tags only 2019-06-27 21:25:22 +02:00
nodeinfo.go Add invites flag in NodeInfo 2019-04-11 20:37:01 -04:00
pad.go Make App struct public 2019-05-12 17:19:38 -04:00
pages.go Make App struct public 2019-05-12 17:19:38 -04:00
postrender.go Make WriteFreely spacing consistent 2019-04-11 21:33:33 -04:00
posts.go Fix more missing hostNames 2019-06-20 21:08:30 -04:00
read.go Remove global hostName var 2019-06-14 18:54:04 -04:00
README.md Include -config and -init-db steps in make install 2019-04-16 11:27:27 -04:00
request.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
routes.go Save config via Apper interface from Admin dash 2019-06-13 21:56:13 -04:00
schema.sql Set up migrations table on initial setup 2019-01-24 17:08:08 -05:00
session.go Break functionality out of Serve() func 2019-06-13 18:50:23 -04:00
sitemap.go Remove global hostName var 2019-06-14 18:54:04 -04:00
sqlite.sql Set up migrations table on initial setup 2019-01-24 17:08:08 -05:00
templates.go Break functionality out of Serve() func 2019-06-13 18:50:23 -04:00
unregisteredusers.go Make App struct public 2019-05-12 17:19:38 -04:00
users.go Move key generation and Keychain to key pkg 2019-06-13 13:47:28 -04:00
webfinger.go Remove global hostName var 2019-06-14 18:54:04 -04:00

 

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.