Files
auto-archiver-api/user-groups.example.yaml
Michael Plunkett 7e48f706df Add pre-commit with GiHub Action (#56)
* Update pyproject.toml

* add pre-commit

* Create .pre-commit-config.yaml

* Comment out ruff

* Update .pre-commit-config.yaml

* General formatting

* Create format-and-fail.yml

* Update ci.yml

* Add pre-commit to dev dependencies

* Update pyproject.toml
2025-02-26 10:42:28 -06:00

62 lines
1.8 KiB
YAML

# NOTE: all emails should be lower-cased
users:
user01@example.com:
- group1
user02@example.com:
- group2
user03@example.com:
- group1
- group2
domains:
example.com:
- group-for-friends
gmail.com:
- group1
# the secrets/orchestration files MUST exist for you to run this successfully
groups:
group1:
description: "Group 1 which can do everything, no limits"
orchestrator: secrets/orchestration.yaml
orchestrator_sheet: secrets/orchestration-sheet.yaml
permissions:
read: ["all"]
archive_url: true
archive_sheet: true
sheet_frequency: ["hourly", "daily"]
max_sheets: -1
max_archive_lifespan_months: -1
max_monthly_urls: -1
max_monthly_mbs: -1
manually_trigger_sheet: true
group2:
description: "Group that can only archive URLs, not sheets, they can search their own group and group-for-friends archives."
orchestrator: secrets/orchestration.yaml
orchestrator_sheet: secrets/orchestration-sheet.yaml
permissions:
read: ["group2", "group-for-friends"]
archive_url: true
max_archive_lifespan_months: 12
max_monthly_urls: 100
max_monthly_mbs: 1000
group-for-friends:
description: "Friends can have one sheet only which archives once a day"
orchestrator: secrets/orchestration.yaml
orchestrator_sheet: secrets/orchestration-sheet.yaml
permissions:
read: ["friends-1"]
archive_sheet: true
sheet_frequency: ["daily"]
max_sheets: 1
max_archive_lifespan_months: 12
max_monthly_urls: 1000
max_monthly_mbs: 1000
default:
description: "Public access, can only search public archives"
orchestrator: secrets/orchestration.yaml
orchestrator_sheet: secrets/orchestration-sheet.yaml
permissions:
read: ["default"]
read_public: true