Files
watermarks-remover/docs/windows-autostart.md
T
Johar Ali ShaikandGitHub 07be21e54a 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
2026-08-17 15:10:59 -07:00

1.8 KiB

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 <path-to-clone> below with wherever you want the repo to live (e.g. C:\watermarks-remover or C:\Users\<you>\watermarks-remover). Use the same path consistently in every step below.

git clone https://github.com/guillaumemeyer/watermarks-remover.git <path-to-clone>

2. Create a silent launcher script

Save as <path-to-clone>\start-service.vbs:

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.

$action = New-ScheduledTaskAction -Execute "wscript.exe" -Argument '"<path-to-clone>\start-service.vbs"' -WorkingDirectory "<path-to-clone>"
$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)

Start-ScheduledTask -TaskName "WatermarksRemoverService"

5. Verify

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"