remove formatting from headers

2026-06-14 03:30:14 +00:00 · 2026-04-15 09:16:36 +02:00
parent 3044d984d9
commit 2eb8c7ed73
7 changed files with 32 additions and 28 deletions
@@ -394,7 +394,7 @@ This wizard step allows you to auto-install an Apache2 web server to function as

 The available options are:

-### **Install Apache2 web server** (default)
+### Install Apache2 web server (default)

 We recommend that you let OpenProject install and configure the outer web server, in which case we will install an Apache2 web server with a VirtualHost listening to the domain name you specify, optionally providing SSL/TLS termination.

@@ -65,7 +65,7 @@ multiple requests to be made simultaneously. Having just one will work, but page
 These numbers are a guideline only and your mileage may vary.
 It's best to monitor your server and its resource usage. You can always allocate more resources if needed.

-### **Scaling horizontally**
+### Scaling horizontally

 At some point simply increasing the resources of one single server may not be enough anymore.

@@ -99,7 +99,7 @@ These values are **guidelines** and should be adjusted based on actual monitorin

 ## Example configurations

-### **Small instance (≤ 200 users, low concurrent activity)**
+### Small instance (≤ 200 users, low concurrent activity)

 - **Database**: 2 CPU / 4 GiB RAM

@@ -113,7 +113,7 @@ These values are **guidelines** and should be adjusted based on actual monitorin

 - **Disk Space**: 20 GB + additional disk space in case of internal attachment storage

-### **Medium instance (~500 users, moderate concurrent activity)**
+### Medium instance (~500 users, moderate concurrent activity)

 - **Database**: 2-4 CPU / 8 GiB RAM
 - **CPU**: 4 CPU
@@ -122,7 +122,7 @@ These values are **guidelines** and should be adjusted based on actual monitorin
 - **Background Workers**: 2 multithreaded workers with 4-6 GiB RAM
 - **Disk Space**: 50 GB + additional disk space in case of internal attachment storage

-### **Large instance (~1500 users, medium to high concurrent activity)**
+### Large instance (~1500 users, medium to high concurrent activity)

 - **Database**: 4-8 CPU / 16 GiB RAM
 - **CPU**: 8 CPU
@@ -131,7 +131,7 @@ These values are **guidelines** and should be adjusted based on actual monitorin
 - **Background Workers**: 4-8 multithreaded workers with 4-6GiB RAM, depending on workload
 - **Disk Space**: 100 GB + additional disk space in case of internal attachment storage

-### **Enterprise-scale multitenancy instance (~80K - 100K users, high concurrent activity)**
+### Enterprise-scale multitenancy instance (~80K - 100K users, high concurrent activity)

 - **Database**: Cluster of two 8 vCPU / 32 GiB RAM (e.g., AWS db.m7g.xlarge, Gravitron 3)
 - **Worker instances**: 2-4 instances of the following
@@ -24,49 +24,49 @@ The Home Dashboard is your **central hub** for project management on mobile. Its

 The Home Dashboard consists of **modular widgets** that provide snapshots of your most relevant data. Depending on your role and project access, some widgets may vary.

-### **Notifications**
+### Notifications

 *   Displays recent notifications, such as mentions, comments, or work package updates.
 *   Enables you to **react quickly** without leaving the dashboard.

 ![Home dashboard notifications widget in the OpenProject mobile app](mobile_app_homewidget_notifications.png)

-### **Favorite Projects**
+### Favorite Projects

 *   Displays projects you’ve marked as favorites for **quick access**.
 *   Ideal for prioritizing high-importance projects.

 ![Home dashboard displaying "favorite projects" widget in the OpenProject mobile app](mobile_app_homewidget_favoriteprojects.png)

-### **Time Tracker**
+### Time Tracker

 *   Shows the **currently running timer** or allows you to start a new focus timer.
 *   Helps track work time efficiently and accurately.

 ![Home dashboard displaying the "time tracker" widget in OpenProject mobile app](mobile_app_homewidget_timetracker.png)

-### **Week Time Tracking**
+### Week Time Tracking

 *   Provides an overview of **time logged during the current week**.
 *   Helps you monitor your productivity and ensure accurate reporting.

 ![Home dashboard displaying "week time tracking" widget in the OpenProject mobile app](mobile_app_homewidget_weektimetracking.png)

-### **Portfolios**
+### Portfolios

 *   Shows a snapshot of the portfolios available.
 *   Useful for portfolio managers and team members tracking **high-level progress** across multiple projects.

 ![Home dashboard displaying "portfolios" widget in the OpenProject mobile app](mobile_app_homewidget_portfolios.png)

-### **Assigned to Me**
+### Assigned to Me

 *   Lists all **work packages currently assigned to you**.
 *   Includes work package types and status indicators for quick task management.

 ![Home dashboard displaying "work packages assigned to me" widget in the OpenProject mobile app](mobile_app_homewidget_assignedtome.png)

-### **Recently Edited**
+### Recently Edited

 *   Shows a list of **recently edited work packages**.
 *   Allows **fast navigation** back to items that are work in progress.
@@ -103,7 +103,7 @@ Please see the [advanced configuration guide](../../../installation-and-operatio

 By default, OpenProject will synchronize user account details (name, e-mail, login) and their account status from the LDAP through a background worker job every 24 hours.

-### **Enable status synchronization**
+### Enable status synchronization

 If you wish to synchronize the account status from the LDAP, you can enable status synchronization using the following configuration:

@@ -53,7 +53,9 @@ The authentication endpoints of OpenProject OAuth2 server are:
 * Access Token URL: `https://example.com/oauth/token`

 ## Obtaining OAuth2 access token
-### *Authorization code flow* example
+
+### Authorization code flow example
+
 #### Request authorization code

 Request an authorization code. Please adopt the following URL replacing:
@@ -116,7 +118,8 @@ The response will look like this:
 The response contains the bearer token ("access_token") and a refresh token that you will need when working with the API.
 Please copy the tokens for reference.

-### *Client credentials flow* example
+### Client credentials flow example
+
 #### Request OAuth access token

 With client credentials you can request an API token directly from `/oauth/token` endpoint.
@@ -16,7 +16,7 @@ OpenProject supports automated user synchronization via SCIM API, enabling  seam

 To activate and configure SCIM user and group provisioning in OpenProject, navigate to *Administration* -> *Authentication* and select *SCIM clients* from the left-hand menu.

-## Configure a new SCIM client.
+## Configure a new SCIM client

 SCIM client is a system (e.g. Keycloak with [SCIM plugin](https://github.com/mitodl/keycloak-scim)) that uses SCIM protocol to provision user and group identities in an automated and standardized way.

@@ -31,21 +31,22 @@ To add a new SCIM client, click the **+ SCIM client** button in the upper right

 A configuration form for your SCIM client will open, in which you can adjust the SCIM client details.

-### Step 1. Enter the **Name** of your SCIM client.
+### Step 1. Enter the Name of your SCIM client

 ![A SCIM client creation form in OpenProject administration, with the Name field highlighted and filled out](add_scim_2.png)

-### Step 2. Choose an **Authentication provider**.
+### Step 2. Choose an Authentication provider
+
 This is the service that users added by the SCIM provider will use to authenticate in OpenProject.
 It must have been configured before creating the SCIM client. It can be an [OIDC provider](../openid-providers/) or a [SAML provider](../saml/).

 ![A SCIM client creation form in OpenProject administration, with the "Authentication provider" field highlighted and filled out](add_scim_3.png)

-### Step 3. Choose an **Authentication method**.
+### Step 3. Choose an Authentication method.

 There are three *Authentication method* options you can choose from:

-####  a. **Static access token**
+#### a. Static access token

 > [!IMPORTANT]
 > Static access tokens are valid for period of 1 year. After that, they expire and must be replaced.
@@ -82,7 +83,7 @@ Here is an example of a configuration form in Keycloak, if you use it with [SCIM
 6. Enable user and group propagation. Enable import during sync.
 7. **Save** the configuration.

-#### b. **OAuth 2.0 client credentials**
+#### b. OAuth 2.0 client credentials

 If in [Step 3](#step-3-choose-an-authentication-method) you selected **OAuth 2.0 client credentials**, after clicking **Create** you will get client credentials of newly created [OpenProject OAuth Application](../oauth-applications/#oauth-applications). These credentials should be entered into the SCIM client configuration on the other end. The SCIM client is supposed to use the provided client credentials to obtain an access token with the `scim_v2` scope from OpenProject and then use the access token in SCIM API requests.

@@ -92,7 +93,7 @@ Once you click **Create**, client credentials (client ID and secret) will be gen

 ![A confirmation message that a SCIM client was created, showing client credentials to be copied in OpenProject administration](add_scim_8.png)

-#### c. **JWT from identity provider**
+#### c. JWT from identity provider

 If in [Step 3](#step-3-choose-an-authentication-method) you selected **JWT from identity provider**, you will have to specify **Subject claim** contained in the authentication JWT.