A focused writing and publishing space. https://write.with.parts
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 a2088c1646 Restrict API read access based on Private setting 6 years ago
.github Automatically assign "bug?" label to bug reports 6 years ago
author Fix IsValidUsername check when PagesParentDir isn't current dir 6 years ago
cmd/writefreely Save config via Apper interface from Admin dash 6 years ago
config Allow completely private instances, part 1 6 years ago
key Add TODO for multierror 6 years ago
keys Move key generation to app from keys.sh 6 years ago
less Add spacing around time element on index pages 6 years ago
migrations Run migrations on db initialization 6 years ago
page Link to version-specific writer's guide 6 years ago
pages Make WriteFreely spacing consistent 6 years ago
parse Describe package parse 6 years ago
scripts fix: update script: non-standard version numbers 6 years ago
static Move MathJax to git submodule 6 years ago
templates Support changing landing conf val from Admin UI 6 years ago
.dockerignore added .git to make builds cache more effectively and run faster 6 years ago
.gitignore Fix go-bindata error in Travis build 6 years ago
.gitmodules Use HTTP for MathJax submodule 6 years ago
.travis.yml Fix go-bindata error in Travis build 6 years ago
AUTHORS.md Add @nkoehring to AUTHORS 6 years ago
CONTRIBUTING.md Explain where to post questions, feedback, bugs 6 years ago
Dockerfile Install the writefreely cmd properly 6 years ago
LICENSE Use AGPL 6 years ago
Makefile Merge branch 'develop' into librarization 6 years ago
README.md Include -config and -init-db steps in make install 6 years ago
account.go Move key generation and Keychain to key pkg 6 years ago
activitypub.go Remove global hostName var 6 years ago
activitypub_test.go fixes issue #100 - can't follow from pubgate 6 years ago
admin.go Support changing landing conf val from Admin UI 6 years ago
app.go Add TODO for multierror 6 years ago
auth.go Fix spacing around copyright notices 6 years ago
bindata-lib.go Include schema.sql when built with wflib tag 6 years ago
cache.go Fix spacing around copyright notices 6 years ago
collections.go Remove global hostName var 6 years ago
config.ini.example Make WriteFreely spacing consistent 6 years ago
database-lib.go Allow compiling without go-sql-driver/mysql pkg 6 years ago
database-no-sqlite.go Allow compiling without go-sql-driver/mysql pkg 6 years ago
database-sqlite.go Allow compiling without go-sql-driver/mysql pkg 6 years ago
database.go Merge branch 'develop' into librarization 6 years ago
docker-compose.yml Improved the Docker dev workflow slightly. 6 years ago
docker-setup.sh Improved the Docker dev workflow slightly. 6 years ago
errors.go Fix spacing around copyright notices 6 years ago
export.go Merge branch 'develop' into librarization 6 years ago
feed.go Remove global hostName var 6 years ago
go.mod Add go-bindata as a module dependency 6 years ago
go.sum Add go-bindata as a module dependency 6 years ago
handle.go Restrict API read access based on Private setting 6 years ago
hostmeta.go Make App struct public 6 years ago
instance.go Fix spacing around copyright notices 6 years ago
invites.go Make App struct public 6 years ago
keys.go Break functionality out of Serve() func 6 years ago
nodeinfo.go Add `invites` flag in NodeInfo 6 years ago
pad.go Make App struct public 6 years ago
pages.go Make App struct public 6 years ago
postrender.go Make WriteFreely spacing consistent 6 years ago
posts.go Allow completely private instances, part 1 6 years ago
read.go Remove global hostName var 6 years ago
request.go Fix spacing around copyright notices 6 years ago
routes.go Restrict API read access based on Private setting 6 years ago
schema.sql Set up migrations table on initial setup 6 years ago
session.go Break functionality out of Serve() func 6 years ago
sitemap.go Remove global hostName var 6 years ago
sqlite.sql Set up migrations table on initial setup 6 years ago
templates.go Break functionality out of Serve() func 6 years ago
unregisteredusers.go Make App struct public 6 years ago
users.go Move key generation and Keychain to key pkg 6 years ago
webfinger.go Remove global hostName var 6 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.