# 2. Getting Started
This chapter gets TotumService installed and the web UI open. Plan for 10–20 minutes on a machine that already has the build prerequisites.
# What you need
| Requirement | Notes |
|---|---|
| Windows 10/11 or Windows Server 2019/2022 | 64-bit |
| Administrator rights | Needed to install the Windows service |
| .NET 8 SDK | Only if you build from source (publish.bat) |
| PresignedUrlClient repo | Sibling folder next to totumservice when building from source |
| Network access | To your Totum / presigned URL service and S3 (for real uploads) |
If someone already gave you an installer (.exe setup), you can skip building and jump to Install with the installer.
# Option A — Build and install from source
# 1. Check prerequisites
From the repository root:
check-prerequisites.bat
Fix anything it reports. Common missing item: PresignedUrlClient must sit beside this repo:
Dev\2026\
├── totumservice\
└── PresignedUrlClient\
Clone if needed:
cd ..
git clone https://github.com/inovus-ltd/PresignedUrlClient.git PresignedUrlClient
# 2. Publish the executable
publish.bat
When it finishes, you should have:
TotumService\bin\Release\net8.0\win-x64\publish\TotumService.exe
# 3. Install the Windows service
Right-click install.bat → Run as administrator.
The script:
- Creates the Event Log source if needed
- Installs
TotumService - Starts it
# 4. Confirm it is running
sc query TotumService
Look for STATE : 4 RUNNING.
# 5. Open the dashboard
In a browser on the same PC:
You should see status cards, plugins, and logs. If the page will not load, see Troubleshooting.
# Install with the installer
If you use the Inno Setup package:
- Run the setup as Administrator.
- Accept defaults unless you have a reason to change them.
- Finish the wizard and open
http://localhost:55000.
The installer typically also sets the HTTP URL reservation so the service can listen on port 55000.
# First configuration checklist
After the UI loads:
- Open Configuration (button on the dashboard, or go to
/config). - Open the Folders tab and add at least one folder if you want automatic uploads.
- Open Settings and review plugin toggles (scan interval, retries, and so on).
- Confirm the S3 provider shows as available on the main dashboard under Transfer Providers.
Credentials and base URLs for S3 / the presigned URL API are normally set in
appsettings.Production.jsonon the server — not fully in the UI yet. See Advanced.
# Useful scripts (quick reference)
| Script | What it does |
|---|---|
check-prerequisites.bat |
Verifies build dependencies |
publish.bat |
Builds the single-file executable |
install.bat |
Installs and starts the Windows service |
Uninstall.bat |
Stops and removes the service |
status.bat |
Shows service status (if present) |
redeploy.bat |
Stop → publish → reinstall → start (admin) |
Prefer publish.bat over ad-hoc publish commands — it includes options needed for SQLite native libraries.
# Success looks like
sc query TotumServiceshows RUNNING- Browser opens http://localhost:55000
- Dashboard status is healthy (or at least loading data)
- Logs show startup without fatal errors
# Next step
Core Concepts → — understand folders, uploads, and file states before configuring them.