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

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.