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

A multi-architecture image for twtxt.
https://github.com/nicholaswilde/docker-twtxt

blogging docker docker-image go golang micro-blogging sefl-hosted social-media social-network twtxt

Last synced: about 2 months ago
JSON representation

A multi-architecture image for twtxt.

• Host: GitHub
• URL: https://github.com/nicholaswilde/docker-twtxt
• Owner: nicholaswilde
• License: apache-2.0
• Created: 2021-02-27T22:50:02.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-10T16:57:53.000Z (about 2 years ago)
• Last Synced: 2025-01-22T22:29:48.909Z (3 months ago)
• Topics: blogging, docker, docker-image, go, golang, micro-blogging, sefl-hosted, social-media, social-network, twtxt
• Language: Dockerfile
• Homepage: https://hub.docker.com/r/nicholaswilde/twtxt
• Size: 56.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Docker twtxt

[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/nicholaswilde/twtxt)](https://hub.docker.com/r/nicholaswilde/twtxt)

[![Docker Pulls](https://img.shields.io/docker/pulls/nicholaswilde/twtxt)](https://hub.docker.com/r/nicholaswilde/twtxt)

[![GitHub](https://img.shields.io/github/license/nicholaswilde/docker-twtxt)](./LICENSE)

[![ci](https://github.com/nicholaswilde/docker-twtxt/workflows/ci/badge.svg)](https://github.com/nicholaswilde/docker-twtxt/actions?query=workflow%3Aci)

[![lint](https://github.com/nicholaswilde/docker-twtxt/workflows/lint/badge.svg?branch=main)](https://github.com/nicholaswilde/docker-twtxt/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 [twtxt](https://github.com/jointwt/twtxt).

## Architectures

* [x] `armv7`

* [x] `arm64`

* [x] `amd64`

## Dependencies

* None

## Usage

### docker cli

```bash

$ 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](./docker-compose.yaml).

## Configuration

|user | uid |

|----:|:---:|

| abc | 911 |

See [twtxt](https://github.com/prologic/twtxt#usage) for more options.

## 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/).