mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-20 11:58:47 +00:00
chore: rename configuration to settings (#11568)
# Which Problems Are Solved naming inconsistencies: Configuration <-> Settings # How the Problems Are Solved # Additional Changes # Additional Context - Closes #11282
This commit is contained in:
@@ -11,9 +11,9 @@ Caches is currently an [experimental beta](https://help.zitadel.com/zitadel-soft
|
||||
Test the feature and add improvement or bug reports directly to the [github repository](https://github.com/zitadel/zitadel) or let us know your general feedback in the [discord thread](https://discord.com/channels/927474939156643850/1332343909900222506)!
|
||||
</Callout>
|
||||
|
||||
## Configuration
|
||||
## Settings
|
||||
|
||||
The `Caches` configuration entry defines *connectors* which can be used by several objects. It is possible to mix *connectors* with different objects based on operational needs.
|
||||
The `Caches` settings entry defines *connectors* which can be used by several objects. It is possible to mix *connectors* with different objects based on operational needs.
|
||||
|
||||
```yaml
|
||||
Caches:
|
||||
@@ -32,7 +32,7 @@ Caches:
|
||||
Level: error
|
||||
```
|
||||
|
||||
For a full configuration reference, please see the [runtime configuration file](/self-hosting/manage/configure/configure#runtime-configuration-file) section's `defaults.yaml`.
|
||||
For a full settings reference, please see the [runtime configuration file](/self-hosting/manage/configure/configure#runtime-configuration-file) section's `defaults.yaml`.
|
||||
|
||||
## Connectors
|
||||
|
||||
@@ -189,9 +189,9 @@ Organization objects are quite small and receive infrequent updates after they a
|
||||
|
||||
## Examples
|
||||
|
||||
Currently caches are in beta and disabled by default. However, if you want to give caching a try, the following sections contains some suggested configurations for different setups.
|
||||
Currently caches are in beta and disabled by default. However, if you want to give caching a try, the following sections contains some suggested settings for different setups.
|
||||
|
||||
The following configuration is recommended for single instance setups with a single ZITADEL server:
|
||||
The following setup is recommended for single instance setups with a single ZITADEL server:
|
||||
|
||||
```yaml
|
||||
Caches:
|
||||
@@ -205,7 +205,7 @@ Caches:
|
||||
MaxAge: 1h
|
||||
```
|
||||
|
||||
The following configuration is recommended for single instance setups with high traffic on multiple servers, where Redis is not available:
|
||||
The following setup is recommended for single instance setups with high traffic on multiple servers, where Redis is not available:
|
||||
|
||||
```yaml
|
||||
Caches:
|
||||
|
||||
@@ -94,7 +94,7 @@ Flags:
|
||||
--tlsMode externalSecure start Zitadel with (enabled), without (disabled) TLS or external component e.g. reverse proxy (external) terminating TLS, this flag will overwrite externalSecure and `tls.enabled` in configs files
|
||||
```
|
||||
|
||||
## Configuration
|
||||
## Settings
|
||||
|
||||
```yaml
|
||||
# The source database the data are copied from. Use either cockroach or postgres, by default cockroach is used
|
||||
|
||||
@@ -45,7 +45,7 @@ The `/debug/metrics` endpoint can be consumed in multiple ways:
|
||||
|
||||
ZITADEL does **not** require a specific metrics backend. Any system capable of scraping or ingesting Prometheus-format metrics can be used.
|
||||
|
||||
## Configuration
|
||||
## Settings
|
||||
|
||||
Metrics are enabled by default in standard ZITADEL deployments.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ you should also consider using separate jobs with `zitadel init` and `zitadel se
|
||||
so your workload containers just have to execute `zitadel start`.
|
||||
Read more about separating the init and setup phases on the [Updating and Scaling page](/self-hosting/manage/updating_scaling).
|
||||
|
||||
## Configuration
|
||||
## Setup
|
||||
|
||||
Read [on the configure page](/self-hosting/manage/configure) about the available options you have to configure ZITADEL.
|
||||
Prefer passing .yaml files to the ZITADEL binary instead of environment variables.
|
||||
@@ -197,7 +197,7 @@ please refer to the corresponding docs [for PostgreSQL](https://www.postgresql.o
|
||||
|
||||
- You can configure instance defaults in the DefaultInstance section.
|
||||
If you plan to eventually create [multiple virtual instances](/concepts/structure/instance#multiple-virtual-instances), these defaults take effect.
|
||||
Also, these configurations apply to the first instance, that ZITADEL automatically creates for you.
|
||||
Also, these settings apply to the first instance, that ZITADEL automatically creates for you.
|
||||
Especially the following properties are of special interest for your production setup.
|
||||
|
||||
```yaml
|
||||
@@ -207,9 +207,9 @@ DefaultInstance:
|
||||
IdTokenLifetime: 12h
|
||||
RefreshTokenIdleExpiration: 720h #30d
|
||||
RefreshTokenExpiration: 2160h #90d
|
||||
# this configuration sets the default email configuration
|
||||
# this sets the default email settings
|
||||
SMTPConfiguration:
|
||||
# configuration of the host
|
||||
# settings of the host
|
||||
SMTP:
|
||||
#for example smtp.mailtrap.io:2525
|
||||
Host:
|
||||
|
||||
@@ -5,9 +5,9 @@ sidebar_label: Production Checklist
|
||||
|
||||
To apply best practices to your production setup we created a step by step checklist you may wish to follow.
|
||||
|
||||
### Infrastructure Configuration
|
||||
### Infrastructure Setup
|
||||
|
||||
- [ ] Make use of configuration management tools such as Terraform to provision all of the below
|
||||
- [ ] Make use of infrastructure as code tools such as Terraform to provision all of the below
|
||||
- [ ] Use a secrets manager to store your confidential information
|
||||
- [ ] Reduce the manual interaction with your platform to an absolute minimum
|
||||
|
||||
@@ -36,14 +36,14 @@ To apply best practices to your production setup we created a step by step check
|
||||
- [ ] Secure the access by rate limits for specific endpoints (e.g. API vs frontend) to secure availability on high load. See the [ZITADEL Cloud rate limits](/legal/policies/rate-limit-policy) for reference.
|
||||
- [ ] Check that your firewall also filters IPv6 traffic
|
||||
|
||||
### ZITADEL configuration
|
||||
### ZITADEL setup
|
||||
|
||||
- [ ] Configure a valid [SMTP Server](/guides/manage/console/default-settings#smtp) and test the email delivery
|
||||
- [ ] Set up a valid [SMTP Server](/guides/manage/console/default-settings#smtp) and test the email delivery
|
||||
- [ ] Add [Custom Branding](/guides/manage/customize/branding) if required
|
||||
- [ ] Configure a valid [SMS Service](/guides/manage/console/default-settings#sms) such as Twilio if needed
|
||||
- [ ] Configure your privacy policy, terms of service and a help Link if needed
|
||||
- [ ] Set up a valid [SMS Service](/guides/manage/console/default-settings#sms) such as Twilio if needed
|
||||
- [ ] Set your privacy policy, terms of service and a help Link if needed
|
||||
- [ ] Keep your [masterkey](/self-hosting/manage/configure) in a secure storage
|
||||
- [ ] Declare and apply zitadel configuration using the zitadel terraform [provider](https://github.com/zitadel/terraform-provider-zitadel)
|
||||
- [ ] Declare and apply zitadel settings using the zitadel terraform [provider](https://github.com/zitadel/terraform-provider-zitadel)
|
||||
|
||||
### Security
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ import CodeBlock from '@/components/docusaurus/code-block';
|
||||
import ComposeYaml from "./docker-compose.yaml";
|
||||
|
||||
<>With these examples, you create and run a minimal {props.link} configuration for Zitadel with <a href="https://docs.docker.com/compose">Docker Compose</a>.
|
||||
Whereas the guide focuses on the configuration for {props.name}, you can inspect the configurations for the Zitadel API, the Zitadel login and the database in the base Docker Compose file.</>
|
||||
Whereas the guide focuses on the configuration for {props.name}, you can inspect the settings for the Zitadel API, the Zitadel login and the database in the base Docker Compose file.</>
|
||||
<details>
|
||||
<summary>base docker-compose.yaml</summary>
|
||||
<CodeBlock language="yaml">{ComposeYaml}</CodeBlock>
|
||||
|
||||
@@ -7,7 +7,7 @@ Service Ping is a feature that periodically sends anonymized analytics and usage
|
||||
This data helps improve ZITADEL by providing insights into its usage patterns.
|
||||
|
||||
The feature is enabled by default, but can be disabled either completely or for specific reports.
|
||||
Checkout the configuration options below.
|
||||
Check out the settings below.
|
||||
|
||||
## Data Sent by Service Ping
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ You can restrict the maximum age of events returned by the following APIs:
|
||||
- [A Projects History](/reference/api/management/zitadel.management.v1.ManagementService.ListProjectChanges)
|
||||
- [A Project Grants History](/reference/api/management/zitadel.management.v1.ManagementService.ListProjectGrantChanges)
|
||||
|
||||
You can set a global default limit as well as a default limit [for new virtual instances](/concepts/structure/instance#multiple-virtual-instances) in the ZITADEL configuration.
|
||||
You can set a global default limit as well as a default limit [for new virtual instances](/concepts/structure/instance#multiple-virtual-instances) in the ZITADEL settings.
|
||||
The following snippets shows the defaults:
|
||||
|
||||
```yaml
|
||||
@@ -64,7 +64,7 @@ For example, you might want to report usage to an external billing tool and noti
|
||||
|
||||
ZITADEL supports limiting authenticated requests and action run seconds with quotas.
|
||||
|
||||
For using the quotas feature you have to activate it in your ZITADEL configurations *Quotas* section.
|
||||
For using the quotas feature you have to activate it in your ZITADEL settings *Quotas* section.
|
||||
The following snippets shows the defaults:
|
||||
|
||||
```yaml
|
||||
@@ -91,7 +91,7 @@ The following snippets shows the defaults:
|
||||
```yaml
|
||||
DefaultInstance:
|
||||
Quotas:
|
||||
# Items take a slice of quota configurations, whereas, for each unit type and instance, one or zero quotas may exist.
|
||||
# Items take a slice of quota settings, whereas, for each unit type and instance, one or zero quotas may exist.
|
||||
# The following unit types are supported
|
||||
|
||||
# "requests.all.authenticated"
|
||||
|
||||
Reference in New Issue
Block a user