From 46596867f32a6dc56137c3a62b3d051d867bc8eb Mon Sep 17 00:00:00 2001 From: David Crossley Date: Tue, 18 Jun 2024 16:44:18 +1000 Subject: [PATCH 1/3] Update remote content FOLIO-3311 --- _remote/edge-common/README.md | 49 ++++++++++++++++------------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/_remote/edge-common/README.md b/_remote/edge-common/README.md index f551d922..6b3a4d79 100644 --- a/_remote/edge-common/README.md +++ b/_remote/edge-common/README.md @@ -169,34 +169,31 @@ Configuration information is specified in two forms: | `request_timeout_ms` | `30000` | Request Timeout | | `api_key_sources` | `PARAM,HEADER,PATH` | Defines the sources (order of precendence) of the API key. | -### System Properties for TLS configuration for Http server +### Env variables for TLS configuration for Http server + To configure Transport Layer Security (TLS) for the HTTP server in an edge module, the following configuration parameters should be used. -Parameters marked as Required are required only in case when ssl_enabled is set to true. - -| Property | Default | Description | -|-----------------------------------|-------------------|---------------------------------------------------------------------------------------------| -| `http-server.ssl_enabled` | `false` | Set whether SSL/TLS is enabled for Vertx Http Server | -| `http-server.keystore_type` | `NA` | (Required). Set the type of the keystore. Common types include `JKS`, `PKCS12`, and `BCFKS` | -| `http-server.keystore_provider` | `NA` | Set the provider name of the key store | -| `http-server.keystore_path` | `NA` | (Required). Set the location of the keystore file in the local file system | -| `http-server.keystore_password` | `NA` | (Required). Set the password for the keystore | -| `http-server.key_alias` | `NA` | Set the alias of the key within the keystore. | -| `http-server.key_alias_password` | `NA` | Optional param that points to a password of `key_alias` if it protected | - -### System Properties for TLS configuration for Web Client +Parameters marked as Required are required only in case when TLS for the server should be enabled. + +| Property | Default | Description | +|-----------------------------------------------------|------------------|---------------------------------------------------------------------------------------------| +| `SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_TYPE` | `NA` | (Required). Set the type of the keystore. Common types include `JKS`, `PKCS12`, and `BCFKS` | +| `SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_LOCATION` | `NA` | (Required). Set the location of the keystore file in the local file system | +| `SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEYSTORE_PASSWORD` | `NA` | (Required). Set the password for the keystore | +| `SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEY_ALIAS` | `NA` | Set the alias of the key within the keystore. | +| `SPRING_SSL_BUNDLE_JKS_WEBSERVER_KEY_PASSWORD` | `NA` | Optional param that points to a password of `KEY_ALIAS` if it protected | + +### Env variables for TLS configuration for Web Client + To configure Transport Layer Security (TLS) for Web clients in the edge module, you can use the following configuration parameters. -Truststore parameters for configuring Web clients are optional even when ssl_enabled = true. -If truststore parameters need to be populated, truststore_type, truststore_path and truststore_password are required. - -| Property | Default | Description | -|-----------------------------------|-------------------|----------------------------------------------------------------------------------| -| `web-client.ssl_enabled` | `false` | Set whether SSL/TLS is enabled for Vertx Http Server | -| `web-client.truststore_type` | `NA` | Set the type of the keystore. Common types include `JKS`, `PKCS12`, and `BCFKS` | -| `web-client.truststore_provider` | `NA` | Set the provider name of the key store | -| `web-client.truststore_path` | `NA` | Set the location of the keystore file in the local file system | -| `web-client.truststore_password` | `NA` | Set the password for the keystore | -| `web-client.key_alias` | `NA` | Set the alias of the key within the keystore. | -| `web-client.key_alias_password` | `NA` | Optional param that points to a password of `key_alias` if it protected | +Truststore parameters for configuring Web clients are optional even when `FOLIO_CLIENT_TLS_ENABLED = true`. +If truststore parameters need to be populated, `FOLIO_CLIENT_TLS_TRUSTSTORETYPE`, `FOLIO_CLIENT_TLS_TRUSTSTOREPATH` and `FOLIO_CLIENT_TLS_TRUSTSTOREPASSWORD` are required. + +| Property | Default | Description | +|-----------------------------------------|-------------------|----------------------------------------------------------------------------------| +| `FOLIO_CLIENT_TLS_ENABLED` | `false` | Set whether SSL/TLS is enabled for Vertx Http Server | +| `FOLIO_CLIENT_TLS_TRUSTSTORETYPE` | `NA` | Set the type of the keystore. Common types include `JKS`, `PKCS12`, and `BCFKS` | +| `FOLIO_CLIENT_TLS_TRUSTSTOREPATH` | `NA` | Set the location of the keystore file in the local file system | +| `FOLIO_CLIENT_TLS_TRUSTSTOREPASSWORD` | `NA` | Set the password for the keystore | ## Additional information From 141fe4d3957c376190825822cdd2e8b924de7933 Mon Sep 17 00:00:00 2001 From: David Crossley Date: Tue, 18 Jun 2024 16:45:25 +1000 Subject: [PATCH 2/3] Save some old FOLIO images from extinction --- images/FOLIO_Bee.svg | 44 +++++++++++++++++++++++++++++++++++++ images/FOLIO_homebutton.svg | 19 ++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 images/FOLIO_Bee.svg create mode 100644 images/FOLIO_homebutton.svg diff --git a/images/FOLIO_Bee.svg b/images/FOLIO_Bee.svg new file mode 100644 index 00000000..0ce30392 --- /dev/null +++ b/images/FOLIO_Bee.svg @@ -0,0 +1,44 @@ + + + + + + diff --git a/images/FOLIO_homebutton.svg b/images/FOLIO_homebutton.svg new file mode 100644 index 00000000..d9618344 --- /dev/null +++ b/images/FOLIO_homebutton.svg @@ -0,0 +1,19 @@ + + + + + + + + + + + + From 441ad725fa9a2797bd754761202d694f737df2ff Mon Sep 17 00:00:00 2001 From: David Crossley Date: Wed, 19 Jun 2024 14:48:39 +1000 Subject: [PATCH 3/3] Update list of repositories FOLIO-359 --- _data/repos.json | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/_data/repos.json b/_data/repos.json index 434cd6e1..88fd30f1 100644 --- a/_data/repos.json +++ b/_data/repos.json @@ -1,6 +1,6 @@ { "metadata": { - "generatedDateTime": "2024-05-22T06:26:22.691494+00:00" + "generatedDateTime": "2024-06-18T05:30:36.498100+00:00" }, "repos": [ { @@ -140,7 +140,7 @@ "snippetIntro": "

Utilities for DataImport modules.

" }, { - "defaultBranch": "poppy", + "defaultBranch": "quesnelia", "description": "FOLIO Documentation", "docDirName": null, "name": "docs", @@ -427,7 +427,7 @@ "ramlDirName": "ramls", "repoLanguageHint": "java", "repoType": "backend-edge", - "snippetIntro": "

The purpose of this edge API is to bridge the gap between 3rd party purchasing systems/vendors and FOLIO. More specifically, the initial implementation was built with EBSCO's GOBI (Global Online Bibliographic Interface) service in mind.

", + "snippetIntro": "

The purpose of this edge API is to bridge the gap between 3rd party purchasing systems/vendors and FOLIO. More specifically, the initial implementation was built with EBSCO's GOBI (Global Online Bibliographic Interface) service in mind.

", "workflows": [ "api-doc.yml", "api-lint.yml", @@ -658,7 +658,7 @@ "org": "folio-org", "repoLanguageHint": "other", "repoType": "other", - "snippetIntro": "

FOLIO Helm charts modules repository.

" + "snippetIntro": "

This repository contains Helm charts for different modules of the FOLIO (The Future of Libraries is Open) project. The FOLIO project aims to reimagine library software through a unique collaboration of libraries, developers, and vendors. It looks beyond the current model of an Integrated Library System to a new paradigm, where apps are built on an open platform, providing libraries with the ability to innovate and deliver extended services.

" }, { "defaultBranch": "master", @@ -1081,7 +1081,12 @@ "ramlDirName": null, "repoLanguageHint": "gradle", "repoType": "backend-mod", - "snippetIntro": "

Mod-Agreements is a FOLIO module to manage agreements which control an institutions access to resources. Normally, this will be subscribed access to packages of electronic resources, although the aim is to make the affordances offered by mod-agreements as general as possible.

" + "snippetIntro": "

Mod-Agreements is a FOLIO module to manage agreements which control an institutions access to resources. Normally, this will be subscribed access to packages of electronic resources, although the aim is to make the affordances offered by mod-agreements as general as possible.

", + "workflows": [ + "int-tests.yml", + "run-int-tests.yml", + "stuck-license-cla.yml" + ] }, { "apiTypes": "RAML", @@ -3221,13 +3226,13 @@ { "defaultBranch": "master", "description": null, - "docDirName": null, + "docDirName": "docs", "name": "mod-workflow", "org": "folio-org", "ramlDirName": null, "repoLanguageHint": "java", "repoType": "backend-mod", - "snippetIntro": "

Introduction ... ## Additional information

" + "snippetIntro": "

This module provides a Workflow backend FOLIO module intended to help facilite and interact with one or more Workflow Engines. A Workflow Engine is able to react to events generated in FOLIO and may also trigger events based on some schedule.

" }, { "defaultBranch": "master", @@ -3560,12 +3565,10 @@ "repoType": "stripes", "snippetIntro": "

Stripes is a toolkit for building single-page web applications that FOLIO UI modules can run in. UI modules are made up of React components, some of which will be connected to back-end services provided by Okapi. Each module has a 'type' which indicates how it functions within the application. At the moment, the only 'type' is 'app' which provides a top-level component to render into a large content area.

", "workflows": [ - "build-npm-release.yml", - "build-npm.yml" + "ui.yml" ], "workflowsFolio": [ - "build-npm-release.yml", - "build-npm.yml" + "ui.yml" ] }, { @@ -3597,7 +3600,8 @@ "snippetIntro": "

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

", "workflows": [ "build-npm-release.yml", - "build-npm.yml" + "build-npm.yml", + "stuck-license-cla.yml" ], "workflowsFolio": [ "build-npm-release.yml", @@ -3905,7 +3909,8 @@ "snippetIntro": "

The Agreements UI Module, or ui-agreements, is a Stripes UI module used for management of various E-resource tasks including handling agreements and viewing available E-resources.

", "workflows": [ "build-npm-release.yml", - "build-npm.yml" + "build-npm.yml", + "stuck-license-cla.yml" ], "workflowsFolio": [ "build-npm-release.yml", @@ -4610,7 +4615,8 @@ "snippetIntro": "

The Open Access UI Module or ui-oa, is a Stripes UI module for the management of OA publication requests and related resources

", "workflows": [ "build-npm-release.yml", - "build-npm.yml" + "build-npm.yml", + "stuck-license-cla.yml" ], "workflowsFolio": [ "build-npm-release.yml", @@ -5229,7 +5235,8 @@ "snippetIntro": "

The Serials Management UI Module or ui-serials-management, is a Stripes UI module for the management of serials, alongside expected pieces and prediction patterns

", "workflows": [ "build-npm-release.yml", - "build-npm.yml" + "build-npm.yml", + "stuck-license-cla.yml" ], "workflowsFolio": [ "build-npm-release.yml",