thespad/twitfix repository overview

⁠thespad/twitfix⁠

twitfix⁠ Basic flask server that serves fixed twitter video embeds to desktop discord by using either the Twitter API or Youtube-DL to grab tweet video information.

⁠Supported Architectures

Our images support multiple architectures.

Simply pulling ghcr.io/thespad/twitfix:latest should retrieve the correct image for your arch.

The architectures supported by this image are:

⁠Application Setup

Webui is accessible at http://SERVERIP:PORT

More info at twitfix⁠.

⁠Usage

Here are some example snippets to help you get started creating a container.

⁠docker-compose (recommended⁠)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  twitfix:
    image: ghcr.io/thespad/twitfix:latest
    container_name: twitfix
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - ACCESS_SECRET=12345
      - ACCESS_TOKEN=67890
      - API_KEY=adcdef
      - API_SECRET=ghijkl
      - APPNAME=Twitfix
      - "COLOR=#43B581"
      - DATABASE=mongodb://twitfix_db:27017/twitfix
      - LINK_CACHE=db
      - METHOD=youtube-dl
      - URL=https://twitfix.example.com
    volumes:
      - /path/to/appdata/config:/config
    ports:
      - 80:80
    restart: unless-stopped

⁠docker cli

docker run -d \
  --name=twitfix \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e ACCESS_SECRET=12345
  -e ACCESS_TOKEN=67890
  -e API_KEY=adcdef
  -e API_SECRET=ghijkl
  -e APPNAME=Twitfix
  -e "COLOR=#43B581"
  -e DATABASE=mongodb://twitfix_db:27017/twitfix
  -e LINK_CACHE=db
  -e METHOD=youtube-dl
  -e URL=https://twitfix.example.com
  -p 80:80 \
  -v /path/to/appdata/config:/config \
  --restart unless-stopped \
  ghcr.io/thespad/twitfix:latest

⁠Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

⁠User / Group Identifiers

When using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

⁠Support Info

• Shell access whilst the container is running: docker exec -it twitfix /bin/bash
• To monitor the logs of the container in realtime: docker logs -f twitfix

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun⁠ for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

⁠Versions

• 14.05.23: - Rebase to Alpine 3.18. Drop support for armhf.
• 09.12.22: - Rebase to Alpine 3.17.
• 06.06.22: - Switch to dylanpdx/BetterTwitFix for upstream
• 16.05.22: - Initial Release.