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

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.