From 07be21e54ab95ecbb0cbb66f34f5098d2a54178f Mon Sep 17 00:00:00 2001 From: Johar Ali Shaik <64891225+Johar2503@users.noreply.github.com> Date: Mon, 17 Aug 2026 15:10:59 -0700 Subject: [PATCH] docs: add Windows auto-start guide via Task Scheduler (#113) * docs: add Windows auto-start guide via Task Scheduler * docs: fix markdown escaping, remove admin requirement, use path placeholder, link from README --- README.md | 4 +++ docs/windows-autostart.md | 51 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/windows-autostart.md diff --git a/README.md b/README.md index 7a8807b..e602a8b 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,10 @@ make serve # http://127.0.0.1:8765 python3 service/scripts/server.py --host 127.0.0.1 --port 8765 ``` +### Windows (no Docker) + +See [docs/windows-autostart.md](docs/windows-autostart.md) for auto-starting the service at Windows login without Docker. + For the whole infra (core + optional harness/heavy backends), see [Docker / compose](#docker--compose) below. Optional system tools (auto-used when present — preinstalled in the core Docker image): diff --git a/docs/windows-autostart.md b/docs/windows-autostart.md new file mode 100644 index 0000000..344efaa --- /dev/null +++ b/docs/windows-autostart.md @@ -0,0 +1,51 @@ +# Windows: Auto-start the service at login + +Run the service silently in the background on every login, without a terminal window or manual start. + +## 1. Clone the repo somewhere permanent + +Replace `` below with wherever you want the repo to live (e.g. `C:\watermarks-remover` or `C:\Users\\watermarks-remover`). Use the same path consistently in every step below. + +```powershell +git clone https://github.com/guillaumemeyer/watermarks-remover.git +``` + +## 2. Create a silent launcher script + +Save as `\start-service.vbs`: + +```vbscript +Set WshShell = CreateObject("WScript.Shell") +WshShell.Run "python service\scripts\server.py --host 127.0.0.1 --port 8765", 0, False +``` + +## 3. Register a scheduled task + +This does **not** require Administrator privileges — `-AtLogOn` with a user-level trigger runs under your own account, so a regular PowerShell window is enough. + +```powershell +$action = New-ScheduledTaskAction -Execute "wscript.exe" -Argument '"\start-service.vbs"' -WorkingDirectory "" +$trigger = New-ScheduledTaskTrigger -AtLogOn +$settings = New-ScheduledTaskSettingsSet -AllowStartIfOnBatteries -DontStopIfGoingOnBatteries -StartWhenAvailable +Register-ScheduledTask -TaskName "WatermarksRemoverService" -Action $action -Trigger $trigger -Settings $settings -Description "Auto-starts the watermarks-remover HTTP service at login" +``` + +## 4. Start it immediately (no reboot needed) + +```powershell +Start-ScheduledTask -TaskName "WatermarksRemoverService" +``` + +## 5. Verify + +```powershell +Invoke-RestMethod http://127.0.0.1:8765/health +``` + +Should return `{"ok": true, "version": "..."}`. + +## Notes + +- Requires Python 3.10+ on PATH. +- The scheduled task runs at every login going forward — no manual start needed. +- To stop auto-starting: `Unregister-ScheduledTask -TaskName "WatermarksRemoverService"`