# Epic XWI-12 - Wiki integration setup on OpenProject

Project: Stream XWiki integration
Status: closed
URL: https://community.openproject.org/work_packages/XWI-12

## Detailed specification

### Motivation and background information

Ensures consistent, secure access control between OpenProject and XWiki: any viewing or action from one tool to the other strictly respects the user’s permissions in the target tool.

### Acceptance criteria

#### 

  - Before OpenProject project members are able to access, link to and create wiki pages in XWiki, an administrator has to set up the integration. This is a one-time operation per wiki instance.

  - There is a new entry in the administration settings, at *Administration → Wikis → Wiki providers*
    
      - This will display all existing integrations with wiki providers.
    
      - There is an additional menu item *Administration → Wikis → Internal wiki*
        
          - The internal Wiki can be enabled/disabled on the instance and is enabled by default.

  - Administrators can click on the **+ Wiki provider** button and select "XWiki" to be taken to the "**New XWiki provider**" page where they can begin configuring the integration.

  - Setting up an XWiki-OpenProject integration involves two main steps on the OpenProject side, through which the users are guided step-by-step:
    
      - In *General information*, the admin user gives the XWiki instance to which they're connecting a name, a host URL and the Authentication method.
    
      - In *OAuth configuration*, there is an exchange of OAuth client IDs and secrets between the two applications.
        
          - OpenProject will generate its own values that the user will have to paste into the OpenProject extension setup flow in XWiki.
        
          - ~~XWiki will, in turn, also generate a client ID and secret that the user will be asked to enter on this page.~~
        
          - The XWiki client ID, secret and redirect URL are also generated in OpenProject for the user to copy them into the OpenProject extension in XWiki

  - In *My account / Access tokens* the current user can revoke/delete each access token that was granted to each XWiki instance.

  - A health check can be performed after the setup, which signals a working state or provides clues about any issues.

### Out of scope

*   Extended Health Checks
    
*   Project Spaces
    
*   Centralized license management

| Attribute | Value |
| --- | --- |
| Mockups | https://www.figma.com/design/m0Aj4o5upRvD2kdSB7mMQT/XWiki-Integration?node-id=2545-22328&t=935dR9qQk7ioU5gk-0 |

## Planning

| Attribute | Value |
| --- | --- |
| Roadmap | 2026 Q2 |
| Date |  – 2026-06-30 |
| Votes |  |
| List | RM Jira exit |
| Target versions | 17.6.0 |
| Sprint |  |
| Backlog bucket |  |
| Relevance |  |

## Subitems

| ID | Type | Subject | Status | Assignee | Target versions | Project | Priority | Spent time |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| XWI-17 | Feature | Create, update and delete a wiki provider of type xwiki | closed |  | 17.6.0 | Stream XWiki integration | Medium |  |
| XWI-30 | Feature | Add health checks for external wiki integrations | closed |  | 17.6.0 | Stream XWiki integration | Medium |  |
| XWI-81 | Feature | XWiki enterprise banner in admin settings | closed |  | 17.6.0 | Stream XWiki integration | Medium |  |
| XWI-97 | Feature | Update Icon for wiki providers | closed |  | 17.6.0 | Stream XWiki integration | Medium |  |
| XWI-105 | Feature | Expose installation UUID via API | closed |  | 17.6.0 | Stream XWiki integration | Medium |  |
| XWI-108 | Feature | Configure internal wiki provider | closed |  | 17.6.0 | Stream XWiki integration | Medium |  |
| XWI-25 | Open Point | Will wiki still be a module to be enabled or disabled? | decided |  |  | Stream XWiki integration | Medium |  |

## Bugs and other work packages

| ID | Type | Subject | Status | Assignee | Target versions | Module |
| --- | --- | --- | --- | --- | --- | --- |
| XWI-123 | Bug | Feature flag for XWiki integration not force enabled | closed |  | 17.6.0 | Integrations / XWiki |
| XWI-60 | Documentation | Add documentation for the admins how to create xwiki provider | needs review | Eric Schubert | 17.6.0 | Integrations / XWiki |
| XWI-25 | Open Point | Will wiki still be a module to be enabled or disabled? | decided |  |  |  |

## Details

| Attribute | Value |
| --- | --- |
| Module | Integrations / XWiki |
| Enterprise plan | Enterprise / Corporate (COR) |
| Labels |  |

## People

| Attribute | Value |
| --- | --- |
| Assignee |  |
| Accountable | Dominic Bräunlein |
| Product manager |  |
| Feature Lead |  |
| Designer | Parimal Satyal |
| Developers | OP Dev Titan Team |
| Requested by |  |
| Interest by | Black (37919) |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| Work |  |

## Description

**As** an administrator of an OpenProject instance  
**I want to** set up an integration with XWiki  
**so that** users of my instance (project members, project admins, stakeholders) may access, link to and create wiki pages via OpenProject

####   

#### Prerequisites

*   XWiki instance is reachable
    
*   ~~XWiki instance provides an info endpoint so that OpenProject can verify that a minimal expected version is available.~~
    
    *   ~~version number of XWiki~~
        
    *   ~~(in case it is managed separately) version number of the OpenProject integration code~~
        
*   Connection to XWiki instance is TLS encrypted as required by the OAuth2 standard
    
*   The CA certificate for the XWiki TLS certificate is either a generally known CA or is provided during OpenProject boot time
    

####
