Skip to content

nicholaswilde/docker-twtxt

Repository files navigation

Docker twtxt

Docker Image Version (latest by date) Docker Pulls GitHub ci lint pre-commit

A multi-architecture image for twtxt.

Architectures

  • armv7
  • arm64
  • amd64

Dependencies

  • None

Usage

docker cli

$ docker run -d \
  --name=twtxt-default \
  -e TZ=America/Los_Angeles `# optional` \
  -e PUID=1000    `# optional` \
  -e PGID=1000    `# optional` \
  -e OPEN_PROFILES=true \
  -e OPEN_REGISTRATIONS=true \
  -e COOKIE_SECRET=supersecretchangeme \
  -p 8000:8000 \
  --restart unless-stopped \
  nicholaswilde/twtxt

docker-compose

See docker-compose.yaml.

Configuration

user uid
abc 911

See twtxt for more options.

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.