A clean, Markdown-based publishing platform made for writers. Write together, and build a community. https://writefreely.org
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 
 
 
 
Matt Baer 3a6118c207 Set up migrations table on initial setup 5年前
.github Add Pull Request template 5年前
author Support user invites 5年前
cmd/writefreely Fix spacing around copyright notices 5年前
config Merge pull request #68 from writeas/user-invites 5年前
keys Move key generation to app from keys.sh 5年前
less Fix rendered sublist spacing 5年前
migrations Set up migrations table on initial setup 5年前
page Fix spacing around copyright notices 5年前
pages Support user invites 5年前
parse Fix spacing around copyright notices 5年前
static Add numeric avatars 5年前
templates Support user invites 5年前
.dockerignore added .git to make builds cache more effectively and run faster 5年前
.gitignore Embed schema files in binary 5年前
.travis.yml Add .travis.yml 5年前
AUTHORS.md Add @geekgonecrazy to authors 5年前
CONTRIBUTING.md Explain where to post questions, feedback, bugs 5年前
Dockerfile Deploy the app in the proper dir for dependency management 5年前
LICENSE Use AGPL 5年前
Makefile Add make release-linux command 5年前
README.md Update import schema step 5年前
account.go Support user invites 5年前
activitypub.go Fix AP follower INSERT with SQLite 5年前
admin.go Support user invites 5年前
app.go Set up migrations table on initial setup 5年前
auth.go Fix spacing around copyright notices 5年前
cache.go Fix spacing around copyright notices 5年前
collections.go Add numeric avatars 5年前
config.ini.example Improved the Docker dev workflow slightly. 5年前
database-no-sqlite.go Support building without SQLite support 5年前
database-sqlite.go Fix tagged posts SQLite query 5年前
database.go Support user invites 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 Fix spacing around copyright notices 5年前
feed.go Fix spacing around copyright notices 5年前
handle.go Send correct status on 410/500 in handleHTTPError 5年前
hostmeta.go Fix spacing around copyright notices 5年前
instance.go Fix spacing around copyright notices 5年前
invites.go Support user invites 5年前
keys.go Generate encryption keys in configured directory 5年前
nodeinfo.go Fix spacing around copyright notices 5年前
pad.go Fix spacing around copyright notices 5年前
pages.go Fix spacing around copyright notices 5年前
postrender.go Fix spacing around copyright notices 5年前
posts.go Extract images with .image extension 5年前
read.go Fix spacing around copyright notices 5年前
request.go Fix spacing around copyright notices 5年前
routes.go Support user invites 5年前
schema.sql Set up migrations table on initial setup 5年前
session.go Fix spacing around copyright notices 5年前
sitemap.go Fix spacing around copyright notices 5年前
sqlite.sql Set up migrations table on initial setup 5年前
templates.go Support configuring resource directories 5年前
unregisteredusers.go Support user invites 5年前
users.go Support user invites 5年前
webfinger.go Fix spacing around copyright notices 5年前

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, and organize posts with hashtags
  • 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 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.