From 8433e4a4429b9015e9ce7b769865d38e438aba28 Mon Sep 17 00:00:00 2001 From: Jeena Date: Sun, 4 Jan 2026 17:32:30 +0900 Subject: [PATCH] Simplify README by removing manual setup and dependencies With the install script handling automation, remove redundant sections to keep README concise. Changes: - Remove manual setup steps (covered by install.sh comments) - Remove dependencies section (specified in pyproject.toml) --- README.md | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 7310edc..d524d94 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,13 @@ # Email Forwarder -This script forwards new emails from a source IMAP account (e.g., GMX) to a destination IMAP account (e.g., MXRoute), avoiding duplicates by tracking Message-IDs and using time-based searches. +This script forwards new emails from a source IMAP account (e.g., GMX) to a destination IMAP account (e.g., MXRoute), avoiding duplicates by tracking Message-IDs. ## Setup -### Automated Install (Recommended) Run the install script: `./install.sh` This will set up the virtual environment, systemd services, and provide post-install instructions. -### Manual Setup -1. Copy `.env.example` to `.env` and fill in your IMAP credentials, Uptime URLs, and settings. - -2. Create virtual environment: `python -m venv venv` - -3. Activate and install: `source venv/bin/activate && pip install -e .` - -4. For user services (recommended): - - Copy services: `cp *.service *.timer ~/.config/systemd/user/` - - Copy drop-in: `cp -r email_forwarder.service.d ~/.config/systemd/user/` - - Copy `~/.config/systemd/user/email_forwarder.service.d/override.conf.sample` to `override.conf` and edit to set your PROJECT_DIR and ENV_FILE paths. - -5. Reload and enable: `systemctl --user daemon-reload && systemctl --user enable email_forwarder.timer && systemctl --user start email_forwarder.timer` - -6. Check status: `systemctl --user status email_forwarder.timer` - ## Configuration (.env) - `SOURCE_HOST`: Source IMAP server (e.g., imap.gmx.com) @@ -35,7 +18,7 @@ This will set up the virtual environment, systemd services, and provide post-ins - `DEST_PORT`: Port (default 993) - `DEST_USER`: Destination email/username - `DEST_PASS`: Destination password -- `FOLDERS`: Folders to sync (default INBOX; use "all" for all folders or comma-separated list like "INBOX,Sent") +- `FOLDERS`: Folders to sync (default "INBOX"; use "all" for all folders or comma-separated list like "INBOX,Sent") - `DRY_RUN`: Set to `true` for testing without forwarding (default false) - `UPTIME_SUCCESS_URL`: URL for success ping - `UPTIME_FAIL_URL`: URL for failure ping @@ -52,12 +35,6 @@ This will set up the virtual environment, systemd services, and provide post-ins - Success: Pings `${UPTIME_SUCCESS_URL}` after forwarding. - Failure: `OnFailure` pings `${UPTIME_FAIL_URL}`. -## Dependencies - -- imaplib, email (built-in) -- python-dotenv, imap-tools -- systemd (for user services) - ## Troubleshooting - Logs: `journalctl --user -u email_forwarder.service`