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 426fa01fb4 Explain where to post questions, feedback, bugs преди 5 години
author Add author package преди 5 години
cmd/writefreely Create basic server преди 5 години
config Fix overflowing green bg in setup titles преди 5 години
keys Add key generation script + keys folder преди 5 години
less Fully support single-user mode преди 5 години
page Add handler, page, template loading преди 5 години
pages Fully support single-user mode преди 5 години
parse Fix parse package import преди 5 години
static Fully support single-user mode преди 5 години
templates Fully support single-user mode преди 5 години
.gitignore Clean up .gitignore преди 5 години
.travis.yml Add .travis.yml преди 5 години
CONTRIBUTING.md Explain where to post questions, feedback, bugs преди 5 години
LICENSE Use AGPL преди 5 години
Makefile Log more when building преди 5 години
README.md Add info about running in production преди 5 години
account.go Show number of followers on stats page преди 5 години
activitypub.go Use hostname in AP requests' User-Agent header преди 5 години
app.go Fix unnecessarily connecting to DB after multi-user config преди 5 години
auth.go Fill in remaining missing pieces преди 5 години
cache.go Add login and post cache helpers преди 5 години
collections.go Fix ActivityPub endpoint URLs преди 5 години
database.go Insert default values on collection creation преди 5 години
errors.go Fill in remaining missing pieces преди 5 години
export.go Add collection handlers, routes, feeds, sitemaps преди 5 години
feed.go Add collection handlers, routes, feeds, sitemaps преди 5 години
handle.go Remove r.Host from server logs преди 5 години
hostmeta.go Add ActivityPub components, routes, handlers преди 5 години
keys.go Add web session management преди 5 години
keys.sh Fix filename in email encryption key generation преди 5 години
nodeinfo.go Fully support single-user mode преди 5 години
pad.go Fully support single-user mode преди 5 години
postrender.go Fully support single-user mode преди 5 години
posts.go Support retrieving posts as AS2 object преди 5 години
request.go Add collection handlers, routes, feeds, sitemaps преди 5 години
routes.go Fully support single-user mode преди 5 години
schema.sql Remove default value for `posts`.`updated` преди 5 години
session.go Add collection handlers, routes, feeds, sitemaps преди 5 години
sitemap.go Add collection handlers, routes, feeds, sitemaps преди 5 години
templates.go Fix template loading on Windows преди 5 години
unregisteredusers.go Improve sign up преди 5 години
users.go Fill in remaining missing pieces преди 5 години
webfinger.go Add ActivityPub components, routes, handlers преди 5 години

README.md

 

Write Freely


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 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 (especially for production)
./keys.sh

# 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.

Now generate the CSS:

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.