A simple, federated blogging platform.
Switch branches/tags
Clone or download
thebaer Support editing About and Privacy pages from Admin panel
This allows admin to edit these pages from the web, using Markdown. It
also dynamically loads information on those pages now, and makes loading
`pages` templates a little easier to find in the code / more explicit.

It requires this new schema change:

CREATE TABLE IF NOT EXISTS `appcontent` (
  `id` varchar(36) NOT NULL,
  `content` mediumtext CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
  `updated` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

This closes T533
Latest commit bdc4f27 Nov 18, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Create issue templates Nov 13, 2018
author Add author package Oct 17, 2018
cmd/writefreely Create basic server Oct 15, 2018
config Fix overflowing green bg in setup titles Nov 11, 2018
keys Move key generation to app from keys.sh Nov 11, 2018
less Support editing About and Privacy pages from Admin panel Nov 19, 2018
page Add handler, page, template loading Nov 8, 2018
pages Support editing About and Privacy pages from Admin panel Nov 19, 2018
parse Fix parse package import Oct 17, 2018
static Upgrade Lora to v2.202 (cyrillic) Nov 18, 2018
templates Support editing About and Privacy pages from Admin panel Nov 19, 2018
.gitignore Clean up .gitignore Oct 17, 2018
.travis.yml Add .travis.yml Oct 15, 2018
CONTRIBUTING.md Explain where to post questions, feedback, bugs Nov 11, 2018
Dockerfile Add Dockerfile and Docker Compose files Nov 14, 2018
LICENSE Use AGPL Oct 29, 2018
Makefile Move key generation to app from keys.sh Nov 11, 2018
README.md Improved the Docker dev workflow slightly. Nov 16, 2018
account.go Add basic admin dashboard with app stats Nov 19, 2018
activitypub.go Fix Novel blog post order in feeds and outbox Nov 18, 2018
admin.go Support editing About and Privacy pages from Admin panel Nov 19, 2018
app.go Support editing About and Privacy pages from Admin panel Nov 19, 2018
auth.go Fill in remaining missing pieces Nov 8, 2018
cache.go Add login and post cache helpers Nov 8, 2018
collections.go Accept different `created` time on post publish Nov 18, 2018
config.ini.example Improved the Docker dev workflow slightly. Nov 16, 2018
database.go Support editing About and Privacy pages from Admin panel Nov 19, 2018
docker-compose.yml Improved the Docker dev workflow slightly. Nov 16, 2018
docker-setup.sh Improved the Docker dev workflow slightly. Nov 16, 2018
errors.go Fill in remaining missing pieces Nov 8, 2018
export.go Fix Novel blog post order in feeds and outbox Nov 18, 2018
feed.go Fix Novel blog post order in feeds and outbox Nov 18, 2018
handle.go Add basic admin dashboard with app stats Nov 19, 2018
hostmeta.go Add ActivityPub components, routes, handlers Nov 8, 2018
keys.go Move key generation to app from keys.sh Nov 11, 2018
nodeinfo.go Fully support single-user mode Nov 10, 2018
pad.go Fully support single-user mode Nov 10, 2018
pages.go Support editing About and Privacy pages from Admin panel Nov 19, 2018
postrender.go Fully support single-user mode Nov 10, 2018
posts.go Support editing About and Privacy pages from Admin panel Nov 19, 2018
request.go Add collection handlers, routes, feeds, sitemaps Nov 8, 2018
routes.go Support editing About and Privacy pages from Admin panel Nov 19, 2018
schema.sql Support editing About and Privacy pages from Admin panel Nov 19, 2018
session.go Add collection handlers, routes, feeds, sitemaps Nov 8, 2018
sitemap.go Fix Novel blog post order in feeds and outbox Nov 18, 2018
templates.go Fix template loading on Windows Nov 9, 2018
unregisteredusers.go Improve sign up Nov 9, 2018
users.go Add basic admin dashboard with app stats Nov 19, 2018
webfinger.go Add ActivityPub components, routes, handlers Nov 8, 2018

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.