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 3576ab15d1 Create issue templates 5 jaren geleden
.github/ISSUE_TEMPLATE Create issue templates 5 jaren geleden
author Add author package 5 jaren geleden
cmd/writefreely Create basic server 5 jaren geleden
config Fix overflowing green bg in setup titles 5 jaren geleden
keys Move key generation to app from keys.sh 5 jaren geleden
less Fully support single-user mode 5 jaren geleden
page Add handler, page, template loading 5 jaren geleden
pages Fully support single-user mode 5 jaren geleden
parse Fix parse package import 5 jaren geleden
static Fully support single-user mode 5 jaren geleden
templates Use avatar as blog link social media image 5 jaren geleden
.gitignore Clean up .gitignore 5 jaren geleden
.travis.yml Add .travis.yml 5 jaren geleden
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5 jaren geleden
LICENSE Use AGPL 5 jaren geleden
Makefile Move key generation to app from keys.sh 5 jaren geleden
README.md Fix badge 5 jaren geleden
account.go Show number of followers on stats page 5 jaren geleden
activitypub.go Add To and CC on Create activities 5 jaren geleden
app.go Bump version to 0.2 5 jaren geleden
auth.go Fill in remaining missing pieces 5 jaren geleden
cache.go Add login and post cache helpers 5 jaren geleden
collections.go Use avatar as blog link social media image 5 jaren geleden
database.go Insert missing default values on post creation 5 jaren geleden
errors.go Fill in remaining missing pieces 5 jaren geleden
export.go Add collection handlers, routes, feeds, sitemaps 5 jaren geleden
feed.go Add collection handlers, routes, feeds, sitemaps 5 jaren geleden
handle.go Remove r.Host from server logs 5 jaren geleden
hostmeta.go Add ActivityPub components, routes, handlers 5 jaren geleden
keys.go Move key generation to app from keys.sh 5 jaren geleden
nodeinfo.go Fully support single-user mode 5 jaren geleden
pad.go Fully support single-user mode 5 jaren geleden
postrender.go Fully support single-user mode 5 jaren geleden
posts.go Support retrieving posts as AS2 object 5 jaren geleden
request.go Add collection handlers, routes, feeds, sitemaps 5 jaren geleden
routes.go Fully support single-user mode 5 jaren geleden
schema.sql Remove unneeded followers column from remoteusers 5 jaren geleden
session.go Add collection handlers, routes, feeds, sitemaps 5 jaren geleden
sitemap.go Add collection handlers, routes, feeds, sitemaps 5 jaren geleden
templates.go Fix template loading on Windows 5 jaren geleden
unregisteredusers.go Improve sign up 5 jaren geleden
users.go Fill in remaining missing pieces 5 jaren geleden
webfinger.go Add ActivityPub components, routes, handlers 5 jaren geleden

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) Import the schema with:
mysql -u YOURUSERNAME -p writefreely < schema.sql

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

# 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

Create your database, import the schema, and configure your site 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

License

Licensed under the AGPL.