An open API service indexing awesome lists of open source software.

https://github.com/nicholaswilde/docker-writefreely

A multi-arch Docker image for writefreely
https://github.com/nicholaswilde/docker-writefreely

docker writefreely

Last synced: 2 months ago
JSON representation

A multi-arch Docker image for writefreely

Awesome Lists containing this project

README

        

# Docker WriteFreely
[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/nicholaswilde/writefreely)](https://hub.docker.com/r/nicholaswilde/writefreely)
[![Docker Pulls](https://img.shields.io/docker/pulls/nicholaswilde/writefreely)](https://hub.docker.com/r/nicholaswilde/writefreely)
[![GitHub](https://img.shields.io/github/license/nicholaswilde/docker-writefreely)](./LICENSE)
[![ci](https://github.com/nicholaswilde/docker-writefreely/workflows/ci/badge.svg)](https://github.com/nicholaswilde/docker-writefreely/actions?query=workflow%3Aci)
[![lint](https://github.com/nicholaswilde/docker-writefreely/workflows/lint/badge.svg?branch=main)](https://github.com/nicholaswilde/docker-writefreely/actions?query=workflow%3Alint)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

A multi-architecture image for [writefreely](https://github.com/writefreely/writefreely).

## Architectures

* [x] `armv7`
* [x] `arm64`
* [x] `amd64`

## Dependencies

* None

## Usage
### docker cli

```bash
$ docker run -d \
--name=writefreely-default \
-e TZ=America/Los_Angeles `# optional` \
-e PUID=1000 `# optional` \
-e PGID=1000 `# optional` \
-p 8080:8080 \
--restart unless-stopped \
nicholaswilde/writefreely
```

### docker-compose

See [docker-compose.yaml](./docker-compose.yaml).

## Configuration

|user | uid |
|----:|:---:|
| abc | 911 |

## Development

See [docs](https://nicholaswilde.io/docker-docs/development/).

## Troubleshooting

See [docs](https://nicholaswilde.io/docker-docs/troubleshooting/).

## Pre-commit hook

If you want to automatically generate `README.md` files with a pre-commit hook, make sure you
[install the pre-commit binary](https://pre-commit.com/#install), and add a [.pre-commit-config.yaml file](./.pre-commit-config.yaml)
to your project. Then run:

```bash
$ pre-commit install
$ pre-commit install-hooks
```
Currently, this only works on `amd64` systems.

## License

[Apache 2.0 License](./LICENSE)

## Author
This project was started in 2021 by [Nicholas Wilde](https://github.com/nicholaswilde/).