Adds option to turn OFF Telegram photo uploads to Imgur (Default: ON)

.circleci/config.yml

@@ -9,17 +9,18 @@ version: 2.1
 workflows:
   main:
     jobs:
-      - go_1-15
-      - go_1-16
-      - go_1-17
+      - go_1-18
+      - go_1-19
+      - go_1-20
+      - go_1-25
       - build_docs
 
 commands:
   golintci-lint:
     description: Run linter checks on TeleIRC.
     steps:
       - checkout
-      - run: 
+      - run:
           name: Download and install golintci-lint.
           command: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sudo sh -s -- -b $(go env GOPATH)/bin v1.43.0
       - run:
@@ -34,21 +35,21 @@ commands:
           command: go test -coverprofile=c.out ./...
 
 jobs:
-  go_1-15:
+  go_1-18:
     docker:
-      - image: cimg/go:1.15
+      - image: cimg/go:1.18
     steps:
       - golintci-lint
       - teleirc-test
-  go_1-16:
+  go_1-19:
     docker:
-      - image: cimg/go:1.16
+      - image: cimg/go:1.19
     steps:
       - golintci-lint
       - teleirc-test
-  go_1-17:
+  go_1-20:
     docker:
-      - image: cimg/go:1.17
+      - image: cimg/go:1.20
     steps:
       - golintci-lint
       - run:
@@ -64,6 +65,30 @@ jobs:
           command: |
             sed -i 's/github.com\/ritlug\/teleirc\///g' c.out
             /tmp/cc-test-reporter after-build
+  go_1-25:
+    docker:
+      - image: cimg/go:1.25
+    steps:
+      - checkout
+      - run:
+          name: Download and install golintci-lint.
+          command: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sudo sh -s -- -b $(go env GOPATH)/bin v2.6.1
+      - run:
+          name: Run Go linter checks.
+          command: golangci-lint run
+      - teleirc-test
+      - run:
+          name: Display test coverage summary.
+          command: |
+            go tool cover -func=c.out
+            echo "Total coverage:"
+            go tool cover -func=c.out | grep total | awk '{print $3}'
+      - run:
+          name: Generate HTML coverage report.
+          command: go tool cover -html=c.out -o coverage.html
+      - store_artifacts:
+          path: coverage.html
+          destination: coverage-report
   build_docs:
     docker:
       - image: cimg/python:3.10

.github/workflows/publish_docker_image.yml

@@ -1,49 +1,47 @@
-name: Build and Push Docker Image
-
+name: Build and Publish Docker Image
+
+#on:
+#  push:
+#    branches:
+#      - main
+#    tags:
+#      - 'v*'
 on:
+  pull_request:
+    branches:
+      - main
   push:
-    branches: [main]
-
-env:
-  REGISTRY: ghcr.io
-  IMAGE_NAME: ${{ github.repository }}
-
-concurrency:
-  group: teleirc-docker-${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+    tags:
+      - 'v*'
 
 jobs:
-  build-and-push-image:
-    name: Build and Push Image
-
+  build-and-push:
+    name: Build and Push Docker Image to GHCR
     runs-on: ubuntu-latest
     permissions:
       contents: read
       packages: write
+      id-token: write
 
     steps:
-      - name: Checkout repository
+      - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Log in to the Container registry
-        uses: docker/login-action@v2
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
         with:
-          registry: ${{ env.REGISTRY }}
+          registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Set up docker buildx
+        uses: docker/setup-buildx-action@v3
 
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+      - name: Build and push docker image
+        uses: docker/build-push-action@v6
         with:
-          push: true
           context: .
           file: ./deployments/container/Dockerfile
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          push: true
+          tags: |
+            ghcr.io/ritlug/${{ github.repository##*/ }}:${{ github.sha }}

cmd/teleirc.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"os/signal"
 	"syscall"
+	"strconv"
 
 	tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api"
 	"github.com/ritlug/teleirc/internal"
@@ -15,7 +16,9 @@ import (
 
 var (
 	flagPath    = flag.String("conf", ".env", "config file")
-	flagDebug   = flag.Bool("debug", false, "enable debugging output")
+	flagDebug   = flag.Bool("debug", func() bool { env, _ := strconv.ParseBool(os.Getenv("DEBUG")); return env }(), "enable debugging output")
+	flagMuteIrc = flag.Bool("muteirc", func() bool { env, _ := strconv.ParseBool(os.Getenv("DISABLE_RELAY_TO_IRC")); return env }(), "disable Telegram messages to IRC")
+	flagMuteTg  = flag.Bool("mutetelegram", func() bool { env, _ := strconv.ParseBool(os.Getenv("DISABLE_RELAY_TO_TELEGRAM")); return env }(), "disable IRC messages to Telegram")
 	flagVersion = flag.Bool("version", false, "displays current version of TeleIRC")
 	version     string
 )
@@ -33,6 +36,13 @@ func main() {
 	// Notify that logger is enabled
 	logger.LogDebug("Debug mode enabled!")
 
+	if *flagMuteIrc {
+		logger.LogInfo("Relaying messages to IRC is turned OFF!")
+	}
+	if *flagMuteTg {
+		logger.LogInfo("Relaying messages to Telegram is turned OFF!")
+	}
+
 	settings, err := internal.LoadConfig(*flagPath)
 	if err != nil {
 		logger.LogError(err)
@@ -43,10 +53,10 @@ func main() {
 	signal.Notify(signalChannel, os.Interrupt, syscall.SIGTERM)
 
 	var tgapi *tgbotapi.BotAPI
-	tgClient := tg.NewClient(&settings.Telegram, &settings.IRC, &settings.Imgur, tgapi, logger)
+	tgClient := tg.NewClient(&settings.Telegram, &settings.IRC, &settings.Imgur, tgapi, logger, *flagMuteIrc)
 	tgChan := make(chan error)
 
-	ircClient := irc.NewClient(&settings.IRC, &settings.Telegram, logger)
+	ircClient := irc.NewClient(&settings.IRC, &settings.Telegram, logger, *flagMuteTg)
 	ircChan := make(chan error)
 
 	go ircClient.StartBot(ircChan, tgClient.SendMessage)

deployments/container/Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22-alpine AS builder
+FROM golang:1.25-alpine AS builder
 
 WORKDIR /app
 
@@ -16,8 +16,6 @@ RUN adduser -D teleirc-user
 USER teleirc-user
 
 COPY --from=builder /app/teleirc /opt/teleirc/teleirc
-COPY --from=builder /app/.env /opt/teleirc/conf
 
 WORKDIR /opt/teleirc
 ENTRYPOINT [ "./teleirc" ]
-CMD [ "-conf", "/opt/teleirc/conf", "-debug", "true" ]

deployments/container/docker-compose.yml.example

@@ -6,7 +6,6 @@ version: '3'
 services:
   teleirc:
     build:
-      context: ../../
-      dockerfile: ./deployments/container/Dockerfile
-    env_file: ../../.env
+      context: https://github.com/RITlug/teleirc.git
+      dockerfile: deployments/container/Dockerfile
     user: teleirc

docs/user/config-file-glossary.rst

@@ -3,8 +3,27 @@ Config file glossary
 ####################
 
 This page is a glossary of different settings in the ``env.example`` configuration file.
-All values shown are the default settings.
-This glossary is intended for advanced users.
+
+.. note::
+    All values shown are the default settings.
+    This glossary is intended for advanced users.
+
+
+************
+General settings
+************
+
+Configuration settings
+========================
+
+``DEBUG=false``
+    (Optional) Verbose logging, enabled when set to `true`
+
+``DISABLE_RELAY_TO_IRC=false``
+    (Optional) Fully disables bridging messages from Telegram → IRC when set to `true`
+
+``DISABLE_RELAY_TO_TELEGRAM=false``
+    (Optional) Fully disables bridging messages from IRC → Telegram when set to `true`
 
 
 ************
@@ -97,6 +116,9 @@ Message settings
 ``IRC_SEND_DOCUMENT=false``
     Send documents and files from Telegram to IRC (`why is this false by default? <https://github.com/RITlug/teleirc/issues/115>`_)
 
+``IRC_SEND_PHOTO=true``
+    All photos which the Telegram Bot receives are uploaded to imgur, and an imgur-link is then posted to IRC
+
 ``IRC_EDITED_PREFIX="(edited) "``
     Prefix to prepend to messages when a user edits a Telegram message and it is resent to IRC
 
@@ -171,6 +193,13 @@ Telegram settings
 ``SHOW_DISCONNECT_MESSAGE=true``
     Sends a message to Telegram when the bot disconnects from the IRC side.
 
+``PREFER_FIRSTNAME=false``
+    Prefer users adjustable «First name» from Telegram, over their @usernames, when sending messages to IRC channel
+    (Fallback will still be the @username if first name is not available)
+
+``QUOTE_NICKNAME=false``
+    Place IRC nickname in a blockquote section of the message to Telegram, instead of inline message prefix.
+
 **************
 Imgur settings
 **************

docs/user/quick-start.md

@@ -101,17 +101,23 @@ If your IRC channel is on the Freenode IRC network, use these exact commands to
 1. `/query ChanServ ACCESS #channel ADD *!*@freenode/staff/* +Aiotv`
 1. `/query ChanServ ACCESS #channel ADD <bot NickServ account or hostmask> +V`
 
-### Configure Imgur Image Upload (IIU)
+### Adjust default Imgur Image Upload (IIU)
 
-_By default_, TeleIRC uploads images sent to the Telegram group to [Imgur][7].
 Since IRC does not support images, Imgur is an intermediary approach to sending pictures sent on Telegram over to IRC.
-Note that images will be publicly visible on the Internet if the URL is known.
-[See context][8] for why Imgur is enabled by default.
+
+> [!IMPORTANT]
+> _By default_, all images the Telegram Bot reads are uploaded by TeleIRC to [Imgur][7].
+> [See context][8] for why Imgur upload is enabled by default.
 
 By default, TeleIRC uses the TeleIRC-registered Imgur API key.
 We highly recommend registering your own API key in high-traffic channels.
 Otherwise, API rate limiting can occur.
 
+#### Optionally disable all Imgur image uploads from Telegram
+
+* Set `IRC_SEND_PHOTO` to `false` in your `.env` file
+
+#### Alternatively use your own Imgur API details
 To register your own Imgur API key, follow these steps:
 
 1. Create an Imgur account
@@ -132,15 +138,35 @@ There are two ways to deploy TeleIRC persistently:
 Containers are the easiest way to deploy TeleIRC.
 Dockerfiles and other deployment resources are available in ``deployments/``.
 
-#### Build TeleIRC
+Ensure you have [docker](https://www.docker.com/) installed.
+
+#### Build TeleIRC docker image
 
-1. Ensure you have [docker](https://www.docker.com/) installed
 1. Enter container deployment directory (`cd deployments/container`)
 1. Build image (`./build_image.sh`)
 1. Run container (`docker run teleirc:latest`)
 
-**NOTE**:
-**This deployment method assumes you have a complete .env file**
+> [!NOTE]
+> This deployment can optionally copy a standalone .env file
+
+
+#### Run TeleIRC using Docker compose
+
+1. Enter container deployment directory (`cd deployments/container`)
+1. Run service using `docker compose`:
+
+```bash
+IRC_SERVER=chat.freenode.net \
+IRC_CHANNEL='#channelname' \
+IRC_BOT_NAME='teleirc' \
+TELEIRC_TOKEN='000000000:AAAAAAaAAa2AaAAaoAAAA-a_aaAAaAaaaAA' \
+TELEGRAM_CHAT_ID='-0000000000000' \
+docker compose up -d teleirc
+```
+
+> [!TIP]
+> Instead you can also add `environment:` entries via `docker-compose.yml`, or pass a standalone `.env` file using the CLI:
+> `docker compose --env-file ../../.env up --build -d teleirc`
 
 
 ### Run binary

env.example

@@ -2,6 +2,19 @@
 # See the Config File Glossary for instructions.
 # https://docs.teleirc.com/en/latest/user/config-file-glossary/
 
+###############################################################################
+#                                                                             #
+#                             General settings                                #
+#                                                                             #
+###############################################################################
+
+#####----- Configuration settings -----#####
+DEBUG=false
+DISABLE_RELAY_TO_IRC=false
+DISABLE_RELAY_TO_TELEGRAM=false
+
+
+
 ###############################################################################
 #                                                                             #
 #                       IRC configuration settings                            #
@@ -45,6 +58,7 @@ IRC_PREFIX="<"
 IRC_SUFFIX=">"
 IRC_SEND_STICKER_EMOJI=true
 IRC_SEND_DOCUMENT=false
+IRC_SEND_PHOTO=true
 IRC_EDITED_PREFIX="(edited) "
 IRC_MAX_MESSAGE_LENGTH=400
 IRC_SHOW_ZWSP=true
@@ -75,6 +89,9 @@ SHOW_NICK_MESSAGE=false
 SHOW_LEAVE_MESSAGE=false
 LEAVE_MESSAGE_ALLOW_LIST=""
 SHOW_DISCONNECT_MESSAGE=true
+PREFER_FIRSTNAME=false
+QUOTE_NICKNAME=false
+
 
 
 ################################################################################