diff --git a/site/docs/administrate/02-organisations.en.md b/site/docs/administrate/02-organisations.en.md index f569b57b3..8ead0848b 100644 --- a/site/docs/administrate/02-organisations.en.md +++ b/site/docs/administrate/02-organisations.en.md @@ -37,28 +37,76 @@ An organisation can have multiple domain names, but only one of it can be primar Browse to your [organisation](administrate#Organisations) by visiting [https://console.zitadel.ch/org](https://console.zitadel.ch/org). Add the domain to your [organisation](administrate#Organisations) by clicking the button **Add Domain**. -Organisation Overview +
+
+ + Organisation Overview + +
Organisation Overview
+
+
Input the domain in the input field and click **Add** -Organisation Add Domain - -Organisation Domain Added - +
+
+ + Organisation Add Domain + +
Organisation Add Domain
+
+
+ + Organisation Domain Added + +
Organisation Domain Added
+
+
To start the domain verification click the domain name and a dialog will appear, where you can choose between DNS or HTTP challenge methods. -Organisation Domain Verify +
+
+ + Organisation Domain Verify + +
Organisation Domain Verify
+
+
For example, create a TXT record with your DNS provider for the used domain an click verify. **ZITADEL** will then proceed an check your DNS. -Organisation Domain Verify DNS +
+
+ + Organisation Domain Verify DNS + +
Organisation Domain Verify DNS
+
+
+ > Do not delete the verification code **ZITADEL** will recheck the ownership from time to time When the verification is successful you have the option to activate the domain by clicking **Set as primary** -Organisation Domain Verified + +
+
+ + Organization Domain Verified + +
Organisation verified
+
+
> This changes the **preferred loginnames** of your [users](administrate#Users) as indicated [here](administrate#How_ZITADEL_handles_usernames). Gratulations your are done! You can check this by visiting [https://console.zitadel.ch/users/me](https://console.zitadel.ch/users/me) -User Personal Information + +
+
+ + User Personal Information + +
User Personal Information
+
+
> This only works when the [user](administrate#Users) is member of this [organisation](administrate#Organisations) diff --git a/site/docs/administrate/03-projects.en.md b/site/docs/administrate/03-projects.en.md index 3e2d4fe7f..9fc9d0b38 100644 --- a/site/docs/administrate/03-projects.en.md +++ b/site/docs/administrate/03-projects.en.md @@ -42,11 +42,25 @@ To make it more easily to differentiate ZITADEL Console displays these both as s To create your project go to [https://console.zitadel.ch/projects](https://console.zitadel.ch/projects) -Manage Projects +
+
+ + Manage Projects + +
Manage Projects
+
+
Create a new project with name which explains what's the intended use of this project. -Manage Projects +
+
+ + Manage Projects + +
Manage Projects
+
+
#### RBAC Settings diff --git a/site/docs/administrate/04-clients.en.md b/site/docs/administrate/04-clients.en.md index cf23d639e..78d4632ae 100644 --- a/site/docs/administrate/04-clients.en.md +++ b/site/docs/administrate/04-clients.en.md @@ -24,18 +24,51 @@ The wizard can be skipped for people who are needing special settings. To create a new client start by browsing to your [project](administrate#Projects), this is normally something like [https://console.zitadel.ch/projects/78562301657017889](https://console.zitadel.ch/projects/78562301657017889) -Manage Clients +
+
+ + Manage Clients + +
Manage Clients
+
+
Click the **New** button and a wizard will appear which will guide you through the process. -Client Wizard - -Client Wizard - -Client Wizard - -Client Wizard +
+
+ + Client Wizard 1 + +
Client Wizard 1
+
+
+ + Client Wizard 2 + +
Client Wizard 2
+
+
+ + Client Wizard 3 + +
Client Wizard 3
+
+
+ + Client Wizard 4 + +
Client Wizard 4
+
+
When the wizard is complete, the clients configuration will be displayed and you can now use this client. -Client Wizard \ No newline at end of file +
+
+ + Client Wizard Complete + +
Client Wizard Complete
+
+
\ No newline at end of file diff --git a/site/docs/administrate/06-users.en.md b/site/docs/administrate/06-users.en.md index 9f7395279..0663545ad 100644 --- a/site/docs/administrate/06-users.en.md +++ b/site/docs/administrate/06-users.en.md @@ -29,21 +29,49 @@ If someone verifies a domain name within the organisation **ZITADEL** will gener #### Search Users -User list Search +
+
+ + User list Search + +
User list Search
+
+
Image 1: User List Search #### Create Users -User list +
+
+ + User list + +
User list
+
+
Image 2: User List -User Create Form +
+
+ + User Create Form + +
User Create Form
+
+
Image 3: User Create Form -User Create Done +
+
+ + User Create Done + +
User Create Done
+
+
Image 4: User Create Done diff --git a/site/docs/develop/00-overview.en.md b/site/docs/develop/00-overview.en.md index 6f01d34b2..c34397971 100644 --- a/site/docs/develop/00-overview.en.md +++ b/site/docs/develop/00-overview.en.md @@ -7,6 +7,8 @@ description: … ### APIs +--- + ZITADEL provides three API's for different use cases. These API's are built with GRPC and then generate a REST service. Each services proto definition is located in the source control on GitHub. As we generate the REST services and Swagger file out of the proto definition we recommend that you rely on the proto file. @@ -27,6 +29,8 @@ See below for an example with the call **GetMyUser**. } ``` +--- + As you can see the `GetMyUser` function is also available as REST service under the path `/users/me`. In the table below you can see the URI of those calls. diff --git a/site/docs/documentation/03-openidoauth.en.md b/site/docs/documentation/03-openidoauth.en.md index e24477bdf..efa1a5c85 100644 --- a/site/docs/documentation/03-openidoauth.en.md +++ b/site/docs/documentation/03-openidoauth.en.md @@ -18,7 +18,7 @@ Under normal circumstances **ZITADEL** need four domain names to operate properl #### OpenID Connect 1.0 Discovery The OpenID Connect Discovery Endpoint is located with the issuer domain. -For example with [zitadel.ch](zitadel.ch) this would be the domain [issuer.zitadel.ch](issuer.zitadel.ch). This would give us [https://issuer.zitadel.ch/.well-known/openid-configuration](https://issuer.zitadel.ch/.well-known/openid-configuration). +For example with [zitadel.ch](https://zitadel.ch) this would be the domain [issuer.zitadel.ch](https://issuer.zitadel.ch). This would give us [https://issuer.zitadel.ch/.well-known/openid-configuration](https://issuer.zitadel.ch/.well-known/openid-configuration). **Link to spec.** [OpenID Connect Discovery 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-discovery-1_0.html) diff --git a/site/docs/integrate/01-openidoauth.en.md b/site/docs/integrate/01-openidoauth.en.md index cc91a2254..48b251762 100644 --- a/site/docs/integrate/01-openidoauth.en.md +++ b/site/docs/integrate/01-openidoauth.en.md @@ -23,6 +23,8 @@ In the OIDC and OAuth world this client profile is called "native application" ### How to consume authorizations in your application or service +--- + With ZITADEL you can manage the [roles](administrate#Roles) a [project](administrate#Projects) supplies to your users in the form of authorizations. On the [project](administrate#Projects) it can be configured how **project roles** are supplied to the [clients](administrate#Clients). By default ZITADEL asserts the claim **urn:zitadel:iam:org:project:roles** to the [Userinfo Endpoint](documentation#userinfo_endpoint) @@ -39,4 +41,6 @@ By default ZITADEL asserts the claim **urn:zitadel:iam:org:project:roles** to th } ``` +--- + For more details about how **ZITADEL** treats [scopes](documentation#Scopes) and [claims](documentation#Claims) see the [documentations](documentation). diff --git a/site/docs/start/00-quick-start.en.md b/site/docs/start/00-quick-start.en.md index 3ca8c2c7c..855f25f81 100644 --- a/site/docs/start/00-quick-start.en.md +++ b/site/docs/start/00-quick-start.en.md @@ -14,7 +14,14 @@ You can either use [ZITADEL.ch](https://zitadel.ch) or deploy a dedicated **ZITA To register your free [organisation](administrate#Organisations), visit this link [register organisation](https://accounts.zitadel.ch/register/org). After accepting the TOS and filling out all the required fields you will receive a email with further instructions. -Organisation Register +
+
+ + Organisation Overview + +
Organisation Register
+
+
#### Verify your domain name (optional) diff --git a/site/docs/use/00-user.en.md b/site/docs/use/00-user.en.md index a14d4ddf1..b4556372c 100644 --- a/site/docs/use/00-user.en.md +++ b/site/docs/use/00-user.en.md @@ -22,14 +22,23 @@ title: User Manual ### Login User -Login Username - -Image: Login Username - -Login Password - -Image: Login Password - -Login OTP - -Image: Login OTP +
+
+ + Login Username + +
Login Username
+
+
+ + Login Password + +
Login Password
+
+
+ + Login OTP + +
Login OTP
+
+
diff --git a/site/package-lock.json b/site/package-lock.json index d09403902..37d381583 100644 --- a/site/package-lock.json +++ b/site/package-lock.json @@ -2666,9 +2666,9 @@ } }, "rollup": { - "version": "2.23.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.23.0.tgz", - "integrity": "sha512-vLNmZFUGVwrnqNAJ/BvuLk1MtWzu4IuoqsH9UWK5AIdO3rt8/CSiJNvPvCIvfzrbNsqKbNzPAG1V2O4eTe2XZg==", + "version": "2.32.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.32.1.tgz", + "integrity": "sha512-Op2vWTpvK7t6/Qnm1TTh7VjEZZkN8RWgf0DHbkKzQBwNf748YhXbozHVefqpPp/Fuyk/PQPAnYsBxAEtlMvpUw==", "dev": true, "requires": { "fsevents": "~2.1.2" @@ -2985,9 +2985,9 @@ } }, "svelte": { - "version": "3.29.0", - "resolved": "https://registry.npmjs.org/svelte/-/svelte-3.29.0.tgz", - "integrity": "sha512-f+A65eyOQ5ujETLy+igNXtlr6AEjAQLYd1yJE1VwNiXMQO5Z/Vmiy3rL+zblV/9jd7rtTTWqO1IcuXsP2Qv0OA==", + "version": "3.29.4", + "resolved": "https://registry.npmjs.org/svelte/-/svelte-3.29.4.tgz", + "integrity": "sha512-oW0fGHlyFFMvzRtIvOs84b0fOc0gmZNQcL5Is3hxuTpvaYX3pfd8oHy4KnOvbq4Ca6SG6AHdRMk7OhApTo0NqA==", "dev": true }, "svelte-i18n": { @@ -3065,9 +3065,9 @@ } }, "uglify-js": { - "version": "3.11.2", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.11.2.tgz", - "integrity": "sha512-G440NU6fewtnQftSgqRV1r2A5ChKbU1gqFCJ7I8S7MPpY/eZZfLGefaY6gUZYiWebMaO+txgiQ1ZyLDuNWJulg==", + "version": "3.11.4", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.11.4.tgz", + "integrity": "sha512-FyYnoxVL1D6+jDGQpbK5jW6y/2JlVfRfEeQ67BPCUg5wfCjaKOpr2XeceE4QL+MkhxliLtf5EbrMDZgzpt2CNw==", "dev": true }, "unicode-canonical-property-names-ecmascript": { diff --git a/site/package.json b/site/package.json index f04604e04..3b069ebf6 100644 --- a/site/package.json +++ b/site/package.json @@ -32,13 +32,13 @@ "@rollup/plugin-json": "^4.0.3", "@rollup/plugin-node-resolve": "^9.0.0", "npm-run-all": "^4.1.5", - "rollup": "^2.15.0", + "rollup": "^2.32.1", "rollup-plugin-babel": "^4.4.0", "rollup-plugin-livereload": "^2.0.0", "rollup-plugin-replace": "^2.2.0", "rollup-plugin-svelte": "^6.0.1", "rollup-plugin-terser": "^7.0.2", "sapper": "^0.28.10", - "svelte": "^3.20.1" + "svelte": "^3.29.4" } } diff --git a/site/rollup.config.js b/site/rollup.config.js index f738ee7c2..7b0c2b6e0 100644 --- a/site/rollup.config.js +++ b/site/rollup.config.js @@ -13,7 +13,20 @@ const mode = process.env.NODE_ENV; const dev = mode === 'development'; const legacy = !!process.env.SAPPER_LEGACY_BUILD; -const onwarn = (warning, onwarn) => (warning.code === 'CIRCULAR_DEPENDENCY' && /[/\\]@sapper[/\\]/.test(warning.message)) || onwarn(warning); +const onwarn = (warning, onwarn) => { + if ( + (warning.code === 'CIRCULAR_DEPENDENCY' && + /[/\\]@sapper[/\\]/.test(warning.message)) + ) { + return; + } + + if (warning.code === 'THIS_IS_UNDEFINED') { + return; + } + + onwarn(warning); +}; export default { client: { diff --git a/site/src/client.js b/site/src/client.js index 4be221b4b..fb03b5816 100644 --- a/site/src/client.js +++ b/site/src/client.js @@ -3,9 +3,12 @@ import '../static/base.css'; import * as sapper from '@sapper/app'; import { startClient } from './i18n.js'; +import { initPhotoSwipeFromDOM } from './utils/photoswipe.js'; startClient(); +initPhotoSwipeFromDOM('.zitadel-gallery'); + sapper.start({ target: document.querySelector('#sapper') }); diff --git a/site/src/components/PhotoSwipe.svelte b/site/src/components/PhotoSwipe.svelte new file mode 100644 index 000000000..270add43a --- /dev/null +++ b/site/src/components/PhotoSwipe.svelte @@ -0,0 +1,62 @@ + \ No newline at end of file diff --git a/site/src/routes/[slug].svelte b/site/src/routes/[slug].svelte index e61d2182c..309ae841e 100644 --- a/site/src/routes/[slug].svelte +++ b/site/src/routes/[slug].svelte @@ -12,7 +12,13 @@ import Docs from "../components/Docs.svelte"; export let slug; export let sections; + import { onMount } from 'svelte'; export let tags; + import { initPhotoSwipeFromDOM } from '../utils/photoswipe.js'; + + onMount(() => { + initPhotoSwipeFromDOM('.zitadel-gallery'); + }); diff --git a/site/src/routes/_layout.svelte b/site/src/routes/_layout.svelte index 35a59ef76..0239765c2 100644 --- a/site/src/routes/_layout.svelte +++ b/site/src/routes/_layout.svelte @@ -4,6 +4,7 @@ import Nav from "../components/Nav.svelte"; import NavItem from "../components/NavItem.svelte"; import manifest from '../../static/manifest.json'; + import PhotoSwipe from '../components/PhotoSwipe.svelte'; export let segment; const { page } = stores(); @@ -22,4 +23,5 @@
+
diff --git a/site/src/template.html b/site/src/template.html index e8a3611a6..448f83a55 100644 --- a/site/src/template.html +++ b/site/src/template.html @@ -13,6 +13,12 @@ + + + + + +