Merge pull request #1008 from nextcloud/chore/port-dev-setup-changes

chore: port dev setup changes

Author: saw-jan

.gitignore

@@ -29,6 +29,7 @@ compose.override.yaml
 !dev/.env
 dev/apps
 dev/certs
+dev/compose.override.yaml
 
 # server files
 server/

README.md

@@ -4,42 +4,44 @@
   - SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
   - SPDX-License-Identifier: AGPL-3.0-or-later
 -->
+
 # 🔗 OpenProject Integration
 
 [![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/integration_openproject)](https://api.reuse.software/info/github.com/nextcloud/integration_openproject)
 
-This application enables integration between Nextcloud and open-source project management software OpenProject. 
+This application enables integration between Nextcloud and open-source project management software OpenProject.
 
 ![](https://github.com/nextcloud/integration_openproject/raw/master/img/screenshot1.png)
 ![](https://github.com/nextcloud/integration_openproject/raw/master/img/screenshot2.png)
 
 On the Nextcloud end, it allows users to:
 
-* Link files and folders with work packages in OpenProject
-* Find all work packages linked to a file or a folder
-* Create work packages directly in Nextcloud
-* View OpenProject notifications via the dashboard
-* Search for work packages using Nextcloud's search bar
-* Link work packages in rich text fields via Smart Picker
-* Preview links to work packages in text fields
-* Link multiple files and folders to a work package at once
+- Link files and folders with work packages in OpenProject
+- Find all work packages linked to a file or a folder
+- Create work packages directly in Nextcloud
+- View OpenProject notifications via the dashboard
+- Search for work packages using Nextcloud's search bar
+- Link work packages in rich text fields via Smart Picker
+- Preview links to work packages in text fields
+- Link multiple files and folders to a work package at once
 
 On the OpenProject end, users are able to:
 
-* View all Nextcloud files and folders linked to a work package
-* Download linked files or open them in Nextcloud to edit them
-* Open linked files in Nextcloud to edit them
-* Let OpenProject create shared folders per project
+- View all Nextcloud files and folders linked to a work package
+- Download linked files or open them in Nextcloud to edit them
+- Open linked files in Nextcloud to edit them
+- Let OpenProject create shared folders per project
 
 Please report issues and bugs here: https://community.openproject.org/projects/nextcloud-integration/work_packages
 
 ## 📚 Documentation for users and administrators guide
+
 - For documentation on how to set up the integration as an administrator, refer to [Nextcloud integration setup](https://openproject.org/docs/system-admin-guide/integrations/nextcloud/).
 - For documentation on how to use the integration once it is set up, refer to [Using the Nextcloud integration](https://openproject.org/docs/user-guide/nextcloud-integration/).
 
 ## 🔨 Development Setup Guide
-- [Set up via docker](docs/setup_via_docker.md)
-- [Start Nextcloud-OpenProject full setup](docs/setup_nc_op__full.md)
+
+- [Start Nextcloud-OpenProject setup](docs/setup_nc_op__full.md)
 - [APIs for integration setup for admin](docs/setting_up_as_admin.md)
 - [Setting up Integration via Shell Script](docs/setting_up_via_shell_script.md)
 - [APIs for Direct Upload](docs/direct_upload.md)

dev/.env

@@ -14,9 +14,8 @@ OPENPROJECT_DEV_HOST=
 OPENPROJECT_RAILS__RELATIVE__URL__ROOT=
 OPENPROJECT_EDITION=
 
-# run keycloak
-KEYCLOAK=:keycloak.yaml
+# keycloak configurations
 KC_IMAGE_REPO=
 KC_IMAGE_TAG=
 
-COMPOSE_FILE=compose.yaml${KEYCLOAK:-}
+COMPOSE_FILE=compose.yaml

dev/compose.override.yaml.example

@@ -0,0 +1,2 @@
+# SPDX-FileCopyrightText: 2025 Jankari Tech Pvt. Ltd.
+# SPDX-License-Identifier: AGPL-3.0-or-later

dev/compose.yaml

@@ -158,13 +158,72 @@ services:
       traefik.http.routers.openproject.rule: Host(`${OPENPROJECT_DEV_HOST:-openproject.local}`)
       traefik.http.routers.openproject.entrypoints: websecure
 
+  keycloak-db:
+    image: postgres:14
+    restart: unless-stopped
+    networks:
+      - nc-op
+    environment:
+      POSTGRES_DB: keycloak
+      POSTGRES_USER: keycloak
+      POSTGRES_PASSWORD: keycloak
+      PGUSER: keycloak
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready', '-d', 'db_prod']
+      interval: 10s
+      timeout: 30s
+      retries: 5
+      start_period: 10s
+
+  keycloak:
+    build:
+      context: ./keycloak
+      args:
+        IMAGE_REPO: ${KC_IMAGE_REPO:-quay.io/keycloak/keycloak}
+        IMAGE_TAG: ${KC_IMAGE_TAG:-26.2}
+    restart: unless-stopped
+    command: ["--proxy-headers", "xforwarded", "--spi-connections-http-client-default-disable-trust-manager=true"]
+    environment:
+      KC_DB: postgres
+      KC_DB_USERNAME: keycloak
+      KC_DB_PASSWORD: keycloak
+      KC_DB_URL: jdbc:postgresql://keycloak-db:5432/keycloak
+      KC_BOOTSTRAP_ADMIN_USERNAME: admin
+      KC_BOOTSTRAP_ADMIN_PASSWORD: admin
+      KC_DB_SCHEMA: public
+      KC_HOSTNAME: keycloak.local
+      KC_FEATURES: preview
+      KC_TRANSACTION_XA_ENABLED: false
+      KC_REALM_NAME: opnc
+      KC_NEXTCLOUD_CLIENT_ID: nextcloud
+      KC_NEXTCLOUD_CLIENT_SECRET: nextcloud-secret
+      KC_NEXTCLOUD_CLIENT_HOST: nextcloud.local
+      KC_OPENPROJECT_CLIENT_ID: openproject
+      KC_OPENPROJECT_CLIENT_SECRET: openproject-secret
+      KC_OPENPROJECT_CLIENT_HOST: openproject.local
+    networks:
+      - nc-op
+    volumes:
+      - step:/step:ro
+      - keycloakdata:/opt/keycloak/data/
+    labels:
+      traefik.enable: true
+      traefik.http.routers.keycloak.rule: Host(`keycloak.local`)
+      traefik.http.routers.keycloak.entrypoints: websecure
+    depends_on:
+      traefik:
+        condition: service_started
+      keycloak-db:
+        condition: service_healthy
+
 volumes:
   ncdb:
   ncdata:
   apache_conf:
   opdb:
   opdata:
   step:
+  keycloakdata:
 
 networks:
   nc-op:

dev/keycloak.yaml

@@ -2,6 +2,7 @@
   - SPDX-FileCopyrightText: 2025 Jankari Tech Pvt. Ltd.
   - SPDX-License-Identifier: AGPL-3.0-or-later
 -->
+
 # Nextcloud-OpenProject Full Setup
 
 ## Table of Contents
@@ -31,28 +32,29 @@
    cd dev
    ```
 
-3. _(Optional)_ To enable keycloak service, uncomment the following line in the `dev/.env` file:
-
-   ```yaml
-   # run keycloak
-   KEYCLOAK=:keycloak.yaml
-   ```
-
-4. Start the services
+3. Start the services
 
    ```bash
    docker compose up
    ```
 
-5. Once the services are up, add the certificates to the system and browser trust store
+   > [!NOTE]
+   >
+   > Use `compose.override.yaml` file to override the services.
+   >
+   > ```bash
+   > cp compose.override.yaml.example compose.override.yaml
+   > ```
+
+4. Once the services are up, add the certificates to the system and browser trust store
 
    ```bash
    bash ./ssl.sh
    ```
 
    **NOTE:** Restart the browser after adding the certificates to the trust store.
 
-6. Access the services:
+5. Access the services:
 
    Nextcloud: [nextcloud.local](https://nextcloud.local)