Go to file
Ben Overmyer 2de37a4ddb Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
.github/ISSUE_TEMPLATE Create issue templates 2018-11-12 20:12:31 -05:00
author Add author package 2018-10-16 23:27:04 -04:00
cmd/writefreely Create basic server 2018-10-15 14:44:15 -04:00
config Fix overflowing green bg in setup titles 2018-11-10 21:44:41 -05:00
keys Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
less Fully support single-user mode 2018-11-09 22:10:46 -05:00
page Add handler, page, template loading 2018-11-07 23:50:50 -05:00
pages Fully support single-user mode 2018-11-09 22:10:46 -05:00
parse Fix parse package import 2018-10-16 23:49:01 -04:00
static Fully support single-user mode 2018-11-09 22:10:46 -05:00
templates Remove JS editor remnants 2018-11-16 12:20:36 -05:00
.gitignore Clean up .gitignore 2018-10-16 20:41:54 -04:00
.travis.yml Add .travis.yml 2018-10-15 14:10:42 -04:00
CONTRIBUTING.md Explain where to post questions, feedback, bugs 2018-11-11 10:30:50 -05:00
Dockerfile Add Dockerfile and Docker Compose files 2018-11-13 20:24:06 -08:00
LICENSE Use AGPL 2018-10-29 10:06:45 -04:00
Makefile Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
README.md Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
account.go Show number of followers on stats page 2018-11-10 20:56:36 -05:00
activitypub.go Use Accept ID on blog's origin 2018-11-15 17:05:33 -05:00
admin.go Add --reset-pass option for admin pass reset 2018-11-14 15:03:22 -05:00
app.go Support outputting version with -v flag 2018-11-15 14:51:03 -05:00
auth.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
cache.go Add login and post cache helpers 2018-11-07 22:07:33 -05:00
collections.go Use avatar as blog link social media image 2018-11-11 15:34:26 -05:00
config.ini.example Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
database.go Federate draft when published to a blog 2018-11-16 12:42:21 -05: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
errors.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
export.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
feed.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
handle.go Remove r.Host from server logs 2018-11-11 09:40:18 -05:00
hostmeta.go Add ActivityPub components, routes, handlers 2018-11-08 01:28:08 -05:00
keys.go Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
nodeinfo.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
pad.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
postrender.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
posts.go Federate draft when published to a blog 2018-11-16 12:42:21 -05:00
request.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
routes.go Fully support single-user mode 2018-11-09 22:10:46 -05:00
schema.sql Provide default `updated` value 2018-11-13 08:52:42 -05:00
session.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
sitemap.go Add collection handlers, routes, feeds, sitemaps 2018-11-08 01:22:18 -05:00
templates.go Fix template loading on Windows 2018-11-09 14:40:47 -05:00
unregisteredusers.go Improve sign up 2018-11-09 14:51:11 -05:00
users.go Fill in remaining missing pieces 2018-11-08 01:33:26 -05:00
webfinger.go Add ActivityPub components, routes, handlers 2018-11-08 01:28:08 -05:00

README.md

 

Write Freely


Latest release Go Report Card Build status #writefreely on freenode

 

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) Configure your blog
./writefreely --config

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

Development

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

Prerequisites

Setting up

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

Configure your site, create your database, and import the schema as shown above. Then generate the remaining files you'll need:

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

Docker

Using Docker for Development

If you'd like to use Docker as a base for working on a site's styles and such, you can run the following from a Bash shell.

Note: This process is intended only for working on site styling. If you'd like to run Write Freely in production as a Docker service, it'll require a little more work.

The docker-setup.sh script will present you with a few questions to set up your dev instance. You can hit enter for most of them, except for "Admin username" and "Admin password." You'll probably have to wait a few seconds after running docker-compose up -d for the Docker services to come up before running the bash script.

docker-compose up -d
./docker-setup.sh

Now you should be able to navigate to http://localhost:8080 and start working!

When you're completely done working, you can run docker-compose down to destroy your virtual environment, including your database data. Otherwise, docker-compose stop will shut down your environment without destroying your data.

Using Docker for Production

Write Freely doesn't yet provide an official Docker pathway to production. We're working on it, though!

License

Licensed under the AGPL.