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.
 
 
 
 
 
Michael Demetriou a102f97c3e Fix #96 5 年之前
.github Automatically assign "bug?" label to bug reports 5 年之前
author Fix IsValidUsername check when PagesParentDir isn't current dir 5 年之前
cmd/writefreely Save config via Apper interface from Admin dash 5 年之前
config Support changing default landing path 5 年之前
key Add TODO for multierror 4 年之前
keys Move key generation to app from keys.sh 5 年之前
less Add spacing around time element on index pages 5 年之前
migrations Run migrations on db initialization 5 年之前
page Link to version-specific writer's guide 5 年之前
pages Make WriteFreely spacing consistent 5 年之前
parse Describe package parse 5 年之前
scripts fix: update script: non-standard version numbers 4 年之前
static Move MathJax to git submodule 5 年之前
templates Change `sh` alias back to `bash` 4 年之前
.dockerignore added .git to make builds cache more effectively and run faster 5 年之前
.gitignore Fix go-bindata error in Travis build 5 年之前
.gitmodules Use HTTP for MathJax submodule 5 年之前
.travis.yml Fix go-bindata error in Travis build 5 年之前
AUTHORS.md Add @nkoehring to AUTHORS 5 年之前
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5 年之前
Dockerfile Install the writefreely cmd properly 5 年之前
LICENSE Use AGPL 5 年之前
Makefile Merge branch 'develop' into librarization 5 年之前
README.md Include -config and -init-db steps in make install 5 年之前
account.go Move key generation and Keychain to key pkg 5 年之前
activitypub.go Fix more missing hostNames 4 年之前
activitypub_test.go fixes issue #100 - can't follow from pubgate 5 年之前
admin.go Support changing landing conf val from Admin UI 4 年之前
app.go Add TODO for multierror 4 年之前
auth.go Fix spacing around copyright notices 5 年之前
bindata-lib.go Include schema.sql when built with wflib tag 5 年之前
cache.go Fix spacing around copyright notices 5 年之前
collections.go Remove global hostName var 4 年之前
config.ini.example Make WriteFreely spacing consistent 5 年之前
database-lib.go Allow compiling without go-sql-driver/mysql pkg 5 年之前
database-no-sqlite.go Allow compiling without go-sql-driver/mysql pkg 5 年之前
database-sqlite.go Allow compiling without go-sql-driver/mysql pkg 5 年之前
database.go Fix #96 4 年之前
docker-compose.yml Improved the Docker dev workflow slightly. 5 年之前
docker-setup.sh Improved the Docker dev workflow slightly. 5 年之前
errors.go Fix spacing around copyright notices 5 年之前
export.go Merge branch 'develop' into librarization 5 年之前
feed.go Remove global hostName var 4 年之前
go.mod Add go-bindata as a module dependency 5 年之前
go.sum Add go-bindata as a module dependency 5 年之前
handle.go Save config via Apper interface from Admin dash 5 年之前
hostmeta.go Make App struct public 5 年之前
instance.go Fix spacing around copyright notices 5 年之前
invites.go Make App struct public 5 年之前
keys.go Break functionality out of Serve() func 5 年之前
nodeinfo.go Add `invites` flag in NodeInfo 5 年之前
pad.go Make App struct public 5 年之前
pages.go Make App struct public 5 年之前
postrender.go Make WriteFreely spacing consistent 5 年之前
posts.go Fix more missing hostNames 4 年之前
read.go Remove global hostName var 4 年之前
request.go Fix spacing around copyright notices 5 年之前
routes.go Save config via Apper interface from Admin dash 5 年之前
schema.sql Set up migrations table on initial setup 5 年之前
session.go Break functionality out of Serve() func 5 年之前
sitemap.go Remove global hostName var 4 年之前
sqlite.sql Set up migrations table on initial setup 5 年之前
templates.go Break functionality out of Serve() func 5 年之前
unregisteredusers.go Make App struct public 5 年之前
users.go Move key generation and Keychain to key pkg 5 年之前
webfinger.go Remove global hostName var 4 年之前

README.md

 

WriteFreely


Latest release Go Report Card Build status

 

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 light enough to run on a Raspberry Pi.

Try the editor

Find an 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 fast, dead-simple, and distraction-free editor
  • Format text with Markdown
  • Organize posts with hashtags
  • Create static pages
  • Publish drafts and let others proofread them by sharing a private link
  • Create multiple lightweight blogs under a single account
  • Export all data in plain text files
  • Read a stream of other posts in your writing community
  • Build more advanced apps and extensions with the well-documented API
  • Designed around user privacy and consent

Hosting

We offer two kinds of hosting services that make WriteFreely deployment painless: Write.as for individuals, and WriteFreely.host for communities. Besides saving you time, as a customer you directly help fund WriteFreely development.

Write.as

Start a personal blog on Write.as, our flagship instance. Built to eliminate setup friction and preserve your privacy, Write.as helps you start a blog in seconds. It supports custom domains (with SSL) and multiple blogs / pen names per account. Read more here.

WriteFreely.host

WriteFreely.host makes it easy to start a close-knit community — to share knowledge, complement your Mastodon instance, or publish updates in your organization. We take care of the hosting, upgrades, backups, and maintenance so you can focus on writing.

Quick start

WriteFreely has minimal requirements to get up and running — you only need to be able to run an executable.

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

# 2) (if you chose MySQL in the previous step) Log into MySQL and run:
# CREATE DATABASE writefreely;

# 3) (if you chose Multi-user setup) 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.

Packages

WriteFreely is available in these package repositories:

Development

Ready to hack on your site? Get started with our developer guide.

Docker

Read about using Docker in the documentation.

Contributing

We gladly welcome contributions to WriteFreely, whether in the form of code, bug reports, feature requests, translations, or documentation improvements.

Before contributing anything, please read our Contributing Guide. It describes the correct channels for submitting contributions and any potential requirements.

License

Licensed under the AGPL.