Barghman

Barghman is a service that connects to the Iran Power electricity provider and sends calendar emails in ICS format with your blackout schedules. It can run as a standalone command or as a scheduled service using cron jobs.

Hope for the days when we don't need this fucking service for power outages.

curl -fsSL https://github.com/dozheiny/barghman/releases/latest/download/install.sh | bash

Or with wget:

wget -qO- https://github.com/dozheiny/barghman/releases/latest/download/install.sh | bash

The script auto-detects your OS and architecture (linux/darwin/windows, amd64/arm64), downloads the correct release archive, and installs the binary to /usr/local/bin (or %USERPROFILE%\bin on Windows).

yay -S barghman-git

Or manually:

git clone https://aur.archlinux.org/barghman-git.git
cd barghman-git && makepkg -si

git clone https://github.com/dozheiny/barghman.git
cd barghman
make install

barghman -file <config file>

Options:

• -file <config file>: Path to your TOML configuration file

If you wish for running barghman as a systemd service:

	systemctl --user daemon-reload
	systemctl --user enable barghman.service

1. Install the Go compiler from https://go.dev
2. Run the build command:

   make build

This will compile the barghman binary for your system.

1. Create a TOML configuration file (e.g., example.toml)
2. Update the file with your credentials, SMTP details, and client information
3. Run barghman with the config file:

   barghman -file example.toml

Build the image:

make docker
# or: docker build -t barghman:latest .

Run with a mounted config (and optional cache volume so sent-outage state survives restarts):

docker run --rm \
  -v /path/to/config.toml:/etc/barghman/config.toml:ro \
  -v barghman-cache:/var/cache/barghman \
  barghman:latest

The image entrypoint is barghman -file /etc/barghman/config.toml. Use a non-empty cron_job in the config so the container keeps running on a schedule.

Each mail provider can be configured under [smtp.<provider>].

When transport = "ews", username/password are used for NTLM authentication against EWS (e.g. DOMAIN\user), and auth_method is ignored.

To route SMTP (or EWS) traffic through a SOCKS5 proxy, add a [smtp.<provider>.proxy] sub-table:

Example:

[smtp.gmail]
mail = "your-email@gmail.com"
host = "smtp.gmail.com"
port = "587"
username = "your-email@gmail.com"
password = "your-app-password"
auth_method = "plain"
identity = ""
skip_tls = true

[smtp.gmail.proxy]
host = "127.0.0.1"
port = "1080"
username = ""   # omit if proxy needs no auth
password = ""

Each client represents a connection to an electricity service account.