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.
f0x 47e961abb2 remove broken html 7 months ago
.github/ISSUE_TEMPLATE Create issue templates 8 months ago
author Add author package 9 months ago
cmd/writefreely Add make release 8 months ago
config Add site_description config value 7 months ago
keys Move key generation to app from keys.sh 8 months ago
less Support editing About and Privacy pages from Admin panel 8 months ago
page Add handler, page, template loading 8 months ago
pages Show stats on About page if public_stats enabled 7 months ago
parse Fix parse package import 9 months ago
static Locally host MathJax 7 months ago
templates Locally host MathJax 7 months ago
.dockerignore added .git to make builds cache more effectively and run faster 8 months ago
.gitignore Add make release 8 months ago
.travis.yml Add .travis.yml 9 months ago
AUTHORS.md Add @koehn to AUTHORS 8 months ago
CONTRIBUTING.md Explain where to post questions, feedback, bugs 8 months ago
Dockerfile Add openssl and root anchors for federation queries 7 months ago
LICENSE Use AGPL 8 months ago
Makefile Add `make release-docker` 8 months ago
README.md remove broken html 7 months ago
account.go Add basic admin dashboard with app stats 8 months ago
activitypub.go Only log ActivityPub info when debugging 7 months ago
admin.go Add site_description config value 7 months ago
app.go Add --create-admin option 7 months ago
auth.go Fill in remaining missing pieces 8 months ago
cache.go Add login and post cache helpers 8 months ago
collections.go Remove code for CodeHighlighting UI 8 months ago
config.ini.example Improved the Docker dev workflow slightly. 8 months ago
database.go Show instance stats on About page 8 months ago
docker-compose.yml Improved the Docker dev workflow slightly. 8 months ago
docker-setup.sh Improved the Docker dev workflow slightly. 8 months ago
errors.go Fill in remaining missing pieces 8 months ago
export.go Fix Novel blog post order in feeds and outbox 8 months ago
feed.go Fix Novel blog post order in feeds and outbox 8 months ago
handle.go Add basic admin dashboard with app stats 8 months ago
hostmeta.go Add ActivityPub components, routes, handlers 8 months ago
instance.go Show instance stats on About page 8 months ago
keys.go Move key generation to app from keys.sh 8 months ago
nodeinfo.go Add site_description config value 7 months ago
pad.go Fix editing metadata on single-user instances 7 months ago
pages.go Support editing About and Privacy pages from Admin panel 8 months ago
postrender.go Fully support single-user mode 8 months ago
posts.go Fix editing metadata on single-user instances 7 months ago
request.go Add collection handlers, routes, feeds, sitemaps 8 months ago
routes.go Support editing some config values in admin UI 7 months ago
schema.sql Support editing About and Privacy pages from Admin panel 8 months ago
session.go Add collection handlers, routes, feeds, sitemaps 8 months ago
sitemap.go Fix Novel blog post order in feeds and outbox 8 months ago
templates.go Rename render.tmpl to post-render.tmpl 8 months ago
unregisteredusers.go Improve sign up 8 months ago
users.go Add basic admin dashboard with app stats 8 months ago
webfinger.go Add ActivityPub components, routes, handlers 8 months ago

README.md

WriteFreely lain.haus fork

This is a fork from https://github.com/writeas/writefreely/ to fix some things, and make some things better.
Changes so far:

WriteFreely

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.

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.

Packages

WriteFreely is available in these package repositories:

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!

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.