1. Guides
  2. Set up RestoreTrust
  3. Backup sources
  4. Backup sources
Website
  • Overview
  • Quickstart
  • How RestoreTrust works
  • Requirements
  • Organizations and projects
  • Project workers
  • Test schedules
    • File checks
  • Validation gates
  • Time zones and dates
  • Manual runs
  • Notifications
  • Check results
  • Execution logs
  • Reports
  • Evidence and verification
  • Team and roles
  • API keys
  • Billing and plans

Backup sources

Connect a RestoreTrust project to an S3, FTP, SFTP, or SMB location that holds backup files.

Loading documentation…

Backup encryption< PreviousS3Next >

Powered by heyo

On this page

Before you add a sourceAdd a sourceSupported typesChange or remove a source

A source describes where a project worker lists and downloads backup artifacts. RestoreTrust supports S3-compatible object storage, FTP, SFTP, and SMB.

The project worker connects to the source; the RestoreTrust service does not use or receive the source credential values.

Before you add a source

Prepare:

  • a host name or endpoint and port reachable from the worker
  • S3 region and bucket, or an SMB share name, when applicable
  • active source credential metadata of the same type
  • the corresponding Kubernetes Secret in every selected worker's job namespace
  • read and list permission for the paths your schedules will use

Add a source

  1. 1

    Choose the source type

    Open Sources in the active project and choose Create. Select S3, FTP, SFTP, or SMB. The type cannot be treated as interchangeable with a differently typed credential.

  2. 2

    Enter the connection details

    Give the source a recognizable name and description. Enter the host or domain and port, then complete the type-specific fields.

  3. 3

    Select credentials

    Select active source secret metadata of the matching type. The worker will read the values from the named Kubernetes Secret when a check runs.

  4. 4

    Use it in a schedule

    Save the source, then create a schedule and enter the path relative to this source. The schedule combines source details and its path when selecting an artifact.

Supported types

TypeAdditional settingsGuidance
S3Protocol, region, bucket, addressing stylePrefer HTTPS
FTPNone beyond host and portTraffic is not encrypted
SFTPNone beyond host and portReview the host-verification limitation
SMBShare nameRestrict the account to the required share and paths
The source does not select one backup

File selection belongs to the schedule. Use an exact pattern with date variables or select the automatically latest file, then add age and size criteria where appropriate.

Change or remove a source

Connection details and the credential reference can be updated. The source type is fixed; create a replacement source to change protocols. A source referenced by any schedule cannot be paused or deleted, including when that schedule is paused. Update or remove the schedule references first.

Related topics

  • Source credentials
  • Schedules
  • Project workers