Merge pull request #170 from terrestris/include-example-plugins

Include gis client example plugin

README.md

@@ -32,6 +32,7 @@ components:
 - SHOGun (the backend part)
 - SHOGun-Admin (the UI for handling SHOGun entities)
 - SHOGun-GIS-Client (the default mapping client)
+- SHOGun-GIS-Client example plugin (a dummy example plugin for demonstration purposes)
 
 ### Recommended directory structure
 
@@ -43,20 +44,22 @@ your-shogun-workspace-directory/
 ├── shogun (https://github.com/terrestris/shogun)
 ├── shogun-admin (https://github.com/terrestris/shogun-admin)
 ├── shogun-gis-client (https://github.com/terrestris/shogun-gis-client)
+├── shogun-gis-client-example-plugin (https://github.com/terrestris/shogun-gis-client-example-plugin)
 └── shogun-docker (this repository)
 ```
 
 ### Required steps for the very first start
 
 - Check and fulfill all development notes of the child components (e.g. installing the `maven` and `node` dependencies). For the required repositories the following commands should be used:
-  - shogun-gis-client: npm i
-  - shogun-admin: npm i
-  - shogun: mvn clean install -DskipTests -Djib.skip=true
-  - shogun-docker: docker compose pull
+  - shogun-gis-client: `npm i`
+  - shogun-gis-client-example-plugin: `npm i`
+  - shogun-admin: `npm i`
+  - shogun: `mvn clean install -DskipTests -Djib.skip=true`
+  - shogun-docker: `docker compose pull`
 - Set all required environment variables (and create a local SSL certificate) by executing `./setEnvironment.sh create` (and adjusting the values if needed).
 - If you are using a different directory layout, make sure to adjust the paths in the `.env` file
 - Import the initial Keycloak data, see section [Keycloak Import](#import).
-- execute `chmod -R a+w shogun-solr/solr_data` to allow the solr service to write to the directory.
+- Execute `chmod -R a+w shogun-solr/solr_data` to allow the solr service to write to the directory.
 
 ### Startup
 

common-services.yml

@@ -77,6 +77,8 @@ services:
       - shogun-admin-client-docs
   shogun-client:
     container_name: ${CONTAINER_NAME_PREFIX}-gis-client
+  shogun-client-plugins:
+    container_name: ${CONTAINER_NAME_PREFIX}-gis-client-plugins
   shogun-admin:
     container_name: ${CONTAINER_NAME_PREFIX}-admin
   shogun-boot:

docker-compose-prod.yml

@@ -75,6 +75,18 @@ services:
       retries: 5
       start_period: 5s
       timeout: 10s
+  # shogun-client-plugins:
+  #   extends:
+  #     file: ./common-services.yml
+  #     service: shogun-client-plugins
+  #   image: your_plugin_image:1.0.0
+  #   restart: unless-stopped
+  #   healthcheck:
+  #     test: wget --no-verbose --tries=1 --spider http://localhost || exit 1
+  #     interval: 10s
+  #     retries: 5
+  #     start_period: 5s
+  #     timeout: 10s
   shogun-boot:
     extends:
       file: ./common-services.yml

docker-compose.yml

@@ -40,6 +40,15 @@ services:
       dockerfile: Dockerfile.dev
     volumes:
       - ${SHOGUN_CLIENT_DIR}:/app
+  shogun-client-plugins:
+    extends:
+      file: ./common-services.yml
+      service: shogun-client-plugins
+    build:
+      context: ${SHOGUN_CLIENT_PLUGINS_DIR}
+      dockerfile: Dockerfile.dev
+    volumes:
+      - ${SHOGUN_CLIENT_PLUGINS_DIR}:/app
   shogun-admin:
     extends:
       file: ./common-services.yml

setEnvironment.sh

@@ -7,6 +7,7 @@ set -e
 SHOGUN_DIR=../shogun
 SHOGUN_ADMIN_DIR=../shogun-admin
 SHOGUN_CLIENT_DIR=../shogun-gis-client
+SHOGUN_CLIENT_PLUGINS_DIR=../shogun-gis-client-example-plugin
 
 # Container prefix
 CONTAINER_NAME_PREFIX=shogun
@@ -92,6 +93,7 @@ if [ "$MODE" = "create" ]; then
   echo "SHOGUN_DIR=${SHOGUN_DIR}" > $SCRIPT_DIR/$ENV_FILE
   echo "SHOGUN_ADMIN_DIR=${SHOGUN_ADMIN_DIR}" >> $SCRIPT_DIR/$ENV_FILE
   echo "SHOGUN_CLIENT_DIR=${SHOGUN_CLIENT_DIR}" >> $SCRIPT_DIR/$ENV_FILE
+  echo "SHOGUN_CLIENT_PLUGINS_DIR=${SHOGUN_CLIENT_PLUGINS_DIR}" >> $SCRIPT_DIR/$ENV_FILE
 
   echo "CONTAINER_NAME_PREFIX=${CONTAINER_NAME_PREFIX}" >> $SCRIPT_DIR/$ENV_FILE
 

shogun-client/config/gis-client-config.js

@@ -53,5 +53,11 @@ var clientConfig = {
   },
   documentationButtonVisible: true,
   enableFallbackConfig: false,
-  plugins: []
+  plugins: [{
+    name: 'ExamplePlugin',
+    resourcePath: '/client-plugins/index.js',
+    exposedPaths: [
+      './FooterLinks'
+    ]
+  }]
 };

shogun-nginx/dev/default.conf

@@ -114,14 +114,28 @@ server {
     proxy_set_header X-Forwarded-Port $server_port;
   }
 
-   location /client/gis-client-config.js {
+  location /client/gis-client-config.js {
     root /usr/share/nginx/html/;
 
     ssi on;
     ssi_types application/javascript;
     set $keycloakhost ${KEYCLOAK_HOST};
   }
 
+  location /client-plugins/ {
+    proxy_pass http://shogun-client-plugins:8080/;
+
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_set_header X-Forwarded-Port $server_port;
+  }
+
   location / {
     proxy_pass http://shogun-boot:8080/;
 

shogun-nginx/prod/default.conf

@@ -81,10 +81,6 @@ server {
   location /admin/ {
     proxy_pass http://shogun-admin/;
 
-    proxy_http_version 1.1;
-    proxy_set_header Upgrade $http_upgrade;
-    proxy_set_header Connection "upgrade";
-
     proxy_set_header Host $host;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -107,10 +103,6 @@ server {
   location /client/ {
     proxy_pass http://shogun-client/;
 
-    proxy_http_version 1.1;
-    proxy_set_header Upgrade $http_upgrade;
-    proxy_set_header Connection "upgrade";
-
     proxy_set_header Host $host;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -126,6 +118,16 @@ server {
     set $keycloakhost ${KEYCLOAK_HOST};
   }
 
+  # location /client-plugins/ {
+  #   proxy_pass http://shogun-client-plugins/;
+
+  #   proxy_set_header Host $host;
+  #   proxy_set_header X-Real-IP $remote_addr;
+  #   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+  #   proxy_set_header X-Forwarded-Proto $scheme;
+  #   proxy_set_header X-Forwarded-Port $server_port;
+  # }
+
   location / {
     proxy_pass http://shogun-boot;