Using Docker

Dockerfiles and images are available in containers/ for configuring and running Teleirc. Install Docker onto the machine you plan to run Teleirc from.

Which image do I choose?

Official Node Alpine Linux, and Fedora images are provided (ordered ascending by size).

Image File Size
Node Alpine Linux (node:8-alpine) Dockerfile.alpine 374 MB
Fedora latest Dockerfile.fedora 569 MB

This guide uses alpine. If you wish to use fedora, replace alpine with fedora.

You will see errors during yarn. You can safely ignore them. They are not fatal.

Building Docker image

cd containers/
docker build . -f Dockerfile.alpine -t teleirc
docker run -d -u teleirc --name teleirc --restart always \
    -e TELEIRC_TOKEN="000000000:AAAAAAaAAa2AaAAaoAAAA-a_aaAAaAaaaAA" \
    -e IRC_CHANNEL="#channel" \
    -e IRC_BOT_NAME="teleirc" \
    -e IRC_BLACKLIST="CowSayBot,AnotherNickToIgnore" \
    -e TELEGRAM_CHAT_ID="-0000000000000" \

Docker Compose

Optionally, you may use docker-compose. We provide an example compose file (containers/docker-compose.yml).

version: '2'
    user: teleirc
      context: ..
      dockerfile: containers/Dockerfile.alpine
    env_file: .env

Running with Compose

Run these commands to begin using Teleirc with Docker Compose.

  1. Copy docker-compose.yml.example to docker-compose.yml and edit if you do not wish to use the alpine image
  2. Copy .env.example to .env and edit accordingly.
  3. docker-compose up -d teleirc