# TotumService User Guide

Welcome. This guide is for people who run and use TotumService — not for developers writing plugins.

It walks you from first install through everyday tasks, then into advanced options and troubleshooting.


# Who this is for

You are… Start here
Installing TotumService for the first time Getting Started
Setting up automatic folder uploads Folder Monitoring
Checking whether uploads are working Dashboard or Database Explorer
Changing behaviour without editing config files Settings
Fixing a problem Troubleshooting

# How to use this guide

Read in order if you are new. Jump to a chapter if you already know the basics.

  1. Introduction — What TotumService does
  2. Getting Started — Install, start, open the web UI
  3. Core Concepts — Folders, uploads, providers, file states
  4. Using the Dashboard — Live status, transfers, logs
  5. Folder Monitoring — Add and manage watched folders
  6. Plugin Settings — Tune behaviour from the UI
  7. Database Explorer — Inspect tracked files and failures
  8. Managing the Service — Start, stop, update, uninstall
  9. Advanced — Config files, S3, large files, recovery
  10. Troubleshooting — Common problems and fixes
  11. FAQ — Short answers to frequent questions

Task Where
Open the web UI http://localhost:55000
Configure folders & settings http://localhost:55000/config
Inspect uploads & failures http://localhost:55000/database
API documentation (Swagger) http://localhost:55000/docs

# Conventions used here

  • Bold highlights important UI labels or actions.
  • Paths and commands look like this.
  • Steps you should follow are numbered.
  • Warnings call out things that can delete data or break uploads.

Version covered: TotumService 1.3.x

For developer and operations documentation, see the main docs index.