mouse_ran_down 0.0.6

Bring media from shared links directly into Telegram chats.

Mouse Ran Down

This is a Telegram bot.

When added to a group, any shared public X/Reddit/Instagram/TikTok/Bluesky/YouTube/Vimeo/SoundCloud/Bandcamp/Mastodon posts with media will be replied to with the media uploaded directly into the chat, along with a preview image.

You can also send links as direct (or forwarded) messages to the bot.

If you have Telegram Premium or a Business account, you can add the bot to any or all of your one-on-one chats, as well. In that case, it will look to the other party as if you personally sent the media.

Normally, entire accounts, playlists, and albums won't be loaded. You can insist that the bot try to load a link by including the bot's name in the same message (e.g. @MouseRanDownBot).

Currently running at @MouseRanDownBot.

I do not guarantee any level of service or privacy, so I encourage you to run it yourself.

Credentials

Copy credentials.example.nt to credentials.nt and insert at least a Telegram bot token.

Comment out, delete, or use empty values for any unused fields.

Telegram

Use Telegram's @BotFather to create a bot and get its token.

Ensure you give it permission to read group messages by disabling privacy mode.

Cookies

The optional cookies entry helps if using the bot for reddit video links, and age-restricted content and such on other platforms. You can get the cookie content in the right format with yt-dlp's --cookies and --cookies-from-browser options, or a browser extension like cookies.txt (I can't vouch for the security of this or any extension).

Installing directly

You can use pip/pipx/uv/zpy etc. to install the package from PyPI, e.g.:

$ uv tool install mouse-ran-down
$ uv tool install 'mouse-ran-down[sentry]'  # for Sentry/GlitchTip integration

To run it effectively you'll need to install ffmpeg and mailcap, and you might benefit from installing atomicparsley.

Run mouse-ran-down --help for usage.

You may prefer to just use the container image from my registry (see below).

Build the container image

Make container image with ./mk/ctnr.sh:

$ ./mk/ctnr.sh -h
Build a container image for Mouse Ran Down
Usage: ./mk/ctnr.sh [--connect-repo URL] [<image>]
  <image> defaults to ghcr.io/andydecleyre/mouse-ran-down

Run the container

If doing any of these for a rootless container on a Systemd-using server, don't forget to run this once:

$ loginctl enable-linger

Otherwise podman will kill the container on logout.

From a local image

Run the container from a local image ghcr.io/andydecleyre/mouse-ran-down with:

$ podman run --rm -d -v ./credentials.nt:/app/credentials.nt:ro ghcr.io/andydecleyre/mouse-ran-down

From an image pushed to a registry

./start/podman.sh:

$ ./start/podman.sh -h
Usage: ./start/podman.sh [-n <name>] [-i <image>] [-t <tag>] [-c] [<credentials-file>]
  -n <name>: name of the container (default: mouse)
  -i <image>: name of the image (default: ghcr.io/andydecleyre/mouse-ran-down)
  -t <tag>: tag of the image (default: main)
  -c: remove any dangling images after starting the container
  <credentials-file>: path to credentials.nt (default: ./credentials.nt)

As an auto-updating Systemd service, pulling from a registry

Or you could write an auto-update-friendly quadlet systemd service at ~/.config/containers/systemd/mouse.container, changing the values as you like:

[Container]
AutoUpdate=registry
ContainerName=mouse
Image=ghcr.io/andydecleyre/mouse-ran-down:main
Volume=%h/mouse-ran-down/credentials.nt:/app/credentials.nt:ro

[Service]
Restart=always
TimeoutStartSec=120

[Install]
WantedBy=default.target

Ensure the service is discovered/generated, and start it:

$ systemctl --user daemon-reload
$ systemctl --user start mouse

Ensure the auto-updating timer is enabled:

$ systemctl --user enable --now podman-auto-update.timer

View container logs

$ podman logs CONTAINER_NAME  # e.g. mouse