mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-15 02:15:14 +00:00
d8ea041c56
## Todos for release - [x] Configure Env in docs project on vercel - [x] Configure Root Path in the docs project on vercel - [ ] Remove old CSP https://github.com/zitadel/website/pull/1592 ## What we did This pull request migrates the project documentation from the old `docs/` directory to the new `apps/docs/` directory, introduces a new documentation system built with Next.js and Fumadocs, and updates all relevant references, configuration files, and documentation to reflect this change. It also adds new configuration and ignore files for the new documentation app, updates CI and linting to exclude the new docs from certain checks, and revises the contributing guidelines accordingly. **Documentation System Migration and New Docs App** * Migrated all documentation from `docs/` to `apps/docs/`, and updated all references in `README.md`, `CONTRIBUTING.md`, and other files to point to the new location. [[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640) [[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607) [[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30) * Added a new Next.js/Fumadocs-based documentation app under `apps/docs/`, including core app files, layouts, routing, search API, and a comprehensive `README.md` with development and contribution instructions. [[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74) [[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39) [[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7) [apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81), [apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79), [[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7) [[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29) [[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25) **Configuration and Tooling Updates** * Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and `.github/dependabot.yml` to properly handle the new docs app: excluded `apps/docs` from certain checks, added npm dependency updates for the docs app, and excluded generated content. [[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14) [[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6) [[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129) [[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106) * Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3 version for consistency. **Licensing and Miscellaneous** * Added `apps/docs/` to the list of licensed directories in `LICENSING.md`. These changes ensure the documentation is now maintained in a modern, scalable system and all project tooling is updated to support the new structure. --------- Co-authored-by: Federico Coppede <[email protected]>
86 lines
5.0 KiB
Plaintext
86 lines
5.0 KiB
Plaintext
---
|
|
title: Service description for ZITADEL Cloud and ZITADEL Enterprise
|
|
sidebar_label: Service description
|
|
custom_edit_url: null
|
|
---
|
|
|
|
Last updated on April 5, 2024
|
|
|
|
This annex of the [Framework Agreement](../terms-of-service) describes the services offered by us.
|
|
|
|
## Services offered
|
|
|
|
### ZITADEL Cloud
|
|
|
|
[ZITADEL Cloud](https://zitadel.com) is a fully managed cloud service of the [ZITADEL software](https://github.com/zitadel).
|
|
|
|
You will benefit from the same software as the open-source project, but we take care of the hosting, maintenance, backup, scaling, and operational security. The cloud service is managed and maintained by the team that also develops the software.
|
|
|
|
When creating a new instance, you are able to choose a [data location](#data-location).
|
|
We follow a single-provider strategy by minimizing the involved [sub-processors](../subprocessors) to increase security, compliance, and performance of our services. [Billing](https://help.zitadel.com/pricing-and-billing-of-zitadel-services) is based on effective usage of our services.
|
|
|
|
### Enterprise license / self-hosted
|
|
|
|
The ZITADEL Enterprise license allows you to use the [ZITADEL software](https://github.com/zitadel) on your own data center or private cloud.
|
|
|
|
You will benefit from the transparency of the open source and the hyper-scalability of the same software that is being used to operate [ZITADEL Cloud](#zitadel-cloud).
|
|
|
|
#### Benefits over using open source / community license
|
|
|
|
- [Enterprise supported features](https://help.zitadel.com/zitadel-support-states#enterprise) are only supported under an Enterprise license
|
|
- Individual [onboarding support](./support-services#onboarding-support) tailored to your needs and team
|
|
- Get access to our support with a [Service Level Agreement](./support-services#service-level-agreement) that is tailored to your needs
|
|
- Benefit from personal [technical account management](./support-services#technical-account-manager) provided by our engineers to help you with architecture, integration, migration, and operational improvements of your setup
|
|
|
|
#### Benefits over ZITADEL Cloud
|
|
|
|
You can reduce your supply-chain risks by removing us as sub-processor of personal information about your users.
|
|
Support staff will have no access to your infrastructure and will only provide technical support.
|
|
Operation and direct maintenance of ZITADEL will be done by you.
|
|
|
|
You can freely choose the infrastructure and location to host ZITADEL.
|
|
|
|
### Responsibilities
|
|
|
|
Your obligations while operating and using ZITADEL are detailed in our [terms of service](/legal/terms-of-service#your-obligations) given the provisions in our [acceptable use policy](/legal/policies/acceptable-use-policy).
|
|
When using ZITADEL Cloud, we may processing data on behalf according to the [data processing agreement](/legal/data-processing-agreement).
|
|
|
|
In a self-hosted setup, you will be responsible for the cost, operations, and availability of your infrastructure.
|
|
For DDoS, bot, and threat detection and protection we rely on external services in ZITADEL Cloud.
|
|
In a self-hosted setup, it is your responsibility to secure the infrastructure to protect confidentiality, integrity, and availability of your data.
|
|
|
|
ZITADEL Cloud comes with pre-configured SMTP service, SMS service, and a generated domain name.
|
|
The SMTP service and SMS service are limited in use.
|
|
You should configure your own service providers for production use cases.
|
|
In a self-hosted setup, you will be responsible for SMTP / SMS services, domains and certificates.
|
|
|
|
| Responsibility | ZITADEL Cloud | Self-Hosted |
|
|
| --- | --- | --- |
|
|
| Data / Information | Customer | Customer |
|
|
| User Access | Customer | Customer |
|
|
| SMTP Service | Customer (trial: ZITADEL) | Customer |
|
|
| SMS Service | Customer (trial: ZITADEL) | Customer |
|
|
| Custom Domain / TLS | Customer (trial: ZITADEL) | Customer |
|
|
| DDoS & Bot protection | ZITADEL | Customer |
|
|
| WAF / Threat detection | ZITADEL | Customer |
|
|
| [Backup](#backup) | ZITADEL | Customer |
|
|
| Networking | ZITADEL | Customer |
|
|
| Compute / Scaling | ZITADEL | Customer |
|
|
| Database | ZITADEL | Customer |
|
|
| Application | ZITADEL | ZITADEL |
|
|
|
|
## Data location
|
|
|
|
Data location refers to a region, consisting of one or many countries or territories, where the customer's data is being hosted.
|
|
|
|
We can not guarantee that during transit the data will only remain within this region. We take measures, as outlined in our [privacy policy](../policies/privacy-policy), to protect your data in transit and in rest.
|
|
|
|
## Backup
|
|
|
|
Our backup strategy executes daily full backups and differential backups on much higher frequency.
|
|
In a disaster recovery scenario, our goal is to guarantee a recovery point objective (RPO) of 1h, and a higher but similar recovery time objective (RTO).
|
|
Under normal operations, RPO and RTO goals are below 1 minute.
|
|
|
|
If you you have different requirements we provide you with a flexible approach to backup, restore, and transfer data (f.e. to a self-hosted setup) through our APIs.
|
|
Please consult the [migration guides](/guides/migrate/introduction) for more information.
|