Skip to content

Commit

Permalink
docs: update scarf pixel url
Browse files Browse the repository at this point in the history
  • Loading branch information
mo-auto committed Dec 20, 2024
1 parent e24ed0b commit 9100c2a
Show file tree
Hide file tree
Showing 67 changed files with 199 additions and 199 deletions.
134 changes: 67 additions & 67 deletions charts/index.yaml

Large diffs are not rendered by default.

Binary file modified charts/janssen-0.0.0-nightly.tgz
Binary file not shown.
Binary file modified charts/janssen-all-in-one-0.0.0-nightly.tgz
Binary file not shown.
4 changes: 2 additions & 2 deletions nightly/CONTRIBUTING/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8711,11 +8711,11 @@ <h3 id="referencing-janssen-project-release-in-documents">Referencing Janssen Pr
<p>Above command contains references to the release number at two places. <code>v1.1.4</code> in the URL and <code>1.1.4</code> as part of the file
name. There are many such places throughout the documentation when release numbers need to be mentioned. Whenever we
make a new release, these numbers need to change as they point to the latest release number. This becomes a manual task.</p>
<p>To avoid this manual, error-prone approach the Janssen Project uses a release marker, <code>replace-janssen-version</code> instead
<p>To avoid this manual, error-prone approach the Janssen Project uses a release marker, <code>0.0.0-nightly</code> instead
of writing actual release numbers in the <code>head</code>(latest) documentation branch. So, when there is a need to mention the release number, instead of
writing the actual release number, use the release marker. Let's see how to document the above command (at the <code>head</code> version)
so that it stays up-to-date release after release.</p>
<div class="highlight"><pre><span></span><code>wget https://github.com/JanssenProject/jans/releases/download/vreplace-janssen-version/jans_replace-janssen-version.ubuntu20.04_amd64.deb -P /tmp
<div class="highlight"><pre><span></span><code>wget https://github.com/JanssenProject/jans/releases/download/nightly/jans_0.0.0-nightly.ubuntu20.04_amd64.deb -P /tmp
</code></pre></div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
Expand Down
2 changes: 1 addition & 1 deletion nightly/casa/administration/quick-start/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8649,7 +8649,7 @@ <h1 id="jans-casa-quick-start-guide">Jans Casa Quick Start Guide<a class="header
</div>
<p>Use this guide to install and configure your Casa deployment.</p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h2>
<p>Jans Casa can be used with <a href="https://jans.io">Janssen Server</a> or <a href="https://gluu.org">Gluu Flex Server</a>. At <a href="https://docs.jans.io/vreplace-janssen-version/admin/install/">installation</a> time (applies to any of these two products), you will be prompted if you desire to include Casa. If you want to add Casa post-installation, you will simply have to re-run the installer and ensure to select Casa.</p>
<p>Jans Casa can be used with <a href="https://jans.io">Janssen Server</a> or <a href="https://gluu.org">Gluu Flex Server</a>. At <a href="https://docs.jans.io/nightly/admin/install/">installation</a> time (applies to any of these two products), you will be prompted if you desire to include Casa. If you want to add Casa post-installation, you will simply have to re-run the installer and ensure to select Casa.</p>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">#</a></h2>
<h3 id="enable-authentication-methods">Enable authentication methods<a class="headerlink" href="#enable-authentication-methods" title="Permanent link">#</a></h3>
<p>The "out-of-the-box" login experience in Casa consists of the usual username and password prompt. To start leveraging a stronger authentication login to Casa with an administrative account (visit <code>https://&lt;your-server-name&gt;/jans-casa</code>) and activate the <a href="../admin-console/#authentication-methods">methods</a> you want to offer Casa users.</p>
Expand Down
4 changes: 2 additions & 2 deletions nightly/casa/developer/add-authn-methods/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8788,7 +8788,7 @@ <h3 id="about-casa-authentication-flow">About Casa authentication flow<a class="
<p>Authentication in Casa is implemented through an Agama project called <em>casa</em> - in TUI you can see it listed in the Agama management screen. As a first step, the user is requested to enter the username and password combination, then depending on how the application is configured, personal user settings, and access policies defined, a second factor may be requested.</p>
<p>The <em>casa</em> project allows to onboard new types of second factors (authentication mechanisms) and also provides a user experience that supports backtracking: if a user is asked to present a specific credential and that credential is not currently available or is not working, he can choose an alternative method for authentication where a different type of credential will be prompted. Users can backtrack several times.</p>
<h3 id="flow-requisites">Flow requisites<a class="headerlink" href="#flow-requisites" title="Permanent link">#</a></h3>
<p>To code the flow corresponding to the authentication method to add, you can use the Agama project found <a href="https://github.com/JanssenProject/jans/tree/vreplace-janssen-version/jans-casa/plugins/samples/sample-cred/agama#readme">here</a> as a canvas. Ensure the following conditions are met so that it properly integrates in the main Casa flow:</p>
<p>To code the flow corresponding to the authentication method to add, you can use the Agama project found <a href="https://github.com/JanssenProject/jans/tree/nightly/jans-casa/plugins/samples/sample-cred/agama#readme">here</a> as a canvas. Ensure the following conditions are met so that it properly integrates in the main Casa flow:</p>
<p>The flow will be passed an Agama <em>map</em> containing information of the person attempting the authentication. This input parameter will contain at least three keys: <code>uid</code>, <code>inum</code>, and <code>name</code>. <code>uid</code> and <code>inum</code> map directly to attributes stored in the user's profile and are never empty, <code>name</code> is a displayable name which may come from attribute <code>givenName</code> or <code>displayName</code>. All values are <em>strings</em>.</p>
<p>The flow should terminate with a <code>true</code> outcome if the user successfully passes the challenge, presents the expected credential, etc. In any other case, <code>false</code> must be returned and an optional error message can be included for the caller flow (<code>io.jans.casa.authn.main</code>) to show it in the screen. Any additional data attached in the <code>Finish</code> instruction will not be processed. </p>
<p>If for some reason your flow crashes, the corresponding exception will be printed to the logs, the caller will continue running, and the browser taken to the <a href="#the-selector-page">selector page</a> where an error message will be displayed.</p>
Expand Down Expand Up @@ -8867,7 +8867,7 @@ <h3 id="key-questions">Key questions<a class="headerlink" href="#key-questions"
</ul>
<p>Depending on the answers, you may like to start instead with plugin development first. This is not always the case though, however, getting your hands on the plugin might help unclutter the path.</p>
<h2 id="enrollment-plugin">Enrollment plugin<a class="headerlink" href="#enrollment-plugin" title="Permanent link">#</a></h2>
<p>Coding a Casa plugin is mainly a Java development task. You can use the "Sample credential" <a href="https://github.com/JanssenProject/jans/tree/vreplace-janssen-version/jans-casa/plugins/samples/sample-cred#readme">plugin</a> as a template to start the work. Ensure you have:</p>
<p>Coding a Casa plugin is mainly a Java development task. You can use the "Sample credential" <a href="https://github.com/JanssenProject/jans/tree/nightly/jans-casa/plugins/samples/sample-cred#readme">plugin</a> as a template to start the work. Ensure you have:</p>
<ul>
<li>
<p>A Jans Server installation that includes Jans Casa - prefer a VM environment over the CN edition for development purposes. Also, you'll need a way to connect to your server via SSH</p>
Expand Down
8 changes: 4 additions & 4 deletions nightly/casa/developer/overview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8742,11 +8742,11 @@ <h3 id="tools">Tools<a class="headerlink" href="#tools" title="Permanent link">#
<li>The underlying database engine used by your Jans Server installation, e.g. PostgreSQL, MySQL, etc.</li>
</ul>
<h3 id="sample-plugins">Sample plugins<a class="headerlink" href="#sample-plugins" title="Permanent link">#</a></h3>
<p>The best way to start learning Casa plugin development is by playing with the sample plugins you can find <a href="https://github.com/JanssenProject/jans/tree/vreplace-janssen-version/jans-casa/plugins/samples">here</a>. Clone the repository (a shallow clone of <code>main</code> branch is fine), <code>cd</code> to one of the directories in the folder and run <code>mvn package</code>, then upload the resulting <code>jar-with-dependencies</code> through the administration console.</p>
<p>The best way to start learning Casa plugin development is by playing with the sample plugins you can find <a href="https://github.com/JanssenProject/jans/tree/nightly/jans-casa/plugins/samples">here</a>. Clone the repository (a shallow clone of <code>main</code> branch is fine), <code>cd</code> to one of the directories in the folder and run <code>mvn package</code>, then upload the resulting <code>jar-with-dependencies</code> through the administration console.</p>
<h2 id="configuration-management">Configuration management<a class="headerlink" href="#configuration-management" title="Permanent link">#</a></h2>
<p>Most aspects of Casa that are configurable through the admin console UI can be programmatically operated using the configuration API. A formal description can be found <a href="https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/jans-casa/app/src/main/webapp/admin-api.yaml">here</a>. Note all endpoints are protected by OAuth tokens which must have the <code>https://jans.io/casa.config</code> scope.</p>
<p>Most aspects of Casa that are configurable through the admin console UI can be programmatically operated using the configuration API. A formal description can be found <a href="https://github.com/JanssenProject/jans/raw/nightly/jans-casa/app/src/main/webapp/admin-api.yaml">here</a>. Note all endpoints are protected by OAuth tokens which must have the <code>https://jans.io/casa.config</code> scope.</p>
<h2 id="credentials-enrollment">Credentials enrollment<a class="headerlink" href="#credentials-enrollment" title="Permanent link">#</a></h2>
<p>Casa has enrollment capabilities built-in but there are use cases where credential enrollment needs to happen elsewhere in your app ecosystem. A typical scenario is in a user registration application, where users are asked to enroll strong authentication credentials during account creation. To facilitate these tasks, Casa exposes <a href="https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/jans-casa/app/src/main/webapp/enrollment-api.yaml">APIs</a> for enrolling the following types of authenticators: </p>
<p>Casa has enrollment capabilities built-in but there are use cases where credential enrollment needs to happen elsewhere in your app ecosystem. A typical scenario is in a user registration application, where users are asked to enroll strong authentication credentials during account creation. To facilitate these tasks, Casa exposes <a href="https://github.com/JanssenProject/jans/raw/nightly/jans-casa/app/src/main/webapp/enrollment-api.yaml">APIs</a> for enrolling the following types of authenticators: </p>
<ul>
<li>Phone numbers for SMS OTP</li>
<li>OTP apps or tokens </li>
Expand Down Expand Up @@ -8781,7 +8781,7 @@ <h3 id="casa-acr-update">Casa ACR update<a class="headerlink" href="#casa-acr-up
<p>Given the warning above, there has to be a way to launch a different Agama flow than the one used by default to log into Casa. This can be achieved by supplying a value for Casa's <code>acr</code> startup variable: in VM-based installations, locate the file <code>/etc/default/casa</code> in and modify the variable as needed. The format is <code>agama_&lt;qualified-name-of-your-flow&gt;</code>. Then restart Casa. </p>
<h3 id="requisites">Requisites<a class="headerlink" href="#requisites" title="Permanent link">#</a></h3>
<p>Regardless of the customization required, it is desirable to get acquaintance with Agama <a href="../../../agama/introduction/">framework</a>. This is a good time to go through the Agama developer guide pages found in the Administration section of Jans Server docs. Specifically, several of the Agama <a href="../../../janssen-server/developer/agama/advanced-usages/#advanced-usages">advanced usages</a> will help you materialize your requirements.</p>
<p>Extract <a href="https://maven.jans.io/maven/io/jans/casa-agama/replace-janssen-version/casa-agama-vreplace-janssen-version-project.zip">the Agama project</a> to your development machine. It is useful to get an idea of how and what the out-of-the-box project does. Also, keep the <a href="https://freemarker.apache.org/docs/index.html">Freemarker</a> manual at hand.</p>
<p>Extract <a href="https://maven.jans.io/maven/io/jans/casa-agama/0.0.0-nightly/casa-agama-nightly-project.zip">the Agama project</a> to your development machine. It is useful to get an idea of how and what the out-of-the-box project does. Also, keep the <a href="https://freemarker.apache.org/docs/index.html">Freemarker</a> manual at hand.</p>
<h3 id="page-customizations">Page customizations<a class="headerlink" href="#page-customizations" title="Permanent link">#</a></h3>
<p>The UI pages of the default Casa flow resemble the design of the Casa app itself. Also, modifications applied through the "custom branding" functionalities are automatically reflected in flow pages without any sort of intervention. This is neat, but if you need to go further, you will have to code the UI pages your own based on the existing ones.</p>
<p>For this purpose, create a new Agama project with one flow in it. Pick one of the pages you want to change from the original project and build your own - initially keep it really simple: a dummy page is OK. From your new flow, use the <code>Trigger</code> directive to launch flow <code>io.jans.casa.authn.main</code>. Add an <code>Override templates</code> directive to your <code>Trigger</code> so the page in Casa project is superseded by the page you are creating. This is explained <a href="../../../janssen-server/developer/agama/advanced-usages/#template-overrides">here</a>.</p>
Expand Down
4 changes: 2 additions & 2 deletions nightly/casa/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8596,14 +8596,14 @@ <h2 id="two-factor-authentication">Two-factor authentication<a class="headerlink
</ul>
<p>Additional authenticators and use cases can be supported via <a href="#existing-plugins">custom plugins</a>.</p>
<h2 id="2fa-enrollment-apis">2FA enrollment APIs<a class="headerlink" href="#2fa-enrollment-apis" title="Permanent link">#</a></h2>
<p>To facilitate 2FA device enrollment during account registration, or elsewhere in an application ecosystem, Casa exposes <a href="https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/jans-casa/app/src/main/webapp/enrollment-api.yaml">APIs</a> for enrolling the following types of authenticators: </p>
<p>To facilitate 2FA device enrollment during account registration, or elsewhere in an application ecosystem, Casa exposes <a href="https://github.com/JanssenProject/jans/raw/nightly/jans-casa/app/src/main/webapp/enrollment-api.yaml">APIs</a> for enrolling the following types of authenticators: </p>
<ul>
<li>Phone numbers for SMS OTP</li>
<li>OTP apps, cards, or dongles </li>
<li>FIDO security keys</li>
</ul>
<h2 id="configuration-via-apis">Configuration via APIs<a class="headerlink" href="#configuration-via-apis" title="Permanent link">#</a></h2>
<p>Besides a comprehensive graphical <a href="administration/admin-console/">admin console</a>, application settings can also be manipulated by means of a configuration <a href="https://github.com/JanssenProject/jans/raw/vreplace-janssen-version/jans-casa/app/src/main/webapp/admin-api.yaml">API</a>.</p>
<p>Besides a comprehensive graphical <a href="administration/admin-console/">admin console</a>, application settings can also be manipulated by means of a configuration <a href="https://github.com/JanssenProject/jans/raw/nightly/jans-casa/app/src/main/webapp/admin-api.yaml">API</a>.</p>
<h2 id="existing-plugins">Existing plugins<a class="headerlink" href="#existing-plugins" title="Permanent link">#</a></h2>
<p>Casa is a plugin-oriented, Java web application. Existing functionality can be extended and new functionality and APIs can be introduced through plugins. Currently, there are plugins available for the following:</p>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions nightly/casa/plugins/2fa-settings/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8651,7 +8651,7 @@ <h2 id="requirements">Requirements<a class="headerlink" href="#requirements" tit
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">#</a></h2>
<ol>
<li>
<p><a href="https://maven.jans.io/maven/io/jans/casa/plugins/strong-authn-settings/replace-janssen-version/strong-authn-settings-replace-janssen-version-jar-with-dependencies.jar">Download the plugin</a></p>
<p><a href="https://maven.jans.io/maven/io/jans/casa/plugins/strong-authn-settings/0.0.0-nightly/strong-authn-settings-0.0.0-nightly-jar-with-dependencies.jar">Download the plugin</a></p>
</li>
<li>
<p>Log in to Casa using an administrator account</p>
Expand All @@ -8673,7 +8673,7 @@ <h2 id="how-to-use">How to use<a class="headerlink" href="#how-to-use" title="Pe
<p>For regular users, proper details appear in the widget where 2FA is turned on.</p>
<p><img alt="2fa-settings" src="../../../assets/casa/admin-console/2fa_user_policy.png" /></p>
<h2 id="api">API<a class="headerlink" href="#api" title="Permanent link">#</a></h2>
<p>Configurations provided by this plugin can also be applied by means of the API exposed for this purpose. A formal description of the API can be found in this <a href="https://raw.githubusercontent.com/JanssenProject/jans/vreplace-janssen-version/jans-casa/plugins/strong-authn-settings/src/main/resources/assets/2fa-admin-api.yaml">swagger</a> file. Note all endpoints are protected by tokens which must have the <code>https://jans.io/casa.config</code> OAuth scope.</p>
<p>Configurations provided by this plugin can also be applied by means of the API exposed for this purpose. A formal description of the API can be found in this <a href="https://raw.githubusercontent.com/JanssenProject/jans/nightly/jans-casa/plugins/strong-authn-settings/src/main/resources/assets/2fa-admin-api.yaml">swagger</a> file. Note all endpoints are protected by tokens which must have the <code>https://jans.io/casa.config</code> OAuth scope.</p>

<hr>
<div class="md-source-file">
Expand Down
Loading

0 comments on commit 9100c2a

Please sign in to comment.