Skip to content

Latest commit

 

History

History
251 lines (193 loc) · 9.12 KB

setup_via_docker.md

File metadata and controls

251 lines (193 loc) · 9.12 KB
Raw

Development

Develop using docker compose

Requirements:

  • Node.js (>=v14.0.0)

  • NPM (>=v7.0.0)

  • Docker (>=v19.03.0)

  • Docker Compose

    • for v1, minimum version required is v1.29.0, make sure to use docker-compose instead of docker compose
    • this guide is written for v2

  • OpenProject server instance

    It must be reachable by the hostname host.docker.internal in the host machine. You can do this through this environment variable: OPENPROJECT_DEV_EXTRA_HOSTS=host.docker.internal.

    It must also use hostname host.docker.internal:3000 instead of localhost:3000 in the settings. Change it in Administration > System settings > General > Host name, or through the environment variable OPENPROJECT_HOST__NAME=host.docker.internal:3000.

    host.docker.internal will resolve to 127.0.0.1 on the docker host and to something like 172.17.0.1 inside of the docker services, so OpenProject needs to listen to those addresses. For that use the -b option if you are running OpenProject manually e.g. bin/rails server -b 0.0.0.0 or when using foreman set HOST=0.0.0.0 as env. variable.

    The whole OpenProject start command might look something like:

    • manual start: OPENPROJECT_DEV_EXTRA_HOSTS=host.docker.internal OPENPROJECT_HOST__NAME=host.docker.internal:3000 RAILS_ENV=development bin/rails server -b 0.0.0.0
    • using foreman: HOST=0.0.0.0 OPENPROJECT_DEV_EXTRA_HOSTS=host.docker.internal OPENPROJECT_HOST__NAME=host.docker.internal:3000 foreman start -f Procfile.dev

    For more information see: OpenProject documentation

  • OpenProject Integration app

Setup

# the app needs to be cloned inside the "custom_apps" dir
mkdir $HOME/development/custom_apps -p
cd $HOME/development/custom_apps
git clone https://github.com/nextcloud/integration_openproject.git

# installation & building
cd integration_openproject
npm ci
npm run build

# provide group ownership of "custom_apps" to the user "www-data"
sudo chgrp www-data $HOME/development/custom_apps -R
sudo chmod g+w $HOME/development/custom_apps -R

Environments

  • APP_DIR
    • description: location where the integration_openproject repository is cloned
    • default: ./../../custom_apps

Start compose

It is highly recommended to regularly update the included containers.

docker compose pull

Now, run the containers. In order to expose a port of the nextcloud containers, make sure to provide a docker-compose.override.yml specifying the exposed ports. In this example, we assume you simply use the content of the provided docker-compose.override.example.yml, which exposes port 8080.

cp docker-compose.override.example.yml docker-compose.override.yml
docker compose up

Note: If you've cloned the integration app anywhere other that the default ./../../custom_apps, provide its path in the APP_DIR environment variable

APP_DIR=<path-to-integration-app> docker compose up

After this, you should be able to access the Nextcloud server at http://localhost:8080.

Setup NC server

Note: These steps will only be necessary for the first setup.

Database

With our compose setup, there are two options for the database:

  • SQLite: No specific configuration is necessary
  • PostgreSQL:
    • Database: nextcloud
    • User: nextcloud
    • Password: nextcloud

Installation

The NC server installation can be done in two ways:

  1. With occ command (CLI):

    • Using PostgreSQL as database type: 
      docker compose exec --user www-data nextcloud php occ maintenance:install -vvv \
--database pgsql \
--database-name nextcloud \
--database-host db \
--database-user nextcloud \
--database-pass nextcloud \
--admin-user admin \
--admin-pass admin \
--data-dir /var/www/html/data
    • Using SQLite as database type: 
      docker compose exec --user www-data nextcloud php occ maintenance:install -vvv \
--admin-user admin \
--admin-pass admin \
--data-dir /var/www/html/data

  2. With the browser (WebUI):

    1. Browse to http://localhost:8080
    2. Fill Create an admin account form
    3. Choose the database type
    4. Click the Install button

Enable the integration app:

You can browse as admin to the apps center and enable it using the webUI, or you can just use the terminal as:

docker compose exec --user www-data nextcloud php occ a:e integration_openproject

Allow local remote servers:

docker compose exec --user www-data nextcloud php occ config:system:set allow_local_remote_servers --value 1

Configure the integration app:

  • as NextCloud admin browse to Settings->Administration->OpenProject
  • configure the connection to OpenProject using http://host.docker.internal:3000 as the OpenProject URL
  • in OpenProject use http://localhost:8080 as the NextCloud URL

Change the setup for testing purpose

Strip off Authorization Bearer tokens of HTTP requests

If the bearer tokens are not forwarded to Nextcloud the authorization cannot work and that needs to be detected by OpenProject. Easiest way to do that is to disable mod_rewrite in Apache:

docker compose exec nextcloud a2dismod rewrite
docker compose exec nextcloud service apache2 restart

To enable it again, run:

docker compose exec nextcloud a2enmod rewrite
docker compose exec nextcloud service apache2 restart
Change version of Nextcloud

To test another version of Nextcloud change the nextcloud images in the docker-compose.override.yml e.g:

services:
  nextcloud:
    image: nextcloud:24-apache
    ports:
      - "8080:80"

  cron:
    image: nextcloud:24-apache

Please note:

  1. Only apache based versions will work
  2. Nextcloud does not support downgrading. If you want to go back to an older version, you need to delete all the volumes with docker compose down -v and start the Nextcloud installation again
Disable pretty URLs

Nextcloud can work with or without index.php in the URL. The connection to OpenProject has to work regardless of how it is configured.

By default, the docker setup in this repo starts Nextcloud without index.php in the URL. To change that, we have to edit the .htaccess file. The code that is responsible to rewrite the URLs and make them prettier is attached at the bottom of the .htaccess file in the Nextcloud folder.

It looks like that:

#### DO NOT CHANGE ANYTHING ABOVE THIS LINE ####

ErrorDocument 403 /
ErrorDocument 404 /
<IfModule mod_rewrite.c>
  Options -MultiViews
  RewriteRule ^core/js/oc.js$ index.php [PT,E=PATH_INFO:$1]
  RewriteRule ^core/preview.png$ index.php [PT,E=PATH_INFO:$1]
...
</IfModule>

If you haven't changed anything else in the .htaccess file, deleting everything below #### DO NOT CHANGE ANYTHING ABOVE THIS LINE #### will reset the file to a state where it does not rewrite the URLs.

You can use sed to do it in one command:

docker compose exec --user www-data nextcloud sed -i '/#### DO NOT CHANGE ANYTHING ABOVE THIS LINE ####/,$d' .htaccess

To remove index.php again from the URL run

docker compose exec --user www-data nextcloud php occ maintenance:update:htaccess

This will put the rewrite rules back into the .htaccess file.

Serve Nextcloud from a sub folder

The default docker configuration serves Nextcloud from the root of the domain (http://localhost:8080/), but it is also possible to serve it from a sub folder e.g. http://localhost:8080/nextcloud/. To do that with the existing docker configuration, there are a couple of steps to take.

  1. configure apache to serve the parent folder as DocumentRoot: 
    docker compose exec nextcloud sed -i 's/DocumentRoot \/var\/www\/html/DocumentRoot \/var\/www/' /etc/apache2/sites-enabled/000-default.conf
  2. configure apache to accept settings from .htaccess on any level: 
    docker compose exec nextcloud sed -i 's/AllowOverride None/AllowOverride All/' /etc/apache2/apache2.conf
  3. restart apache: 
    docker compose exec nextcloud service apache2 restart
  4. delete existing Nextcloud configuration for pretty URLs as it's set to the root folder 
    docker compose exec --user www-data nextcloud  rm config/apache-pretty-urls.config.php
  5. set the sub folder as the new base for pretty urls: 
    docker compose exec --user www-data nextcloud php occ config:system:set htaccess.RewriteBase --value '/html/'
docker compose exec --user www-data nextcloud php occ config:system:set overwrite.cli.url --value 'http://localhost/html'
docker compose exec --user www-data nextcloud php occ maintenance:update:htaccess

Now, you should be able to reach the Nextcloud installation at http://localhost:8080/html/

Start Developing

Now you can watch for the app code changes using the following command and start developing.

cd $HOME/development/custom_apps/integration_openproject
npm run watch