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 034db22f8c Break functionality out of Serve() func преди 5 години
.github Automatically assign "bug?" label to bug reports преди 5 години
author Fix IsValidUsername check when PagesParentDir isn't current dir преди 5 години
cmd/writefreely Break functionality out of Serve() func преди 5 години
config Support changing default landing path преди 5 години
key Move key generation and Keychain to key pkg преди 5 години
keys Move key generation to app from keys.sh преди 5 години
less Modified less/Makefile: added /bin/lessc path which is returned by which lessc in CentOS 7 when lessc is installed via npm. преди 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 години
static Fix draft post metadata преди 5 години
templates Fix draft post metadata преди 5 години
.dockerignore added .git to make builds cache more effectively and run faster преди 5 години
.gitignore Fix go-bindata error in Travis build преди 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 Include -config and -init-db steps in make install преди 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 Use db.isDuplicateKeyErr() in activitypub.go преди 5 години
admin.go Make App struct public преди 5 години
app.go Break functionality out of Serve() func преди 5 години
auth.go Fix spacing around copyright notices преди 5 години
cache.go Fix spacing around copyright notices преди 5 години
collections.go Make App struct public преди 5 години
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 Move key generation and Keychain to key pkg преди 5 години
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 Make App struct public преди 5 години
feed.go Make App struct public преди 5 години
go.mod Add `invites` flag in NodeInfo преди 5 години
go.sum Add `invites` flag in NodeInfo преди 5 години
handle.go Break functionality out of Serve() func преди 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 Move static file ServeMux to App struct преди 5 години
read.go Make App struct public преди 5 години
request.go Fix spacing around copyright notices преди 5 години
routes.go Break functionality out of Serve() func преди 5 години
schema.sql Set up migrations table on initial setup преди 5 години
session.go Break functionality out of Serve() func преди 5 години
sitemap.go Make App struct public преди 5 години
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 Fix spacing around copyright notices преди 5 години

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.