This document assumes you know how to use Docker. If you are completely clueless, please disregard Docker and follow the ordinary install instructions
TediCross is available as a Docker image, through DockerHub
It requires the data/
directory to be mounted as a volume.
Unlike the non-docker version, the settings.yaml
file must be in the data/
directory instead of in the root of the project.
The official docker image is used like this:
docker run \
-v /path/to/data/:/opt/TediCross/data \
-e TELEGRAM_BOT_TOKEN="Your Telegram token" \
-e DISCORD_BOT_TOKEN="Your Discord token" \
tedicross/tedicross
Of course, you can add -d
or --rm
or a name or whatever else you want to that command
If you have the tokens in the settings file instead of reading them from the environment, you can of course drop the -e
lines
The dockerfile says the container should start as the user with UID 1000. This should be fine for most single user Linux systems, but may cause problems for multi user systems. If you get a permission error when starting the container, try changing the user the container is using. Find your user's UID with the command id -u $USER
, then add the argument -u <UID>
to the docker run
command. For example docker run -u 1001 -v ...