Container image for Writefreely
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.
 
Go to file
Ankit R Gadiya eae2ffe896
writefreely: version bump v0.13.1
2 years ago
.github/workflows Migrated to Github 2 years ago
.gitignore Initial commit 3 years ago
Dockerfile writefreely: version bump v0.13.1 2 years ago
README.md Migrated to Github 2 years ago
config.sample.ini config: Added a sample configuration file 3 years ago

README.md

Writefreely

Registry

WriteFreely is the Golang based open-source version of the amazingly minimalist and privacy-focused blogging platform, Write.as. It can run in Single-mode for a single blog or Community mode. WriteFreely also supports federation into the Fediverse.

The Write.as platform is the primary managed instance of WriteFreely with more features. Write.as also integrates with image hosting service Snap.as. The platform uses a subscription-based model and offers a free account as well. The team also provides managed private instances of WriteFreely.

The WriteFreely project ships a tarball that includes a statically compiled binary, static web assets (JS, CSS), and templates for the pages. It is possible to deploy it directly to the public web or behind a reverse proxy. WriteFreely supports multiple databases, including SQLite3, MySQL, and PostgreSQL.

This repository packages WriteFreely in a Docker image to run it in the container.

Usage

WriteFreely uses a single config.ini file for its configuration. Check the configuration documentation for all possible configuration fields. Create the file on the local machine. We will then mount this file as a volume in the container. In case of SQLite3 Database, you need to mount an additional volume to persist the data. Remember to modify the configurations to match the path to the mounted volume.

docker run -d \
  --name "writefreely" \
  -v /path/to/config-dir:/config \
  -v /path/to/sqlite-data:/data \  # Optional
  -p 8080:8080 \                   # Change according to the port in configuration
  quay.io/ankitrgadiya/writefreely:latest
  /writefreely/writefreely -c /config/config.ini