Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

Commit

Permalink
docs: #164 add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blackandred committed Feb 20, 2022
1 parent 49d9da7 commit 9312587
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions server-go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,26 @@ func (c Collection) CanUploadToMe(user *users.User) bool {
}
```

#### Backup Windows

Good practice is to **limit how often versions can be submitted**. Attacker would need to be very patient to overwrite your past backups with malicious ones.

In emergency cases `System Administrator` or person with `uploadsAnytime` role can upload backups between backup windows. Be careful! Do not set up automated backups with administrator account or with account that has `uploadsAnytime` role.


```yaml
---
apiVersion: backups.riotkit.org/v1alpha1
kind: BackupCollection
# ...
spec:
# ...
window:
# allow to send backups only everyday starting from 00:30 to 01:30
- from: "00 30 * * *"
duration: 1h
```

Quota
-----

Expand All @@ -135,7 +155,7 @@ apiVersion: backups.riotkit.org/v1alpha1
kind: BackupCollection
# ...
spec:
# ...
# ...
maxBackupsCount: 5
maxOneVersionSize: 1M
maxCollectionSize: 5M
Expand All @@ -161,7 +181,7 @@ apiVersion: backups.riotkit.org/v1alpha1
kind: BackupCollection
# ...
spec:
# ...
# ...
maxBackupsCount: 5
maxOneVersionSize: 1M
maxCollectionSize: 10M
Expand All @@ -181,6 +201,6 @@ apiVersion: backups.riotkit.org/v1alpha1
kind: BackupCollection
# ...
spec:
# ...
# ...
strategyName: fifo
```

0 comments on commit 9312587

Please sign in to comment.