writefreely

A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org

Matt Baer 426fa01fb4 Explain where to post questions, feedback, bugs		vor 5 Jahren
author	Add author package	vor 5 Jahren
cmd/writefreely	Create basic server	vor 5 Jahren
config	Fix overflowing green bg in setup titles	vor 5 Jahren
keys	Add key generation script + keys folder	vor 5 Jahren
less	Fully support single-user mode	vor 5 Jahren
page	Add handler, page, template loading	vor 5 Jahren
pages	Fully support single-user mode	vor 5 Jahren
parse	Fix parse package import	vor 5 Jahren
static	Fully support single-user mode	vor 5 Jahren
templates	Fully support single-user mode	vor 5 Jahren
.gitignore	Clean up .gitignore	vor 5 Jahren
.travis.yml	Add .travis.yml	vor 5 Jahren
CONTRIBUTING.md	Explain where to post questions, feedback, bugs	vor 5 Jahren
LICENSE	Use AGPL	vor 5 Jahren
Makefile	Log more when building	vor 5 Jahren
README.md	Add info about running in production	vor 5 Jahren
account.go	Show number of followers on stats page	vor 5 Jahren
activitypub.go	Use hostname in AP requests' User-Agent header	vor 5 Jahren
app.go	Fix unnecessarily connecting to DB after multi-user config	vor 5 Jahren
auth.go	Fill in remaining missing pieces	vor 5 Jahren
cache.go	Add login and post cache helpers	vor 5 Jahren
collections.go	Fix ActivityPub endpoint URLs	vor 5 Jahren
database.go	Insert default values on collection creation	vor 5 Jahren
errors.go	Fill in remaining missing pieces	vor 5 Jahren
export.go	Add collection handlers, routes, feeds, sitemaps	vor 5 Jahren
feed.go	Add collection handlers, routes, feeds, sitemaps	vor 5 Jahren
handle.go	Remove r.Host from server logs	vor 5 Jahren
hostmeta.go	Add ActivityPub components, routes, handlers	vor 5 Jahren
keys.go	Add web session management	vor 5 Jahren
keys.sh	Fix filename in email encryption key generation	vor 5 Jahren
nodeinfo.go	Fully support single-user mode	vor 5 Jahren
pad.go	Fully support single-user mode	vor 5 Jahren
postrender.go	Fully support single-user mode	vor 5 Jahren
posts.go	Support retrieving posts as AS2 object	vor 5 Jahren
request.go	Add collection handlers, routes, feeds, sitemaps	vor 5 Jahren
routes.go	Fully support single-user mode	vor 5 Jahren
schema.sql	Remove default value for `posts`.`updated`	vor 5 Jahren
session.go	Add collection handlers, routes, feeds, sitemaps	vor 5 Jahren
sitemap.go	Add collection handlers, routes, feeds, sitemaps	vor 5 Jahren
templates.go	Fix template loading on Windows	vor 5 Jahren
unregisteredusers.go	Improve sign up	vor 5 Jahren
users.go	Fill in remaining missing pieces	vor 5 Jahren
webfinger.go	Add ActivityPub components, routes, handlers	vor 5 Jahren

README.md

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

Start a blog on our instance

Try the editor

Find another 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 dead-simple, distraction-free and super fast editor
Publish drafts and let others proofread them by sharing a private link
Build more advanced apps and extensions with the well-documented API

Quick start

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) Log into MySQL and run:
# CREATE DATABASE writefreely;
#
# 2) Import the schema with:
mysql -u YOURUSERNAME -p writefreely < schema.sql

# 3) Configure your blog
./writefreely --config

# 4) Generate data encryption keys (especially for production)
./keys.sh

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

Development

Ready to hack on your site? Here’s a quick overview.

Prerequisites

Setting up

go get github.com/writeas/writefreely/cmd/writefreely

Create your database, import the schema, and configure your site as shown above.

Now generate the CSS:

make install # Generates encryption keys; installs LESS compiler
make ui      # Generates CSS (run this whenever you update your styles)
make run     # Runs the application

License

Licensed under the AGPL.