https://github.com/ankit-containers/writefreely

Container image for Writefreely
https://github.com/ankit-containers/writefreely

docker golang self-hosted

Last synced: 3 months ago
JSON representation

Container image for Writefreely

• Host: GitHub
• URL: https://github.com/ankit-containers/writefreely
• Owner: ankit-containers
• Archived: true
• Created: 2021-02-27T19:19:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-11T09:56:44.000Z (over 3 years ago)
• Last Synced: 2024-07-08T21:03:37.613Z (7 months ago)
• Topics: docker, golang, self-hosted
• Language: Dockerfile
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Writefreely

[![Registry](https://img.shields.io/badge/registry-quay.io-red)](https://quay.io/repository/ankitrgadiya/writefreely?tab=tags)

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](https://writefreely.org/docs/latest/admin/config)

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.

```bash

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

```