Docker Template

A multi-architecture image for shiori.

Architectures

• armv7
• arm64
• amd64

Dependencies

• sqlite3
• mysql (optional)
• postgres (optional)

Usage

docker cli

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

docker-compose

• sqlite3
• mysql
• postgres

Configuration

Default Web Interface

Volumes

Development

See docs.

Troubleshooting

See docs.

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, and add a .pre-commit-config.yaml file to your project. Then run:

$ pre-commit install
$ pre-commit install-hooks

Currently, this only works on amd64 systems.

License

Apache 2.0 License

Author

This project was started in 2021 by Nicholas Wilde.