Deployed 1df574f with MkDocs version: 1.6.1

geosolutions-it · Oct 24, 2024 · dae25c0 · dae25c0
1 parent 8bdb078
commit dae25c0
Show file tree

Hide file tree

Showing 16 changed files with 1,257 additions and 3 deletions.
diff --git a/404.html b/404.html
@@ -237,6 +237,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/users-teams/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Users and Teams
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="/api-keys/" class="md-nav__link">
 
@@ -291,6 +311,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/proxy" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Proxy Services
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/api-keys/index.html b/api-keys/index.html
@@ -13,7 +13,7 @@
 
 
 
-        <link rel="prev" href="..">
+        <link rel="prev" href="../users-teams/">
 
 
         <link rel="next" href="../integration-with-geoserver/">
@@ -244,6 +244,26 @@
 
 
 
+
+
+    <li class="md-nav__item">
+      <a href="../users-teams/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Users and Teams
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
 
 
 
@@ -345,6 +365,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../proxy" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Proxy Services
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>

diff --git a/images/access_rule_admin.png b/images/access_rule_admin.png
diff --git a/images/account_info.png b/images/account_info.png
diff --git a/images/account_resources.png b/images/account_resources.png
diff --git a/images/resource_admin.png b/images/resource_admin.png
diff --git a/images/role_admin.png b/images/role_admin.png
diff --git a/images/teams_admin.png b/images/teams_admin.png
diff --git a/images/user_admin.png b/images/user_admin.png
diff --git a/index.html b/index.html
@@ -14,7 +14,7 @@
 
 
 
-        <link rel="next" href="api-keys/">
+        <link rel="next" href="users-teams/">
 
 
       <link rel="icon" href="assets/images/favicon.png">
@@ -296,6 +296,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#configuration" class="md-nav__link">
+    <span class="md-ellipsis">
+      Configuration
+    </span>
+  </a>
+
 </li>
 
       </ul>
@@ -410,6 +419,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="users-teams/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Users and Teams
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="api-keys/" class="md-nav__link">
 
@@ -464,6 +493,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="proxy" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Proxy Services
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>
@@ -516,6 +565,15 @@
     </span>
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#configuration" class="md-nav__link">
+    <span class="md-ellipsis">
+      Configuration
+    </span>
+  </a>
+
 </li>
 
       </ul>
@@ -702,6 +760,28 @@ <h3 id="installation">Installation</h3>
 and in OPENID CONNECT PROVIDER add row to Clients table.</p>
 <p>You can also check User registration form at <code>http://localhost:8000/register</code>. REMEMBER: to register the User
 you first need update <code>djam/project/conf/local/email.py</code> configuration file with SMTP server credentials.   </p>
+<h3 id="configuration">Configuration</h3>
+<p>DJAM can be configured with the following environmental variables:</p>
+<ul>
+<li><code>SITEURL</code>: URL of the DJAM service (default=localhost)</li>
+<li><code>DJAM_PROJECT_ENVIRONMENT</code>: "prod" | "dev"</li>
+<li><code>DJAM_SECRET_KEY</code>: secret key used by crypto functionalities in DJAM (see <a href="https://docs.djangoproject.com/en/4.2/ref/settings/#secret-key">Django SECRET KEY</a> for additional information)</li>
+<li><code>DJAM_APIKEY_EXPIRE_DAYS</code>: The expiration timedelta of the <a href="api-keys/">API Keys</a> in days. The default value is 30</li>
+<li><code>DJAM_SHOW_API_KEYS_IN_DASHBOARD</code>: Show users <a href="api-keys/">API Keys</a> inside the User Resources section</li>
+<li><code>DJAM_SHOW_UPSTREAM_SERVICES_IN_DASHBOARD</code>: Show list of <a href="proxy/">authenticated proxy services</a> available to the user inside the User Resources section</li>
+<li><code>DJAM_REQUIRE_SECURE_HTTP_FOR_GEOSERVER_INTROSPECTION</code>: Allow <a href="integration-with-geoserver/">authentication requests</a> from non-secure (no SSL) Geoserver hosts (defaul "True")</li>
+<li><code>DJAM_EMAIL_HOST</code>: SMTP host for the email verification and activation of new accounts. This is used only if self-registration is enabled (disabled by default)</li>
+<li><code>DJAM_EMAIL_PORT</code>: SMTP port</li>
+<li><code>DJAM_EMAIL_HOST_USER</code>: SMTP username</li>
+<li><code>DJAM_EMAIL_HOST_PASSWORD</code>: SMTP password</li>
+<li><code>DJAM_DB_HOST</code>: hostname of the PostgreSQL DB Server</li>
+<li><code>DJAM_DB_PORT</code>: port of the PostgreSQL DB Server  (default=5432)</li>
+<li><code>DJAM_DB_NAME</code>: PostgreSQL DB name for DJAM</li>
+<li><code>DJAM_DB_USER</code>: DJAM PostgreSQL DB username</li>
+<li><code>DJAM_DB_PASSWORD</code>: DJAM PostgreSQL DB password</li>
+<li><code>DJAM_RABBITMQ_HOST</code>: hostname of the RabbitMQ Service  (default=localhost)</li>
+<li><code>DJAM_RABBITMQ_PORT</code>: port of the RabbitMQ Service  (default=5672)</li>
+</ul>
 <h2 id="api-documentation-swagger">API Documentation - Swagger</h2>
 <p>To create the corresponding schema.yml for the API documentation (Swagger) run the following command:</p>
 <pre><code class="language-bash">python manage.py spectacular --color --file schema.yml

diff --git a/integration-with-geoserver/index.html b/integration-with-geoserver/index.html
@@ -244,6 +244,26 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../users-teams/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Users and Teams
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="../api-keys/" class="md-nav__link">
 
@@ -458,6 +478,26 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../proxy" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    Proxy Services
+  </span>
+
+
+      </a>
+    </li>
+
+
+
   </ul>
 </nav>
                   </div>
@@ -669,6 +709,7 @@ <h5 id="configure-the-authentication-key-provider">Configure the Authentication
 <li>Provide a <code>Name</code> for the provider</li>
 <li>Change the name of the URL parameter to be used to identify the keys; the default one for DJAM is “authkey”, meaning that the requests will be in the form: <code>http://....?...&amp;authkey=&lt;the_user_key&gt;</code></li>
 <li>Select “Web Service” as authentication user mapper. This will configure Geoserver to use DJAM as the external authentication service. Fill in the values reported in the picture below.</li>
+<li>Fill the field “Web Service Response User Search Regular Expression”, with the following:  ^.<em>?\"username\"\s</em>:\s<em>\"([^\"]+)\".</em>$</li>
 <li>Select “djam_groupservice” (created before) as “User/Group Service”</li>
 </ul>
 <p><img alt="auth key provider" src="../images/auth_key_provider.png" /></p>