Skip to content

User Stories — Uploader Service

Service: Uploader · Tier: 2 (Immutable) · Status: Planned (since v0.6.0)

US-U01: Automatically back up recordings to the cloud ☁️

As a researcher I want my recordings to be automatically uploaded to a remote storage (e.g., Nextcloud, S3), so that my data is safe even in case of device loss, theft, or hardware failure.

Acceptance Criteria

  • [ ] New recordings are automatically detected and uploaded to the cloud — without manual intervention.
  • [ ] Before upload, files are losslessly compressed (FLAC) to save bandwidth (~50% smaller).
  • [ ] After confirmed upload to all currently active storage targets, the file is marked as "uploaded" in the database (uploaded=true).
  • [ ] The device also works without an internet connection — recordings are stored locally and caught up upon connection (Store & Forward).

Milestone

  • Milestone: v0.6.0

References

US-U02: Record indefinitely ♾️

As a user I want to ensure that uploaded recordings may be automatically deleted from local storage, so that the station can record continuously for months or years without manual intervention.

Acceptance Criteria

  • [ ] After confirmed upload to all active storage targets, the system marks the file as backed up (uploaded=true).
  • [ ] The storage cleanup service (Janitor) may only delete files marked as "uploaded" (→ US-P02).
  • [ ] The interaction of upload and cleanup permanently keeps local storage below critical thresholds.
  • [ ] In case of a permanent lack of internet connection, the Janitor still intervenes — recording always takes precedence over archiving.

Milestone

  • Milestone: v0.6.0

References

US-U03: Multiple storage targets simultaneously 🗄️

As a researcher I want to send my recordings to multiple storage targets simultaneously (e.g., Nextcloud for sharing, S3 for long-term archiving), so that I can use different backup and sharing strategies in parallel.

Acceptance Criteria

  • [ ] Multiple cloud storages can be configured in the web interface (e.g., Nextcloud, Amazon S3, SFTP Server).
  • [ ] For each active storage target, a separate logical upload instance exists. If there are more active storage targets than max_uploaders allows, the Controller deterministically selects the running instances in the order created_at ASC, slug ASC.
  • [ ] Individual storage targets can be enabled and disabled without affecting the others.
  • [ ] A file is only considered fully backed up (and thus deletable by the Janitor) when it has been successfully uploaded to all active storage targets. Inactive storage targets do not block this status.

Milestone

  • Milestone: v0.6.0

References

US-U04: Adjust upload settings via web interface 🎛️

As a user I want to be able to change upload settings (bandwidth, time window, storage targets) via the web interface, so that I adjust the upload to my network situation and needs — without SSH or config files.

Acceptance Criteria

  • [ ] Bandwidth limit is adjustable (e.g., "max 1 MB/s") to avoid overloading the internet connection.
  • [ ] A time window for uploads can be defined (e.g., only at night from 22:00–06:00) to save bandwidth during the day.
  • [ ] New storage targets can be added, edited, and removed via the web interface.
  • [ ] Changes are automatically applied — the upload service restarts if necessary.

Milestone

  • Milestone: v0.6.0 (Backend: UploaderSettings Schema, Schedule, Bandwidth Limit) + v0.9.0 (Frontend: Web Interface)

References

US-U05: Upload progress and status in dashboard 📊

As a user I want to see in the dashboard how many recordings still need to be uploaded and whether there are problems, so that I can assess the cloud sync state of my station at any time.

Acceptance Criteria

  • [ ] The dashboard shows: number of pending uploads, current upload speed, and last successful upload time.
  • [ ] A warning is shown for failed uploads (e.g., "Connection to Nextcloud failed for 2 hours").
  • [ ] Status can be viewed individually per storage target.
  • [ ] The upload service reports its status periodically to the web interface.

Milestone

  • Milestone: v0.6.0 (Backend: Heartbeat Payload) + v0.9.0 (Frontend: Dashboard)

References

US-U06: Seamless upload tracking 📋

As a researcher I want to be able to trace at any time which recordings were uploaded when and where, so that I am certain no data was lost on the way.

Acceptance Criteria

  • [ ] Every upload attempt is logged — success, failure, file size, duration, and target.
  • [ ] The upload log is viewable via the web interface.
  • [ ] Failed uploads are automatically retried.
  • [ ] Persistently failed uploads are shown as a warning in the dashboard (→ US-U05).

Milestone

  • Milestone: v0.6.0

References

[!NOTE] Recording Protection: This service must not impair the ongoing recording. Resource limits, QoS prioritization, and file isolation are managed centrally by the Controller (→ US-C04, US-R02).