Sign inSign up

w03zd8rc/telemt-admin

By w03zd8rc

•Updated 2 months ago

FastAPI web admin panel for TeleMT config.toml users and settings.

Image
0

4.7K

w03zd8rc/telemt-admin repository overview

⁠TeleMT Admin

English README⁠ | Русский README⁠ | GitHub⁠

FastAPI web admin panel for TeleMT⁠. It edits users and TeleMT settings directly in config.toml, keeps rotating backups, generates tg://proxy links and QR codes, supports web login and Basic Auth, and can show TeleMT metrics.

⁠Screenshots

English light overview

English dark overview

English user settings

⁠Docker run

docker run -d \
  --name telemt-admin \
  --restart unless-stopped \
  -p 8080:8080 \
  -e ENABLE_WEB_AUTH=yes \
  -e WEB_ADMIN_USER=admin \
  -e WEB_ADMIN_PASS=change-me \
  -e TELEMT_CONFIG=/data/telemt/config/config.toml \
  -e TELEMT_METRICS_URL=http://telemt:9090/metrics \
  -e DEFAULT_THEME=dark \
  -e LOG_LEVEL=ERROR \
  -e TZ=UTC \
  -v /data/telemt/config:/data/telemt/config:rw \
  -v /data/telemt-admin/backups:/data/backups:rw \
  w03zd8rc/telemt-admin:latest

⁠Docker Compose

services:
  telemt:
    image: ghcr.io/telemt/telemt:latest
    container_name: telemt
    volumes:
      - /data/telemt/config:/etc/telemt:rw
    expose:
      - "443"
      - "9090"

  telemt-admin:
    image: w03zd8rc/telemt-admin:latest
    container_name: telemt-admin
    restart: unless-stopped
    # Uncomment when TeleMT metrics are loopback-only.
    # network_mode: "container:telemt"
    environment:
      ENABLE_WEB_AUTH: "yes"
      WEB_ADMIN_USER: admin
      WEB_ADMIN_PASS: change-me
      ENABLE_BASIC_AUTH: "no"
      TELEMT_CONFIG: /data/telemt/config/config.toml
      TELEMT_METRICS_URL: http://telemt:9090/metrics
      ENABLE_METRICS: "yes"
      READ_ONLY: "no"
      DEFAULT_THEME: dark
      LOG_LEVEL: ERROR
      TZ: UTC
    volumes:
      - /data/telemt/config:/data/telemt/config:rw
      - /data/telemt-admin/backups:/data/backups:rw

⁠Environment variables

VariableDefaultDescription
ENABLE_WEB_AUTHyesEnables the built-in login form.
ENABLE_BASIC_AUTHnoEnables HTTP Basic Auth for API/UI requests.
WEB_ADMIN_USER / WEB_ADMIN_PASSadmin / adminWeb login credentials. Change the password.
BASIC_ADMIN_USER / BASIC_ADMIN_PASSadmin / adminBasic Auth credentials.
TELEMT_CONFIG/data/telemt/config/config.tomlPath to TeleMT config inside the admin container.
TELEMT_BACKUP_DIR/data/backupsDirectory for config backups.
TELEMT_MAX_BACKUPS20Number of backups to keep.
READ_ONLYnoForces read-only mode even when config.toml is writable.
ENABLE_METRICSyesEnables metrics UI and metrics checks.
TELEMT_METRICS_URLhttp://telemt:9090/metricsPrometheus metrics URL. Use http://127.0.0.1:9090/metrics with network_mode: container:telemt.
AUTO_FIX_METRICS_LISTENyesAuto-rewrite loopback metrics_listen in config.toml.
DEFAULT_LANGenDefault UI language.
DEFAULT_THEMEdarkDefault UI theme: light or dark.
LOG_LEVELERRORUvicorn log level. Access logs are disabled.
TZimage defaultTimezone for metadata timestamps. Supports IANA names and fixed offsets like +3.

Full documentation is maintained in GitHub README files:

Tag summary

Content type

Image

Digest

sha256:00e9d4c48…

Size

22 MB

Last updated

2 months ago

docker pull w03zd8rc/telemt-admin