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