Outpost Sync policy settings
This page lists every sync.* setting a profile can
set, as the settings catalog in Depot 0.4.1 defines it. For how to use them,
see Set up Outpost Sync.
- Depot 0.4.1. The list is complete for that release.
- Sync settings are resolved for a person. Assign them to a Person, a User group, or the Whole client. Profiles assigned to an endpoint, a site, or a device group do not change Sync, so a person gets the same Sync settings on every computer they sign in to.
- Every Sync setting can be made mandatory.
- Sync runs on Windows only. See Outpost Sync.
Merge is how two values combine when two profiles at the same rank set the setting, or when two mandatory values meet. Between different ranks, the higher rank wins. See How profiles merge.
| Merge | Result |
|---|---|
| Off wins | Off if any value is off. |
| Smallest above 0 | The smaller number, where 0 loses to any positive value. |
| Single value | No combining. Two different values at the same rank are reported as a conflict. |
Settings
Section titled “Settings”| Key | Type | Default | Merge | What it does |
|---|---|---|---|---|
sync.allow_metered | Boolean | true | Off wins | Whether Sync may transfer files while the endpoint is on a connection Windows reports as metered, such as a phone hotspot. When off, Sync pauses with a visible Metered status. |
sync.enabled | Boolean | false | Off wins | Whether the person gets an Outpost Sync folder on the computers they sign in to. Any applicable profile at the same rank that turns it off turns it off. |
sync.max_versions | Integer | 10 | Smallest above 0 | How many previous versions of one file to keep. The newest are kept. 0 keeps every version until sync.version_retention_days removes it. |
sync.quota_bytes | Bytes | 10737418240 (10 GiB) | Smallest above 0 | How much storage one person’s folder may use, including previous versions and the recycle bin. 0 means no limit. |
sync.storage_profile_id | String | Empty | Single value | The id of the storage destination for this person’s Sync files. See Destination. |
sync.upload_limit_kbps | Integer | 0 | Smallest above 0 | The most bandwidth Sync may use to upload from the endpoint, in kilobits per second. 0 means no limit. Downloads are not limited. |
sync.version_retention_days | Integer | 30 | Smallest above 0 | How many days previous versions and deleted files are kept before they are removed for good. 0 keeps them until sync.max_versions removes them. |
Notes on individual values
Section titled “Notes on individual values”Destination
Section titled “Destination”sync.storage_profile_id takes a storage destination’s id, not its name.
Left empty, or naming a destination that has been retired, Sync uses the
client’s default destination, then the MSP’s default, then the Outpost
server’s own disk. Outpost Cloud Storage is the MSP’s default unless you set
another. A Windows network share cannot hold Sync files. Home Lab uses your
own S3-compatible storage only. See Storage destinations.
When the destination a person’s files are in is unavailable, Sync pauses rather than writing anywhere else.
Quota and history
Section titled “Quota and history”Previous versions and the recycle bin use the same storage as current files,
so they count toward sync.quota_bytes. When a person’s folder is at its
quota, their computers stop uploading until there is room.
Lowering sync.max_versions or sync.version_retention_days makes room as
older history is removed.
Related
Section titled “Related”Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either license.