From 446958d4ebca3ee270faf6dc2b96ed9727c760ad Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Eoche-Duval?= <cel@kereval.com>
Date: Mon, 17 Jul 2023 13:41:24 +0000
Subject: [PATCH] Documentation GUM step 1
---
Dockerfile | 5 +-
EVS-Client/installation.md | 11 ++
EVS-Client/release-note.md | 21 +++-
Gazelle-SSO/installation.md | 102 +++++++++++++--
Gazelle-User-Management/Makefile | 3 +
Gazelle-User-Management/links.md | 10 ++
Makefile | 2 +-
Proxy/installation.md | 101 +++++++++------
Proxy/release-note.md | 11 +-
Proxy/user.md | 101 +++++++++------
Test-Management/installation.md | 118 +++++++++++-------
Test-Management/release-note.md | 28 ++++-
.../jekyll-gazelle-documentation/.gitignore | 2 +
.../jekyll-gazelle-documentation/Gemfile | 26 ++--
.../jekyll-gazelle-documentation/Gemfile.lock | 98 ++++++++++-----
.../jekyll-gazelle-documentation/_config.yml | 11 +-
16 files changed, 465 insertions(+), 185 deletions(-)
create mode 100644 Gazelle-User-Management/Makefile
create mode 100644 Gazelle-User-Management/links.md
mode change 100755 => 100644 _templates/jekyll-gazelle-documentation/Gemfile.lock
diff --git a/Dockerfile b/Dockerfile
index a85cd3d..bbf2971 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,9 +1,10 @@
# use an old version of Ruby
-FROM ruby:2.3.1 as builder
+FROM ruby:2.7.0 as builder
USER root
# non interactive
ARG DEBIAN_FRONTEND=noninteractive
+
# install utilities (gcc, ...)
RUN apt-get update && apt-get install -y \
wget curl sudo build-essential git git-svn \
@@ -15,7 +16,7 @@ WORKDIR /opt/jekyll-gazelle-documentation
# copy only Gemfile/Gemfile.lock
COPY _templates/jekyll-gazelle-documentation/Gemfile* /opt/jekyll-gazelle-documentation/
# install bundler with version specified in Gemfile.lock
-RUN gem install bundler -v 1.17.3
+RUN gem install bundler
# install gem dependencies provided in Gemfile.lock
RUN bundle install --deployment
diff --git a/EVS-Client/installation.md b/EVS-Client/installation.md
index 1741219..7a148a1 100755
--- a/EVS-Client/installation.md
+++ b/EVS-Client/installation.md
@@ -79,6 +79,17 @@ Note: Initial application preferences values _(application_url, cas_enabled, ...
Default values could be found in `/opt/evs/preferences.properties`.</br>
If any of these variables is set, the corresponding preference in `preferences.properties` file will be overridden.
+### Configure SSO registration
+
+Since version **6.3.0**, EVSClient can register itself as a client of a SSO server. This is done by giving some environment variables to the application.
+
+| **Variable name** | **Description** | **Example of value** |
+|----------------------|---------------------------------------------------------------------|-------------------------------------|
+| GZL_EVSCLIENT_K8S_ID | Describes the instance ID and the replica ID of the application. | gazelle-evsclient-6dfeeb5595-tl29k |
+
+[WARNING] There are additional required variables for registration of the proxy to the SSO server. Please refer to the
+[README.md in sso-client-v7](https://gitlab.inria.fr/gazelle/library/sso-client-v7#client-registration).
+
### Data source
Since version **5.11.1**, data sources _(configuration file that indicates how to connect to the
diff --git a/EVS-Client/release-note.md b/EVS-Client/release-note.md
index b556039..fa65b23 100755
--- a/EVS-Client/release-note.md
+++ b/EVS-Client/release-note.md
@@ -1,13 +1,30 @@
---
title: Release note
subtitle: EVS Client
-toolversion: 6.2.2
-releasedate: 2023-04-20
+toolversion: 6.3.0
+releasedate: 2023-07-11
author: Cédric Eoche-Duval
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-EVS_CLIENT
---
+
+## Message-Content-Analyzer 3.1.0
+_Release date: 2023-07-11_
+
+Step 1 of Gazelle User Management renovation.
+
+Integration of new version (2.0.0) of sso-client-v7.
+
+# 6.3.0
+_Release date: 2023-07-11_
+
+Step 1 of Gazelle User Management renovation.
+
+__Task__
+* \[[EVSCLT-1174](https://gazelle.ihe.net/jira/browse/EVSCLT-1174)\] [GUM] Integrate new sso-client-v7 to evs
+
+
# 6.2.3
_Release date: 2023-06-06_
diff --git a/Gazelle-SSO/installation.md b/Gazelle-SSO/installation.md
index b4a2097..0ef006b 100755
--- a/Gazelle-SSO/installation.md
+++ b/Gazelle-SSO/installation.md
@@ -1,28 +1,114 @@
---
title: Installation Manual
subtitle: Gazelle-SSO
-author: Eric Poiseau
+author: Valentin Lorand
function: Engineer
-date: 09/03/2018
+date: 26/06/2023
toolversion: N/A
-version: 1.03
+version: 1.04
status: Approved document
reference: KER1-MAN-IHE-SSO_INSTALLATION-1_03
customer: IHE-EUROPE
---
-# Introduction
+# Gazelle Keycloak CAS 21.0.1 Installation Manual
+
+## Prerequisites
+
+Installation needs to be performed on a Debian linux __Stretch__ or newer. This SSO is used by Gazelle tools to authenticate users.
+A PostgreSQL instance is required to store the data of the SSO.
+Two databases are used by the SSO. One is for keycloak and the other one is the Gazelle TM database used to get the list of users and their group and roles.
+
+# Installation
+
+## 1. Retrieve a keycloak docker image
+
+Browse the following URL to get the correct docker image of Keycloak : https://quay.io/repository/keycloak/keycloak.
+
+Gazelle integration works with version 21.0.X.
+
+Example of commands to download the image :
+
+```bash
+docker pull quay.io/keycloak/keycloak:21.0.1
+```
+
+## 2. Get jar file to provide it to keycloak
+
+Download the file named `gazelle-user-management.jar`from the following URL : https://gazelle.ihe.net/nexus/service/local/repositories/releases/content/net/ihe/gazelle/keycloak-provider
+
+The jar must be placed in the folder `/opt/keycloak/providers/`.
+
+
+## 3. Configure a realm for Gazelle
+
+A JSON configuration file is required to correctly configure the Gazelle realm. This file must declare all the configurationS of the realm.
+
+The list of configuration to set in the file :
+
+- Global configuration (realm name, user auth flow)
+- The list of clients allowed to use the SSO
+- The list of roles
+- The list of protocol mappers
+- The SMTP configuration
+- Brute force protection configuration
+- Event listeners configuration
+- Theme for the login page and emails
+
+An example of this file available in the source code repository of Gazelle User Management [here](https://gitlab.inria.fr/gazelle/applications/gazelle-user-management/-/blob/master/keycloak-provider/realm-gazelle.json).
+
+## 4. Set environment variables
+
+There are variables that must be given to the docker container in order to deploy the application correctly.
+
+| Name | Description | Value Example |
+|---------------------------|--------------------------------------------------|-------------------------------|
+| DB_KC_USER | Postgres database user for Keycloak | gazelle |
+| DB_KC_PASSWORD | Postgres database password for Keycloak | |
+| DB_KC_HOST | Postgres database hostname for Keycloak | localhost |
+| DB_KC_PORT | Postgres database port for Keycloak | 5432 |
+| DB_KC_NAME | Postgres database name for Keycloak | keycloak |
+| DB_TM_USER | Postgres database user for TM | gazelle |
+| DB_TM_PASSWORD | Postgres database password for TM | |
+| DB_TM_HOST | Postgres database hostname for TM | localhost |
+| DB_TM_PORT | Postgres database port for TM | 5432 |
+| DB_TM_NAME | Postgres database name for TM | gazelle |
+| DEBUG | Enable keycloak remote debug mode | false |
+| DEBUG_PORT | Set keycloak debug port | *:18787 |
+| GAZELLE_TM_URL | Gazelle TM instance url | http://localhost:8080/gazelle |
+| KC_ADMIN_CLIENT_SECRET | The secret for the admin-cli client | secret |
+| KC_CLIENTS_ADMIN_EMAIL | The email of the user with manage-client role | Default: indus@kereval.com |
+| KC_CLIENTS_ADMIN_USERNAME | The username of the user with manage-client role | gazelle-clients-admin |
+| KC_CLIENTS_ADMIN_PASSWORD | The password of the user with manage-client role | password |
+| ROOT_TEST_BED_URL | Test bed root url | http://localhost |
+
+There are aditional variables that can be set to configure the keycloak server.
+
+Refer to the [keycloak server configuration documentation](https://www.keycloak.org/server/all-config) for more information.
+## 5. Start keycloak
+
+When all the configurations are ready, you can start keycloak with the image of keycloak you retrieved previously.
+
+Don't forget to mount a volume for /opt/keycloak to provide the different configurations files to keycloak
+
+At the first start, keycloak will create the database and the admin user. It will automatically import the realm configuration file.
+
+Check the logs to follow the progress of the deployment.
+When it's deployed, you can access to the admin console with the admin user and the password you set in the environment variables. You must check the good configuration of the Gazelle realm.
+
+---
+# [DEPRECATED] Apereo CAS 5.1.X Installation Manual
The purpose of this document is to guide you through the installation process of the Apereo CAS 5.1.X. This SSO is used by Gazelle tools to authenticate users.
-# Prerequisites
+## Prerequisites
Installation needs to be performed on a Debian linux __Stretch__ or newer. This is know to not work on jessie.
Apereo needs to be embedded into a Tomcat 8 server. Tomcat 8 runs under Java 8. Make sure you have zulu-8 installed.
-# Installation
+## Installation
-## Install tomcat 8
+### Install tomcat 8
```
apt-get install tomcat8
@@ -63,7 +149,7 @@ Probably you want to use AJP connector. You need to uncomment this line and cust
Also add `secretRequired="false"` in the AJP configuration.
-## Download and deploy Gazelle SSO
+### Download and deploy Gazelle SSO
```
cd /var/lib/tomcat8/webapps
diff --git a/Gazelle-User-Management/Makefile b/Gazelle-User-Management/Makefile
new file mode 100644
index 0000000..aae7529
--- /dev/null
+++ b/Gazelle-User-Management/Makefile
@@ -0,0 +1,3 @@
+SHELL := /bin/bash
+
+include ../Makefile.generic
\ No newline at end of file
diff --git a/Gazelle-User-Management/links.md b/Gazelle-User-Management/links.md
new file mode 100644
index 0000000..78945bc
--- /dev/null
+++ b/Gazelle-User-Management/links.md
@@ -0,0 +1,10 @@
+---
+title: Documentation
+subtitle: Gazelle User Management
+toolversion: 1.0.0
+releasedate: 2023-07-17
+author:
+---
+
+Gazelle User Management documentation is located
+on [https://doc-ihe.kereval.cloud/gazelle-applications/v/gazelle-user-management/](https://doc-ihe.kereval.cloud/gazelle-applications/v/gazelle-user-management/).
diff --git a/Makefile b/Makefile
index 7fcba3d..75bf54d 100755
--- a/Makefile
+++ b/Makefile
@@ -38,7 +38,7 @@ init_jekyll_folder:
cd $(OUTPUT_FOLDER)/jekyll-gazelle-documentation/ && bundle
setup:
- sudo apt-get install make git git-svn texlive-xetex pandoc ruby-dev
+ sudo apt-get install git git-svn texlive-xetex pandoc ruby-dev
sudo gem install bundler
# copy markdown sources to jekyll foler
diff --git a/Proxy/installation.md b/Proxy/installation.md
index bd0231d..8efeead 100755
--- a/Proxy/installation.md
+++ b/Proxy/installation.md
@@ -3,7 +3,7 @@ title: Installation Manual
subtitle: Gazelle Proxy
author: Nicolas BAILLIET
date: 17/07/2023
-toolversion: 5.0.8
+toolversion: 5.1.0
function: Engineer
version: 2.01
status: Approved document
@@ -13,10 +13,13 @@ customer: IHE-EUROPE
# Introduction
-Proxy is the part of the Gazelle testbed which is used to capture the messages exchanged between two systems under test. This tool is also bind to the EVSClient in order to validate the messages stored in the Proxy in a very simple way.
+Proxy is the part of the Gazelle testbed which is used to capture the messages exchanged between two systems under test.
+This tool is also bind to the EVSClient in order to validate the messages stored in the Proxy in a very simple way.
-As for the other tools, the proxy is an open source project and its sources are available at [*https://gitlab.inria.fr/gazelle/applications/test-execution/gazelle-proxy.git*](https://gitlab.inria.fr/gazelle/applications/test-execution/gazelle-proxy.git).
-You can download the latest gazelle-proxy.ear in nexus [*http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear*](http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear)
+As for the other tools, the proxy is an open source project and its sources are available at
+[*https://gitlab.inria.fr/gazelle/applications/test-execution/gazelle-proxy.git*](https://gitlab.inria.fr/gazelle/applications/test-execution/gazelle-proxy.git).
+You can download the latest gazelle-proxy.ear in nexus
+[*http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear*](http://gazelle.ihe.net/nexus/index.html#nexus-search;quick~gazelle-proxy.ear)
# Compilation and installation
@@ -30,13 +33,14 @@ You will get an EAR in the gazelle-proxy-ear/target folder.
Then, follow the instructions below:
-1. In your database (postgresql 9.1 or higher) create a database named "gazelle-proxy", using UTF-8 encoding and owned by the user gazelle
+## 1. Create database
+In your database (postgresql 9.1 or higher) create a database named "gazelle-proxy", using UTF-8 encoding and owned by the user gazelle
```bash
createdb -U gazelle -E UTF8 gazelle-proxy
```
-2. On your file system, create a directory `/opt/proxy/DICOM` and an empty file `/opt/proxy/proxyPersistentChannels.csv`
+## 2. On your file system, create a directory `/opt/proxy/DICOM` and an empty file `/opt/proxy/proxyPersistentChannels.csv`
```bash
sudo mkdir -p /opt/proxy/DICOM
@@ -45,44 +49,61 @@ sudo chown -R jboss:jboss-admin /opt/proxy
sudo chmod -R 775 /opt/proxy
```
-3. Put the ear in the deploy folder of your Jboss AS
+## 3. Put the ear in the deploy folder of your Jboss AS
```bash
cp gazelle-proxy-ear/target/gazelle-proxy.ear /usr/local/jboss7/standalone/deployments/gazelle-proxy.ear
```
-4. **WARNING** : From version 4.7.0, datasources have been extracted from the **ear**. The template file can be found in /src/main/application/datasource in the source or in the file gazelle-proxy-X.X.X-datasource.zip from the nexus.
-For more informations about how to manage that externalization, please refer to [general considerations for JBoss7](https://gazelle.ihe.net/gazelle-documentation/General/jboss7.html).
+## 4. Manage datasource
+
+[WARNING] : From version 4.7.0, datasources have been extracted from the **ear**. The template file can be found in
+/src/main/application/datasource in the source or in the file gazelle-proxy-X.X.X-datasource.zip from the nexus.
+For more information about how to manage that externalization, please refer to
+[general considerations for JBoss7](https://gazelle.ihe.net/gazelle-documentation/General/jboss7.html).
* Datasource name : gazelle-proxyDS
* Database name : gazelle-proxy
-5. Start Jboss AS 7
+## 5. Configure SSO registration
+
+Since version **5.1.0**, Proxy can register itself as a client of a SSO server. This is done by giving some environment variables to the application.
+
+| **Variable name** | **Description** | **Example of value** |
+|-------------------|------------------------------------------------------------------|--------------------------------|
+| GZL_PROXY_K8S_ID | Describes the instance ID and the replica ID of the application. | gazelle-proxy-6dfeeb5595-tl29k |
+
+[WARNING] There are additional required variables for registration of the proxy to the SSO server. Please refer to the
+[README.md in sso-client-v7](https://gitlab.inria.fr/gazelle/library/sso-client-v7#client-registration).
+
+## 6. Start Jboss AS 7
```bash
sudo /etc/init.d/jboss7 start
```
-6. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/schema-5.0.0.sql
+## 7. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/schema-X.X.X.sql
```bash
-psql -U gazelle gazelle-proxy < schema-5.0.0.sql
+psql -U gazelle gazelle-proxy < schema-X.X.X.sql
```
-
-7. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/init-5.0.0.sql
+## 8. Execute the sql script available in your workspace at gazelle-proxy-ear/src/main/sql/init-5.0.0.sql
```bash
-psql -U gazelle gazelle-proxy < init-5.0.0.sql
+psql -U gazelle gazelle-proxy < init-X.X.X.sql
```
-8. Open your favorite browser (we recommand Chrome or Firefox) and go to [*http://yourServer:8080/proxy*](http://yourServer:8080/proxy)
+## 9. Browse the application
+
+Open your favorite browser (we recommend Chrome or Firefox) and go to [*http://yourServer:8080/proxy*](http://yourServer:8080/proxy)
-9. The proxy is now up and running, see the next section for information on the configuration.
+## 10. The proxy is now up and running, see the next section for information on the configuration.
This new instance of the proxy is running without the CAS feature, that means that anyone accessing the tool has the administrator privileges.
-If you rather want to use a single-sign one authentication, configure the application in this way. Edit the preference **application\_works\_without\_cas** to set it to **false.**
+If you rather want to use a single-sign one authentication, configure the application in this way. Edit the preference
+**application\_works\_without\_cas** to set it to **false.**
## Called tools
@@ -96,25 +117,25 @@ sudo apt get install dcmtk
There is a set of properties that you can configure on the Configuration page, the table below describes the various properties defined and their default values.
-| **Property name** | **Description** | **Default value** |
-|-------------------------------------------|-----------------------------------------|--------------------|
-| **application\_documentation** | The link to the user manual. Link to this page |
-| **application\_issue\_tracker** | The link to the section of the issue tracker where to report issues about the Gazelle Proxy tool | [https://gazelle.ihe.net/jra/browse/PROXY](https://gazelle.ihe.net/jra/browse/PROXY) |
-| **application\_release\_notes** | The link to the application release notes of the tool | [https://gazelle.ihe.net/jira](https://gazelle.ihe.net/jira) |
-| **application\_works\_without\_cas** | Specifies if the CAS should be used or not, if no CAS is used, property shall be set to true otherwise, it's set to false | true |
-| **application\_url** | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | [http://yourASURL/proxy](http://yourASURL/proxy) |
-| **cas\_enable** | If you intent to use a CAS, set it tu true here | true |
-| **dcmdump_path** | Path to dcmdump | /usr/bin/dcmdump |
-| **evs\_client\_url** | The URL of the EVSClient application. This is required to validate the messages captured by the proxy. If you install your own instance of the proxy, you also need your own instance of the EVSClient tool. (Do not forget the tailing slash) | [https://gazelle.ihe.net/EVSClient/](https://gazelle.ihe.net/EVSClient/) |
-| **ip\_login** | if the application is not linked to a CAS, you can choose to restraint the access to the administration sections of the application to a subset of IP addresses | false |
-| **ip\_login\_admin** | regex to be matched by IP address of the users granted as admin | .\* |
-| **jms_communication_is_enabled** | Enable jms communication | false |
-| **max\_proxy\_port** | Specifies the high limit for the opened ports | 11000 |
-| **min\_proxy\_port** | Specifies the low limit for the opened ports | 10000 |
-| **NUMBER_OF_ITEMS_PER_PAGE** | Number of items to diplay in datatable | 20 |
-| **proxy\_ip\_addresses** | This property is used to inform the users of the IP address(es) to use to contact the proxy | 131.254.209.16 (kujira.irisa.fr), 131.254.209.17 (kujira1.irisa.fr), 131.254.209.18 (kujira2.irisa.fr), 131.254.209.19 (kujira3.irisa.fr) |
-| **proxy\_oid** | For each tool, we need an OID which uniquely identify the instance of the tool and the URL used to send back results. | 1.1.1.1.1 |
-| **storage\_dicom** | Absolute path to the system folder used to store the DICOM datasets | /opt/proxy/DICOM |
-| **time\_zone** | The time zone used to display the timestamps | Europe/Paris |
-| **admin_only_mode** | This preference is used to enable/disable the Admin Only mode. This mode restricts the access to messages list and messages details to admin only. Connection can however be shared by an administrator to allow users knowing the connection privacy key to see messages from the connection. | false
-| **proxy_persistent_channels_file_path** | This file path where persitent channels are written. The file must be created by server admin | /opt/proxy/proxyPersistentChannels.csv
+| **Property name** | **Description** | **Default value** |
+|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| **application\_documentation** | The link to the user manual. Link to this page | |
+| **application\_issue\_tracker** | The link to the section of the issue tracker where to report issues about the Gazelle Proxy tool | [https://gazelle.ihe.net/jra/browse/PROXY](https://gazelle.ihe.net/jra/browse/PROXY) |
+| **application\_release\_notes** | The link to the application release notes of the tool | [https://gazelle.ihe.net/jira](https://gazelle.ihe.net/jira) |
+| **application\_works\_without\_cas** | Specifies if the CAS should be used or not, if no CAS is used, property shall be set to true otherwise, it's set to false | true |
+| **application\_url** | The URL used by any user to access the tool. The application needs it to build permanent links inside the tool | [http://yourASURL/proxy](http://yourASURL/proxy) |
+| **cas\_enable** | If you intent to use a CAS, set it tu true here | true |
+| **dcmdump_path** | Path to dcmdump | /usr/bin/dcmdump |
+| **evs\_client\_url** | The URL of the EVSClient application. This is required to validate the messages captured by the proxy. If you install your own instance of the proxy, you also need your own instance of the EVSClient tool. (Do not forget the tailing slash) | [https://gazelle.ihe.net/EVSClient/](https://gazelle.ihe.net/EVSClient/) |
+| **ip\_login** | if the application is not linked to a CAS, you can choose to restraint the access to the administration sections of the application to a subset of IP addresses | false |
+| **ip\_login\_admin** | regex to be matched by IP address of the users granted as admin | .\* |
+| **jms_communication_is_enabled** | Enable jms communication | false |
+| **max\_proxy\_port** | Specifies the high limit for the opened ports | 11000 |
+| **min\_proxy\_port** | Specifies the low limit for the opened ports | 10000 |
+| **NUMBER_OF_ITEMS_PER_PAGE** | Number of items to display in datatable | 20 |
+| **proxy\_ip\_addresses** | This property is used to inform the users of the IP address(es) to use to contact the proxy | 131.254.209.16 (kujira.irisa.fr), 131.254.209.17 (kujira1.irisa.fr), 131.254.209.18 (kujira2.irisa.fr), 131.254.209.19 (kujira3.irisa.fr) |
+| **proxy\_oid** | For each tool, we need an OID which uniquely identify the instance of the tool and the URL used to send back results. | 1.1.1.1.1 |
+| **storage\_dicom** | Absolute path to the system folder used to store the DICOM datasets | /opt/proxy/DICOM |
+| **time\_zone** | The time zone used to display the timestamps | Europe/Paris |
+| **admin_only_mode** | This preference is used to enable/disable the Admin Only mode. This mode restricts the access to messages list and messages details to admin only. Connection can however be shared by an administrator to allow users knowing the connection privacy key to see messages from the connection. | false |
+| **proxy_persistent_channels_file_path** | This file path where persistent channels are written. The file must be created by server admin | /opt/proxy/proxyPersistentChannels.csv |
\ No newline at end of file
diff --git a/Proxy/release-note.md b/Proxy/release-note.md
index 7afedae..1c676fd 100755
--- a/Proxy/release-note.md
+++ b/Proxy/release-note.md
@@ -1,13 +1,20 @@
---
title: Release note
subtitle: Proxy
-toolversion: 5.0.8
-releasedate: 2023-06-09
+toolversion: 5.1.0
+releasedate: 2023-07-11
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-Proxy
---
+# 5.1.0
+_Release date: 2023-07-11_
+
+Step 1 of Gazelle User Management renovation.
+
+__Task__
+* \[[PROXY-268](https://gazelle.ihe.net/jira/browse/PROXY-268)\] [GUM] Cas-client-v7 update integration
# 5.0.8
_Release date: 2023-06-09_
diff --git a/Proxy/user.md b/Proxy/user.md
index 77676c6..91c1753 100755
--- a/Proxy/user.md
+++ b/Proxy/user.md
@@ -2,8 +2,8 @@
title: User Manual
subtitle: Gazelle Proxy
author: Nicolas BAILLIET
-date: 09/06/2023
-toolversion: 5.0.8
+date: 12/07/2023
+toolversion: 5.1.0
function: Engineer
version: 2.01
status: Approved document
@@ -13,7 +13,8 @@ customer: IHE-EUROPE
# Project Overview
-The proxy is used to capture TCP/IP packets exchanged by test participants using secured or not secured channel. The packed flow is analyzed and stored in a database for further analysis by protocol specific analysers.
+The proxy is used to capture TCP/IP packets exchanged by test participants using secured or not secured channel.
+The packed flow is analyzed and stored in a database for further analysis by protocol specific analysers.
The packet analysers available are :
@@ -23,13 +24,16 @@ The packet analysers available are :
* Syslog
* Raw
-Each message is saved with the network details, including an id of the socket (named channel id) used for that message as a socket can transport many messages (HTTP, DICOM).Â
+Each message is saved with the network details, including an id of the socket (named channel id) used for that message
+as a socket can transport many messages (HTTP, DICOM).
-**The proxy is set up on ovh1.ihe-europe.net, and accessed with [*the web interface*](https://gazelle.ihe.net/proxy). ovh1.ihe-europe.net has a limited range of port numbers available from the Internet. Ports from 10200 to 11000 must be used for channel creation.**Â
+**The proxy is set up on ovh1.ihe-europe.net, and accessed with [*the web interface*](https://gazelle.ihe.net/proxy).
+ovh1.ihe-europe.net has a limited range of port numbers available from the Internet. Ports from 10200 to 11000 must be used for channel creation.**
## Usage
-The web interface allows to create channels. A channel opens a port on the server hosting the proxy and redirecting all traffic to a configured server on a specific port.
+The web interface allows to create channels. A channel opens a port on the server hosting the proxy and redirecting all
+traffic to a configured server on a specific port.
Data stream is not modified, but analyzed using the chosen packet analyser.
@@ -53,15 +57,19 @@ For HTTP(S) messages, matching request/response is displayed in parenthesis.
The proxy is integrated with Gazelle using web standards.
-It publishes a web service allowing Gazelle to send test instance steps and configurations. Also, when a step is done, Gazelle calls the web service.
+It publishes a web service allowing Gazelle to send test instance steps and configurations. Also, when a step is done,
+Gazelle calls the web service.
-The proxy then opens the needed channels and listen on specified ports (provided in the system configurations). It also records the test instance chronology for further searches.
+The proxy then opens the needed channels and listen on specified ports (provided in the system configurations). It also
+records the test instance chronology for further searches.
-In Gazelle, if the test instance has proxy enabled, a link is available on each step. This link opens the proxy with the Gazelle step technical id as a parameter. The proxy then builds a filter to get messages matching the step and displays the matching messages.
+In Gazelle, if the test instance has proxy enabled, a link is available on each step. This link opens the proxy with the
+Gazelle step technical id as a parameter. The proxy then builds a filter to get messages matching the step and displays the matching messages.
## Introduction
-Gazelle TestManagement tools can be used in conjunction with a proxy for the capture of the messages exchanged between a test participants.
+Gazelle TestManagement tools can be used in conjunction with a proxy for the capture of the messages exchanged between a
+test participants.
The proxy is able to capture :
@@ -72,27 +80,28 @@ The proxy is able to capture :
The advantages of using the proxy when running a test are the followings :
-the Proxy is a neutral way to capture the exchanged messages.
-
-the Proxy displays the captured messages in a unified way for all the tests performed, simplifying the work of the monitors when examining the logs
-
-the Proxy provides permanent link to the captured messages that can be linked to test instance steps and avoid the cut and paste of logs in the chat window of the test instance. It then helps linking the logs to the test and enables all the participants to the test to see the entire set of messages exchanges between the test participants.
-
-the Proxy helps verifying the captured messages through a direct link to the EVS Client GUI.
+* the Proxy is a neutral way to capture the exchanged messages.
+* the Proxy displays the captured messages in a unified way for all the tests performed, simplifying the work of the
+monitors when examining the logs
+* the Proxy provides permanent link to the captured messages that can be linked to test instance steps and avoid the cut
+and paste of logs in the chat window of the test instance. It then helps linking the logs to the test and enables all the participants to the test to see the entire set of messages exchanges between the test participants.
+* the Proxy helps to verify the captured messages through a direct link to the EVS Client GUI.
## Limitations
-Proxy acts as a network relay between two SUTs. As a result, system configuration has to be modified. The TCP connection must be established on the proxy on the system configuration's proxy port instead of opening a connection to the responder SUT directly.
+Proxy acts as a network relay between two SUTs. As a result, system configuration has to be modified. The TCP connection
+must be established on the proxy on the system configuration's proxy port instead of opening a connection to the responder SUT directly.
## How does it work ?
-For each system in Gazelle TestManagement tool there is a set of configuration parameters. For each port that an SUT needs to open, there is a mirror port number on the proxy.Â
+For each system in Gazelle TestManagement tool there is a set of configuration parameters. For each port that an SUT needs
+to open, there is a mirror port number on the proxy.
All proxy ports must be opened by a Gazelle admin, each system configuration being mapped to a proxy port.
-The proxy GUI can be access at the following URL :Â [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy)
+The proxy GUI can be access at the following URL : [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy)
## Start a new channel
@@ -100,7 +109,8 @@ To start a new channel, you have to be connected as an administrator.
-The form displayed should be completed with message type, proxy's port, responder's IP or hostname and responder's port. The channel can be secure or not secure by activating the lock icon.
+The form displayed should be completed with message type, proxy's port, responder's IP or hostname and responder's port.
+The channel can be secure or not secure by activating the lock icon.
@@ -108,7 +118,8 @@ Then, one the channel is started, it can be visible in the channel list page
-For secured configuration details, you can go to Administration/Secured Channel Configuration (admin only) or click on the lock icon to be redirected in read only mode (any user)
+For secured configuration details, you can go to Administration/Secured Channel Configuration (admin only) or click on
+the lock icon to be redirected in read only mode (any user)
@@ -121,22 +132,27 @@ Proxy and Gazelle know each other, and each test step in Gazelle has a proxy lin
-This link displays the list of the messages matching the test step configuration. It also filters the messages by time, showing only messages sent after the last test step marked as verified (or test instance started) and this test step marked as to be verified.
+This link displays the list of the messages matching the test step configuration. It also filters the messages by time,
+showing only messages sent after the last test step marked as verified (or test instance started) and this test step marked as to be verified.
## Finding captured messages manually
-By accessing proxy directly using [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy), messages can be filtered on different criterias. By clicking a value in the table, it either opens the message details for id column, or set the filter for other columns.
+By accessing proxy directly using [*https://gazelle.ihe.net/proxy*](https://gazelle.ihe.net/proxy), messages can be
+filtered on different criterias. By clicking a value in the table, it either opens the message details for id column,
+or set the filter for other columns.
The messages list displays only one type of message, if HTTP is selected, HL7v2 messages are not shown.
-Each captured message has a permanent link that can be used in Gazelle. The best way to use it is to add this link to a test step instance. The monitor will be then able to validate the message using EVSClient.
+Each captured message has a permanent link that can be used in Gazelle. The best way to use it is to add this link to a
+test step instance. The monitor will be then able to validate the message using EVSClient.
## Persist a channel
-For version >5.0.8, gazelle-proxy can now have a persist feature that allowed user to persist created channel into csv file present in server.
+For version >5.0.8, gazelle-proxy can now have a persist feature that allowed user to persist created channel into csv
+file present in server.
To perform this feature it needs 2 steps :
1. create a file named `proxyPersistentChannels.csv` into `/opt/proxy/proxyPersistentChannels.csv` and make it accessible by jboss user
@@ -149,9 +165,9 @@ To perform this feature it needs 2 steps :
2. Add property into Administration > Configuration
- |Preference name|Value|
- | :---: | :---: |
- |proxy_persistent_channels_file_path|/opt/proxy/proxyPersistentChannels.csv|
+ | Preference name | Value |
+ |:-----------------------------------:|:--------------------------------------:|
+ | proxy_persistent_channels_file_path | /opt/proxy/proxyPersistentChannels.csv |
Once done you can know persist your channel during creation of new channel by ticking the case `Make the channel persistent?`
@@ -176,26 +192,30 @@ The fields are in this strict order:
# WebService API
-* *startAllChannels* : It takes "List<Configuration> configurations" in argument. It start a new channel in proxy for each configuration set.
+* *startAllChannels* : It takes "List<Configuration> configurations" in argument. It starts a new channel in proxy for each configuration set.
-* *startTestInstance* : It takes "TestInstance testInstance" in argument. It start a new channel in proxy for a test instance.
+* *startTestInstance* : It takes "TestInstance testInstance" in argument. It starts a new channel in proxy for a test instance.
-* *markTestStep* : It takes "int testStepId" in argument. It set the date of a test step with the current.
+* *markTestStep* : It takes "int testStepId" in argument. It set the date of a test step with the current.
-* *getMinProxyPort* :Â It return the min\_proxy\_port define in proxy configuration.
+* *getMinProxyPort* : It returns the min\_proxy\_port define in proxy configuration.
-* *getMaxProxyPort* :Â It return the max\_proxy\_port define in proxy configuration.
+* *getMaxProxyPort* : It returns the max\_proxy\_port define in proxy configuration.
# Admin Only Mode
The proxy can be configured to use the "Admin only" mode. This mode restrict the access to the message list and details to administrators only.
-Not logged in users or logged in users without admin rights will not be able to see any message if this mode is activated. Any captured message will have a private access in this mode by default. Id the message is captured wiht this mode disabled, when switching the mode on, the message will still be private by default.
-An admin user can however Share connection. This basically means that a privacy key is associated to the connection and that any user with any rights knowing this privacy key will be able to access messages from this connection.
+Not logged in users or logged in users without admin rights will not be able to see any message if this mode is activated.
+Any captured message will have a private access in this mode by default. Id the message is captured with this mode disabled,
+when switching the mode on, the message will still be private by default.
+An admin user can however Share connection. This basically means that a privacy key is associated to the connection and
+that any user with any rights knowing this privacy key will be able to access messages from this connection.
When this mode is enabled, the Message List is not accessible in the menu for not admin users :
-When an Admin user access the message list with this mode enabled, he can see which message is shared and which message is private. He can also filter messages based on this criterion.
+When an Admin user access the message list with this mode enabled, he can see which message is shared and which message
+is private. He can also filter messages based on this criterion.
@@ -204,8 +224,11 @@ Finally when on a message detail page, the admin user can shared the associated
-The current privacy state of the connection can be found as an icon on the top right corner of the Message details panel. For instance, the connection associated to the message in the following picture is private.
+The current privacy state of the connection can be found as an icon on the top right corner of the Message details panel.
+For instance, the connection associated to the message in the following picture is private.
-At any moment this mode can be enabled or disabled. Between two activations, connection will keep the same privacy status (shared or private). When the mode is diasbled, all connection and all messages can be accessed by all users again. The fact that they are private in Admin only mode has no impact when the mode is disabled.
+At any moment this mode can be enabled or disabled. Between two activations, connection will keep the same privacy status
+(shared or private). When the mode is disabled, all connection and all messages can be accessed by all users again.
+The fact that they are private in Admin only mode has no impact when the mode is disabled.
diff --git a/Test-Management/installation.md b/Test-Management/installation.md
index 9ec6040..a4d1053 100755
--- a/Test-Management/installation.md
+++ b/Test-Management/installation.md
@@ -15,25 +15,41 @@ customer: IHE-EUROPE
# Purpose
-Thanks for having chosen Gazelle !
+Thanks for having chosen Gazelle ! Test Management is an open-source project under Apache2 licence.
Here is a guide to help you with installing Test Management.
# Pre-requisites
-Gazelle Test Management runs under Jboss AS 7.2.0 with a postgresql PostGresql 9.1 or higher database. For general considerations regarding the installation of the
+Gazelle Test Management runs under Jboss AS 7.2.0 with a PostgreSQL 9.6 or higher database. For general considerations regarding the installation of the
application server, read [Jboss7 installation guide](../General/jboss7.html).
-# Sources
+# Binary
+
+You can either fetch the public EAR (released version) in our [Nexus repository](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~gazelle-tm-ear*~~~) or compile the tool by your own.
-Test Management is an open source project under Apache2 licence. The sources are available on the INRIA's Gitlab:
+## Build from sources
+
+The sources are available on the INRIA's Gitlab:
```bash
git clone https://gitlab.inria.fr/gazelle/applications/mixed/gazelle-tm.git
```
-# Database creation and initialization
+It requires jdk8 and maven to build, but jdk7 to run.
+
+```bash
+cd gazelle-tm
+mvn clean install
+```
+
+The archive (EAR) and the distribution file are created and placed into gazelle-tm/gazelle-tm-ear/target directory.
+
+# Database setup
+
+## Database creation
+
+You can choose whatever database name you want, you will need to report it in the datasource section of the Jboss configuration.
-You can choose whatever database name you want. You will need to report it in the datasource section of the Jboss configuration.
```bash
su postgresql
psql
@@ -44,6 +60,12 @@ postgres=# \q
exit
```
+## Database initialization for TM version 7.0.0 and newer
+
+Database initialization is automatically handled by the EAR itself.
+
+## Database initialization for TM version prior to 7.0.0
+
Download the files containing all the data required by the application to properly work (schema-X.X.X.sql and init-X.X.X.sql, X.X.X being the latest version available) on Nexus in the sql.zip file : [Nexus repository](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~gazelle-tm-ear*~~~) and import it into the newly created database as shown below.
```bash
@@ -59,23 +81,41 @@ Gazelle Test Management need the package graphviz to display graph (Display rela
sudo apt install graphviz
```
+# Single Sign On
-# Binary
+With the release 5.15.0, Gazelle Test Management needs a file to interact with the SSO application.
+This application read the configuration of the SSO in a file located in `/opt/gazelle/cas`. You need
+to create this folder and the configuration file `gazelle-tm.properties`.
-You can either fetch the public EAR (released version) in our [Nexus repository](https://gazelle.ihe.net/nexus/index.html#nexus-search;gav~~gazelle-tm-ear*~~~) or compile the tool by your own.
+```
+ mkdir /opt/gazelle/cas
+ touch /opt/gazelle/cas/gazelle-tm.properties
+ chown -R jboss:jboss-admin /opt/gazelle/cas
+ chmod -R g+w /opt/gazelle/cas
+```
+The file **gazelle-tm.properties** shall be created and save in **/opt/gazelle/cas**.
-Before compiling, go to the directory gazelle-tm and edit the file pom.xml. Open this file and adapt the properties of profile prod to your case:
+### SSO properties with gazelle-user-management and Keycloak SSO (Test-Management version 7.0.0 and newer)
-* basename : root of application. Ex : gazelle → http://server/gazelle
-* jdbc.connection.url : replace the last segment with your database name
-* jdbc.connection.user /Â jdbc.connection.password : credentials for database access
-* Then, create the EAR archive with the command line:
+Integrated with Keycloak's Gazelle, the file `gazelle-tm.properties` must contain:
-```bash
-cd gazelle-tm; mvn clean package -Pprod,distribution
+```properties
+casServerUrlPrefix=https://yourUrl.com/auth/realms/gazelle/protocol/cas
+casServerLoginUrl=https://yourUrl.com/auth/realms/gazelle/protocol/cas/login
+casLogoutUrl=https://yourUrl.com/auth/realms/gazelle/protocol/cas/logout
+service = https://yourUrl.com/gazelle
```
-The archive (EAR) and the distribution file are created and placed into gazelle-tm/gazelle-tm-ear/target directory.
+### SSO properties with Apereo CAS (Test-Management version prior to 7.0.0)
+
+Integrated with Apereo-CAS' Gazelle, the file `gazelle-tm.properties` must contain:
+
+```properties
+casServerUrlPrefix = https://yourUrl.com/sso
+casServerLoginUrl = https://yourUrl.com/sso/login
+casLogoutUrl = https://yourUrl.com/sso/logout
+service = https://yourUrl.com/gazelle
+```
# Deployment
@@ -103,35 +143,18 @@ Once you have copied the content of this file in your Jboss configuration:
You can retrieve those values in [gazelle-tm's pom.xml file](https://gazelle.ihe.net/jenkins/view/Test%20Management/job/gazelle-tm-public/ws/pom.xml) for each profile.
-
Since version 5.11.0, you need to configure the mail session that is needed by the tool in the jboss configuration file `standalone.xml`. Read details in the "Externalize mail server configuration" section of [JBoss 7 installation page](../General/jboss7.html) for further information.
+Copy the gazelle-tm.ear into the " standalone/deployments" directory of your JBoss 7 server. Finally, start your server. When the application is deployed, open a browser and go to **http://yourserver/gazelle**. If the deployment and the database initialization are successful you should see the home page.
-Copy the gazelle-tm.ear into the " standalone\\deployments" directory of your JBoss 7 server. Finally, start your server. When the application is deployed, open a browser and go to **http://yourserver/gazelle**. If the deployment and the database initialization are successful you should see the home page.
-
-# Configuration
-
-## SSO
-
-With the release 5.15.0, Gazelle Test Management needs a file to interact with the SSO application.
-This application read the configuration of the SSO in a file located in `/opt/gazelle/cas`. We need to create this folder and the configuration file `gazelle-tm.properties`.
-
-```
- mkdir /opt/gazelle/cas
- touch /opt/gazelle/cas/gazelle-tm.properties
- chown -R jboss:jboss-admin /opt/gazelle/cas
- chmod -R g+w /opt/gazelle/cas
-```
-The file **gazelle-tm.properties** has shall be created and save in **/opt/gazelle/cas**.
-
-The file shall contain the following statements :
-- casServerUrlPrefix = https://yourUrl.com/sso
-- casServerLoginUrl = https://yourUrl.com/sso/login
-- casLogoutUrl = https://yourUrl.com/sso/logout
-- service = https://yourUrl.com/gazelle
-
+# First start
-This instance of Test Management you have just deployed is free of organization, user and testing session. Consequently, the next step will be to create your organization, your account (as an administrator of the application) and the testing session. A testing session is used to hold one event, for example a Connectathon, a showcase or whatever requiring the use of Test Management. If the first part of the installation is successful, you should see the Gazelle home page (see file entitled Home page before installation).
+This instance of Test Management you have just deployed is free of organization, user and testing
+session. Consequently, the next step will be to create your organization, your account (as an
+administrator of the application) and the testing session. A testing session is used to hold one
+event, for example a Connectathon, a showcase or whatever requiring the use of Test Management. If
+the first part of the installation is successful, you should see the Gazelle home page (see file
+entitled Home page before installation).
@@ -157,20 +180,19 @@ You will be redirect to the Home page, if everythink worked fine during the conf
-# Customize the New Home page UI
+# Customize the Home page UI
+
+## Version 6.3.0 and newer
### General
-The new home page support multiple sections, each section contains HTML content, and pre-defined css classes.
+The home page support multiple sections, each section contains HTML content, and pre-defined css classes.
-For the current version **(6.3.0)**, the application doesn't provide a graphical interface to manage these sections,
+For the current version, since **(6.3.0)**, the application doesn't provide a graphical interface to manage these sections,
therefore, an administrator should insert manually his HTML content in the table "tm_sections".
### Default behavior
-The update script **update-6.3.0.sql** (**init-6-3-X.sql** as wel) contains a default HTML content that match predefined styles for the **IHE Connectathon 2022**.
-An administrator could change the column **content** in the tm_section database with his custom HTML.
-
By default, two sections (Documentation and Announcement) are displayed only in the home page, the other two sections
(Tool index and Credits) are visible through all the application pages.
@@ -180,7 +202,7 @@ By default, two sections (Documentation and Announcement) are displayed only in
-# Customize the Home page (old version < 6.3.0)
+## Version priors to 6.3.0
The home page is built of two blocks the administrators can customize when they are logged in.
diff --git a/Test-Management/release-note.md b/Test-Management/release-note.md
index 2416688..022e1de 100755
--- a/Test-Management/release-note.md
+++ b/Test-Management/release-note.md
@@ -2,19 +2,43 @@
title: Release note
subtitle: Test Management
toolversion: 6.10.4
-releasedate: 2023-06-23
+releasedate: 2023-07-12
author: Anne-Gaëlle BERGE
function: Software Engineer
customer: IHE Europe
reference: KER1-RNO-IHE-TEST_MANAGEMENT
---
+
+# 7.0.0
+_Release date: 2023-07-12_
+
+Step 1 of Gazelle User Management renovation.
+
+__Bug__
+* \[[GZL-5210](https://gazelle.ihe.net/jira/browse/GZL-5210)\] [GUM] Problem of httpclient dependency versions
+* \[[GZL-5221](https://gazelle.ihe.net/jira/browse/GZL-5221)\] Activation email to vendor-admin has out-dated instructions.
+* \[[GZL-5224](https://gazelle.ihe.net/jira/browse/GZL-5224)\] "Delete user" button should be "Deactivate user"
+* \[[GZL-5228](https://gazelle.ihe.net/jira/browse/GZL-5228)\] Email client application may activate user without admin consent.
+* \[[GZL-5230](https://gazelle.ihe.net/jira/browse/GZL-5230)\] Proxy message link is not displayed in test instance
+* \[[GZL-5231](https://gazelle.ihe.net/jira/browse/GZL-5231)\] Monitor cannot access notes of a system
+* \[[GZL-5244](https://gazelle.ihe.net/jira/browse/GZL-5244)\] Home page show error when there is no preparatory tests during preparation phase
+
+__Task__
+* \[[GZL-5190](https://gazelle.ihe.net/jira/browse/GZL-5190)\] [GUM] Setup Flyway for TM DB
+* \[[GZL-5191](https://gazelle.ihe.net/jira/browse/GZL-5191)\] [GUM] Remove native authentication
+* \[[GZL-5199](https://gazelle.ihe.net/jira/browse/GZL-5199)\] [GUM] Remove reset password from TM
+* \[[GZL-5200](https://gazelle.ihe.net/jira/browse/GZL-5200)\] [GUM] Only uses Identity to access user attributes
+* \[[GZL-5201](https://gazelle.ihe.net/jira/browse/GZL-5201)\] [GUM] Remove block account possibility in TM
+* \[[GZL-5209](https://gazelle.ihe.net/jira/browse/GZL-5209)\] [GUM] Remove log as feature from TM
+
+See also [GUM release note](../Gazelle-User-Management/release-note.html).
+
# 6.10.4
_Release date: 2023-06-23_
__Bug__
* \[[GZL-5212](https://gazelle.ihe.net/jira/browse/GZL-5212)\] Inconsistant Prepatory Test Status from the View of Admin
* \[[GZL-5217](https://gazelle.ihe.net/jira/browse/GZL-5217)\] DIGIT_Unable to edit Monitor test assignment
-
# 6.10.3
_Release date: 2023-06-01_
__Sub-task__
diff --git a/_templates/jekyll-gazelle-documentation/.gitignore b/_templates/jekyll-gazelle-documentation/.gitignore
index 45c1505..8092feb 100755
--- a/_templates/jekyll-gazelle-documentation/.gitignore
+++ b/_templates/jekyll-gazelle-documentation/.gitignore
@@ -1,3 +1,5 @@
_site
.sass-cache
+.jekyll-cache
.jekyll-metadata
+vendor/
diff --git a/_templates/jekyll-gazelle-documentation/Gemfile b/_templates/jekyll-gazelle-documentation/Gemfile
index 109959e..0f7e7b4 100755
--- a/_templates/jekyll-gazelle-documentation/Gemfile
+++ b/_templates/jekyll-gazelle-documentation/Gemfile
@@ -9,16 +9,28 @@ ruby RUBY_VERSION
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
-gem "jekyll", "3.2.1"
-
+gem "jekyll", "~> 4.2.2"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem "minima"
-
+gem "minima", "~> 2.5"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
# gem "github-pages", group: :jekyll_plugins
# If you have any plugins, put them here!
-# group :jekyll_plugins do
-# gem "jekyll-github-metadata", "~> 1.0"
-# end
+group :jekyll_plugins do
+ gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+ gem "tzinfo", "~> 1.2"
+ gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
diff --git a/_templates/jekyll-gazelle-documentation/Gemfile.lock b/_templates/jekyll-gazelle-documentation/Gemfile.lock
old mode 100755
new mode 100644
index 0e0bfcb..0458c36
--- a/_templates/jekyll-gazelle-documentation/Gemfile.lock
+++ b/_templates/jekyll-gazelle-documentation/Gemfile.lock
@@ -1,48 +1,84 @@
GEM
remote: https://rubygems.org/
specs:
+ addressable (2.8.4)
+ public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
- ffi (1.9.14)
+ concurrent-ruby (1.2.2)
+ em-websocket (0.5.3)
+ eventmachine (>= 0.12.9)
+ http_parser.rb (~> 0)
+ eventmachine (1.2.7)
+ ffi (1.15.5)
forwardable-extended (2.6.0)
- jekyll (3.2.1)
+ http_parser.rb (0.8.0)
+ i18n (1.14.1)
+ concurrent-ruby (~> 1.0)
+ jekyll (4.2.2)
+ addressable (~> 2.4)
colorator (~> 1.0)
- jekyll-sass-converter (~> 1.0)
- jekyll-watch (~> 1.1)
- kramdown (~> 1.3)
- liquid (~> 3.0)
- mercenary (~> 0.3.3)
+ em-websocket (~> 0.5)
+ i18n (~> 1.0)
+ jekyll-sass-converter (~> 2.0)
+ jekyll-watch (~> 2.0)
+ kramdown (~> 2.3)
+ kramdown-parser-gfm (~> 1.0)
+ liquid (~> 4.0)
+ mercenary (~> 0.4.0)
pathutil (~> 0.9)
- rouge (~> 1.7)
+ rouge (~> 3.0)
safe_yaml (~> 1.0)
- jekyll-sass-converter (1.4.0)
- sass (~> 3.4)
- jekyll-watch (1.5.0)
- listen (~> 3.0, < 3.1)
- kramdown (1.12.0)
- liquid (3.0.6)
- listen (3.0.8)
- rb-fsevent (~> 0.9, >= 0.9.4)
- rb-inotify (~> 0.9, >= 0.9.7)
- mercenary (0.3.6)
- minima (1.2.0)
- pathutil (0.14.0)
+ terminal-table (~> 2.0)
+ jekyll-feed (0.17.0)
+ jekyll (>= 3.7, < 5.0)
+ jekyll-sass-converter (2.2.0)
+ sassc (> 2.0.1, < 3.0)
+ jekyll-seo-tag (2.8.0)
+ jekyll (>= 3.8, < 5.0)
+ jekyll-watch (2.2.1)
+ listen (~> 3.0)
+ kramdown (2.4.0)
+ rexml
+ kramdown-parser-gfm (1.1.0)
+ kramdown (~> 2.0)
+ liquid (4.0.4)
+ listen (3.8.0)
+ rb-fsevent (~> 0.10, >= 0.10.3)
+ rb-inotify (~> 0.9, >= 0.9.10)
+ mercenary (0.4.0)
+ minima (2.5.1)
+ jekyll (>= 3.5, < 5.0)
+ jekyll-feed (~> 0.9)
+ jekyll-seo-tag (~> 2.1)
+ pathutil (0.16.2)
forwardable-extended (~> 2.6)
- rb-fsevent (0.9.7)
- rb-inotify (0.9.7)
- ffi (>= 0.5.0)
- rouge (1.11.1)
- safe_yaml (1.0.4)
- sass (3.4.22)
+ public_suffix (5.0.3)
+ rb-fsevent (0.11.2)
+ rb-inotify (0.10.1)
+ ffi (~> 1.0)
+ rexml (3.2.5)
+ rouge (3.30.0)
+ safe_yaml (1.0.5)
+ sassc (2.4.0)
+ ffi (~> 1.9)
+ terminal-table (2.0.0)
+ unicode-display_width (~> 1.1, >= 1.1.1)
+ unicode-display_width (1.8.0)
PLATFORMS
- ruby
+ x86_64-linux
DEPENDENCIES
- jekyll (= 3.2.1)
- minima
+ http_parser.rb (~> 0.6.0)
+ jekyll (~> 4.2.2)
+ jekyll-feed (~> 0.12)
+ minima (~> 2.5)
+ tzinfo (~> 1.2)
+ tzinfo-data
+ wdm (~> 0.1.1)
RUBY VERSION
- ruby 2.2.2p95
+ ruby 2.7.0p0
BUNDLED WITH
- 1.17.3
+ 2.4.16
diff --git a/_templates/jekyll-gazelle-documentation/_config.yml b/_templates/jekyll-gazelle-documentation/_config.yml
index b387eca..f663a3a 100755
--- a/_templates/jekyll-gazelle-documentation/_config.yml
+++ b/_templates/jekyll-gazelle-documentation/_config.yml
@@ -6,17 +6,22 @@
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'jekyll serve'. If you change this file, please restart the server process.
-
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
+
title: Gazelle documentation
email: contact@gazelle.ihe.net
description: >
- This site contains gazelle platform tools documentation
+ Documentation of Gazelle platform and tools.
baseurl: "/gazelle-documentation" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site
--
GitLab