Files
zitadel/docs/docs/guides/customization/branding.md
T
c8d59ee488 docs: restructure and add more content (#2232)
* docs: restructure quickstarts

* docs: quickstart libs

* docs: add exlixir lib

* docs: restructure

* docs: restructure

* docs: customization

* use tabs in oauth/oidc endpoints.md

* improve authorize_endpoint

* improve token_endpoint and introspection_endpoint

* docs: saas use case

* styling

* styling

* begin login users

* login users

* login users

* fix table

* fix: links

* fix: links

* start go api

* fix: policy structure

* fix: saas description

* fix: saas description

* fix: saas description

* Update docs/docs/concepts/policies.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <[email protected]>

* docs: organisation --> organization

* docs: fixes

* docs: fixes

* Update docs/docs/apis/openidoauth/endpoints.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/concepts/policies.md

Co-authored-by: Florian Forster <[email protected]>

* Update docs/docs/apis/openidoauth/endpoints.md

Co-authored-by: Florian Forster <[email protected]>

* Apply suggestions from code review

Co-authored-by: Florian Forster <[email protected]>

* docs: intro

* Update docs/docs/guides/customization/branding.md

Co-authored-by: Florian Forster <[email protected]>

* fix: typo

* add mermaid

Co-authored-by: Livio Amstutz <[email protected]>
Co-authored-by: mffap <[email protected]>
Co-authored-by: Florian Forster <[email protected]>
2021-09-23 10:34:06 +02:00

2.1 KiB

title
title
Brand Customization

ZITADEL offers various customization options for your projects brand design. Head over to the Private Labeling Policy on your Organization Page.

How it works

You are able to customize the light and a dark mode separately. All your changes will be shown in the preview window on the right side. As soon as you are happy with your configuration click the "Apply configuration" button. After this your settings will trigger in your system. The login and the emails will be sent with your branding.

Settings

Private Labeling

Upload your logo for the chosen theme, as soon as it is uploaded the preview on the right side of the screen should show it.

Colors

In the next part you can configure your colors. Background colour is self-explanatory, the primary color will be used for buttons, links and some highlights. The warn color is used for all the error messages and warnings and the font colour for texts.

Font

Last step to apply to your branding is the font upload. The best way is to upload a ttf file after a successful upload you will see it in the font part, but not in the preview.

Advanced Settings

In the advanced behavior you can choose if the loginname suffix (domain e.g [email protected]) should be shown in the loginname screen or not and if the “ZITADEL watermark” should be hidden.

Trigger the private labeling for the login

If you like to trigger your settings for your applications you have different possibilities.

1. Primary Domain Scope

Send a primary domain scope with your authorization request to trigger your organization. The primary domain scope will restrict the login to your organization, so only users of your own organization will be able to login.

2. Setting on your Project

Set the private labeling setting on your project to define which branding should trigger.

Reset to default

If you don't like your customization anymore click the "reset policy" button. All your settings will be removed and the default settings of the system will trigger.