WriteFreely è un software libero e open source per costruire uno spazio di scrittura sul web - che sia una pubblicazione, un blog interno o una comunità di scrittura nel fediverso. https://noblogo.org
Go to file
Matt Baer ef40c50920 Link to tutorials on some features
Also, add static pages
2019-01-26 11:59:02 -05:00
.github Add Pull Request template 2019-01-09 18:11:19 -05:00
author Support user invites 2019-01-18 00:05:50 -05:00
cmd/writefreely Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
config Merge pull request #68 from writeas/user-invites 2019-01-23 13:02:16 -05:00
keys Move key generation to app from keys.sh 2018-11-11 17:52:24 -05:00
less Fixes indentation 2019-01-16 23:07:44 +01:00
migrations Set up migrations table on initial setup 2019-01-24 17:08:08 -05:00
page Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
pages Support user invites 2019-01-18 00:05:50 -05:00
parse Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
static Add numeric avatars 2019-01-07 15:40:37 -05:00
templates Support user invites 2019-01-18 00:05:50 -05:00
.dockerignore added .git to make builds cache more effectively and run faster 2018-11-22 06:56:29 -06:00
.gitignore Ignore all .ini files 2019-01-24 17:09:48 -05:00
.travis.yml Add .travis.yml 2018-10-15 14:10:42 -04:00
AUTHORS.md Add @nkoehring to AUTHORS 2019-01-24 17:24:07 -05:00
CONTRIBUTING.md Explain where to post questions, feedback, bugs 2018-11-11 10:30:50 -05:00
Dockerfile Deploy the app in the proper dir for dependency management 2019-01-16 21:05:52 +01:00
LICENSE Use AGPL 2018-10-29 10:06:45 -04:00
Makefile Add make release-linux command 2019-01-10 11:44:30 -05:00
README.md Link to tutorials on some features 2019-01-26 11:59:02 -05:00
account.go Support user invites 2019-01-18 00:05:50 -05:00
activitypub.go Fix AP follower INSERT with SQLite 2019-01-07 14:35:47 -05:00
admin.go Support user invites 2019-01-18 00:05:50 -05:00
app.go Fix --create-user usage error message 2019-01-26 11:11:17 -05:00
auth.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
cache.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
collections.go Add numeric avatars 2019-01-07 15:40:37 -05:00
config.ini.example Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
database-no-sqlite.go Support building without SQLite support 2019-01-03 17:57:06 -05:00
database-sqlite.go Fix tagged posts SQLite query 2019-01-07 11:55:23 -05:00
database.go Support user invites 2019-01-18 00:05:50 -05:00
docker-compose.yml Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
docker-setup.sh Improved the Docker dev workflow slightly. 2018-11-16 14:53:42 -06:00
errors.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
export.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
feed.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
handle.go Send correct status on 410/500 in handleHTTPError 2019-01-03 15:43:44 -05:00
hostmeta.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
instance.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
invites.go Support user invites 2019-01-18 00:05:50 -05:00
keys.go Generate encryption keys in configured directory 2019-01-20 14:18:09 -05:00
nodeinfo.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
pad.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
pages.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
postrender.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
posts.go Extract images with .image extension 2018-12-31 16:19:26 -05:00
read.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
request.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
routes.go Support user invites 2019-01-18 00:05:50 -05:00
schema.sql Set up migrations table on initial setup 2019-01-24 17:08:08 -05:00
session.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
sitemap.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00
sqlite.sql Set up migrations table on initial setup 2019-01-24 17:08:08 -05:00
templates.go Support configuring resource directories 2019-01-18 19:09:27 -05:00
unregisteredusers.go Support user invites 2019-01-18 00:05:50 -05:00
users.go Support user invites 2019-01-18 00:05:50 -05:00
webfinger.go Fix spacing around copyright notices 2018-12-31 01:05:26 -05:00

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 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? Here's a quick overview.

Prerequisites

Setting up

go get -d 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.