mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-12 03:47:33 +00:00
docs: fix some more broken links (#5962)
This commit is contained in:
@@ -11,7 +11,7 @@ Depending on your projects needs our general recommendation is to run ZITADEL an
|
|||||||
Consult the [CockroachDB documentation](https://www.cockroachlabs.com/docs/) for more details or use the [CockroachCloud Service](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account.html)
|
Consult the [CockroachDB documentation](https://www.cockroachlabs.com/docs/) for more details or use the [CockroachCloud Service](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account.html)
|
||||||
Postgres is currently in [Beta](/docs/support/software-release-cycles-support#beta) and will be [Enterprise Supported](/docs/support/software-release-cycles-support#partially-supported) afterwards.
|
Postgres is currently in [Beta](/docs/support/software-release-cycles-support#beta) and will be [Enterprise Supported](/docs/support/software-release-cycles-support#partially-supported) afterwards.
|
||||||
Beta state will be removed as soon as [automated tests](https://github.com/zitadel/zitadel/issues/5741) are implemented.
|
Beta state will be removed as soon as [automated tests](https://github.com/zitadel/zitadel/issues/5741) are implemented.
|
||||||
Make sure to read our [Production Guide](./self-hosting/manage/production#prefer-cockroachdb) before you decide to use it.
|
Make sure to read our [Production Guide](/self-hosting/manage/production#prefer-cockroachdb) before you decide to use it.
|
||||||
|
|
||||||
## Scalability
|
## Scalability
|
||||||
|
|
||||||
|
@@ -4,7 +4,7 @@ title: Audit Trail
|
|||||||
|
|
||||||
ZITADEL provides you with an built-in audit trail to track all changes and events over an unlimited period of time.
|
ZITADEL provides you with an built-in audit trail to track all changes and events over an unlimited period of time.
|
||||||
Most other solutions replace a historic record and track changes in a separate log when information is updated.
|
Most other solutions replace a historic record and track changes in a separate log when information is updated.
|
||||||
ZITADEL only ever appends data in an [Eventstore](https://zitadel.com/docs/concepts/eventstore), keeping all historic record.
|
ZITADEL only ever appends data in an [Eventstore](/docs/concepts/eventstore/overview), keeping all historic record.
|
||||||
The audit trail itself is identical to the state, since ZITADEL calculates the state from all the past changes.
|
The audit trail itself is identical to the state, since ZITADEL calculates the state from all the past changes.
|
||||||
|
|
||||||

|

|
||||||
|
@@ -8,7 +8,7 @@ The individual guides in this section should give you an overview of things to c
|
|||||||
|
|
||||||
When moving from a previous auth solution to ZITADEL, it is important to note that some decisions and features are unique to ZITADEL.
|
When moving from a previous auth solution to ZITADEL, it is important to note that some decisions and features are unique to ZITADEL.
|
||||||
Without duplicating too much content here are some important features and patterns to consider in terms of solution architecture.
|
Without duplicating too much content here are some important features and patterns to consider in terms of solution architecture.
|
||||||
You can read more about the basic structure and important concepts of ZITADEL in our [concepts section](https://zitadel.com/docs/concepts/introduction).
|
You can read more about the basic structure and important concepts of ZITADEL in our [concepts section](/docs/concepts/).
|
||||||
|
|
||||||
## Multi-Tenancy Architecture
|
## Multi-Tenancy Architecture
|
||||||
|
|
||||||
|
@@ -9,13 +9,15 @@ To apply best practices to your production setup we created a step by step check
|
|||||||
|
|
||||||
- [ ] Make use of configuration management tools such as Terraform to provision all of the below
|
- [ ] Make use of configuration management tools such as Terraform to provision all of the below
|
||||||
- [ ] Use a secrets manager to store your confidential information
|
- [ ] Use a secrets manager to store your confidential information
|
||||||
- [ ] Reduce the manual interaction with your platform to an absolute minimum
|
- [ ] Reduce the manual interaction with your platform to an absolute minimum
|
||||||
|
|
||||||
#### HA Setup
|
#### HA Setup
|
||||||
|
|
||||||
- [ ] High Availability for ZITADEL containers
|
- [ ] High Availability for ZITADEL containers
|
||||||
- [ ] Use a container orchestrator such as Kubernetes
|
- [ ] Use a container orchestrator such as Kubernetes
|
||||||
- [ ] Use serverless platform such as Knative or a hyperscaler equivalent (e.g. CloudRun from Google)
|
- [ ] Use serverless platform such as Knative or a hyperscaler equivalent (e.g. CloudRun from Google)
|
||||||
- [ ] Split `zitadel init` and `zitadel setup` for fast start-up times when [scaling](/docs/self-hosting/manage/updating_scaling) ZITADEL
|
- [ ] Split `zitadel init` and `zitadel setup` for fast start-up times when [scaling](/docs/self-hosting/manage/updating_scaling) ZITADEL
|
||||||
- [ ] High Availability for database
|
- [ ] High Availability for database
|
||||||
- [ ] Follow the [Production Checklist](https://www.cockroachlabs.com/docs/stable/recommended-production-settings.html) for CockroachDB if you selfhost the database or use [CockroachDB cloud](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account.html)
|
- [ ] Follow the [Production Checklist](https://www.cockroachlabs.com/docs/stable/recommended-production-settings.html) for CockroachDB if you selfhost the database or use [CockroachDB cloud](https://www.cockroachlabs.com/docs/cockroachcloud/create-an-account.html)
|
||||||
- [ ] Configure backups on a regular basis for the database
|
- [ ] Configure backups on a regular basis for the database
|
||||||
- [ ] Test the restore scenarios before going live
|
- [ ] Test the restore scenarios before going live
|
||||||
@@ -26,12 +28,14 @@ To apply best practices to your production setup we created a step by step check
|
|||||||
- [ ] Web Application Firewall
|
- [ ] Web Application Firewall
|
||||||
|
|
||||||
#### Networking
|
#### Networking
|
||||||
|
|
||||||
- [ ] Use a Layer 7 Web Application Firewall to secure ZITADEL that supports **[HTTP/2](/docs/self-hosting/manage/http2)**
|
- [ ] Use a Layer 7 Web Application Firewall to secure ZITADEL that supports **[HTTP/2](/docs/self-hosting/manage/http2)**
|
||||||
- [ ] Limit the access by IP addresses if needed
|
- [ ] Limit the access by IP addresses if needed
|
||||||
- [ ] 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](https://zitadel.com/docs/apis/ratelimits) for reference.
|
- [ ] 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](/docs/legal/rate-limit-policy) for reference.
|
||||||
- [ ] Check that your firewall also filters IPv6 traffic```
|
- [ ] Check that your firewall also filters IPv6 traffic
|
||||||
|
|
||||||
### ZITADEL configuration
|
### ZITADEL configuration
|
||||||
|
|
||||||
- [ ] Configure a valid [SMTP Server](/docs/guides/manage/console/instance-settings#smtp) and test the email delivery
|
- [ ] Configure a valid [SMTP Server](/docs/guides/manage/console/instance-settings#smtp) and test the email delivery
|
||||||
- [ ] Add [Custom Branding](/docs/guides/manage/customize/branding) if required
|
- [ ] Add [Custom Branding](/docs/guides/manage/customize/branding) if required
|
||||||
- [ ] Configure a valid [SMS Service](/docs/guides/manage/console/instance-settings#sms) such as Twilio if needed
|
- [ ] Configure a valid [SMS Service](/docs/guides/manage/console/instance-settings#sms) such as Twilio if needed
|
||||||
@@ -40,12 +44,14 @@ To apply best practices to your production setup we created a step by step check
|
|||||||
- [ ] Declare and apply zitadel configuration using the zitadel terraform [provider](https://github.com/zitadel/terraform-provider-zitadel)
|
- [ ] Declare and apply zitadel configuration using the zitadel terraform [provider](https://github.com/zitadel/terraform-provider-zitadel)
|
||||||
|
|
||||||
### Security
|
### Security
|
||||||
|
|
||||||
- [ ] Use a FQDN and a trusted valid certificate for external [TLS](/docs/self-hosting/manage/tls_modes#http2) connections
|
- [ ] Use a FQDN and a trusted valid certificate for external [TLS](/docs/self-hosting/manage/tls_modes#http2) connections
|
||||||
- [ ] Create service accounts for applications that interact with ZITADEL's APIs
|
- [ ] Create service accounts for applications that interact with ZITADEL's APIs
|
||||||
- [ ] Make use of a CDN service to decrease the load for static assets served by ZITADEL
|
- [ ] Make use of a CDN service to decrease the load for static assets served by ZITADEL
|
||||||
- [ ] Make use of a [security scanner](https://owasp.org/www-community/Vulnerability_Scanning_Tools) to test your application and deployment environment
|
- [ ] Make use of a [security scanner](https://owasp.org/www-community/Vulnerability_Scanning_Tools) to test your application and deployment environment
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
|
||||||
Use an appropriate monitoring solution to have an overview about your ZITADEL instance. In particular you may want to watch out for things like:
|
Use an appropriate monitoring solution to have an overview about your ZITADEL instance. In particular you may want to watch out for things like:
|
||||||
|
|
||||||
- [ ] CPU and memory of ZITADEL and the database
|
- [ ] CPU and memory of ZITADEL and the database
|
||||||
|
Reference in New Issue
Block a user