Skip to content

Commit

Permalink
doc: Add warning about service user scopes
Browse files Browse the repository at this point in the history
  • Loading branch information
tlater-famedly committed Jan 15, 2025
1 parent 4b69f20 commit e4af74d
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ Currently supported sources:

## Configuration

> [!WARNING]
>
> When creating a service user, limit them to the specific project and
> organization scope that they are intended to sync. `famedly-sync`
> currently does not separately limit the scope of the sync, see #103.
The tool expects a configuration file located at `./config.yaml`. See example configuration at [config.sample.yaml](./config.sample.yaml).

The default path can be changed by setting the new path to the environment variable `FAMEDLY_SYNC_CONFIG`.
Expand Down
4 changes: 4 additions & 0 deletions sample-configs/csv-config.sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ zitadel:
# The project to grant users access to.
project_id: 278274945274880004
# The identity provider ID to enable SSO login for
#
# WARNING: This user *must* be scoped to the specific org/project,
# as famedly-sync does not limit syncs to the configured org/project
# by itself.
idp_id: 281430143275106308

feature_flags:
Expand Down
4 changes: 4 additions & 0 deletions sample-configs/ldap-config.sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ zitadel:
# The project to grant users access to.
project_id: 278274945274880004
# The identity provider ID to enable SSO login for
#
# WARNING: This user *must* be scoped to the specific org/project,
# as famedly-sync does not limit syncs to the configured org/project
# by itself.
idp_id: 281430143275106308

feature_flags:
Expand Down
4 changes: 4 additions & 0 deletions sample-configs/ukt-config.sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ zitadel:
# The project to grant users access to.
project_id: 278274945274880004
# The identity provider ID to enable SSO login for
#
# WARNING: This user *must* be scoped to the specific org/project,
# as famedly-sync does not limit syncs to the configured org/project
# by itself.
idp_id: 281430143275106308

feature_flags:
Expand Down

0 comments on commit e4af74d

Please sign in to comment.