Skip to content

Commit

Permalink
Merge pull request #1685 from folio-org/FOLIO-873-improve-docs-269
Browse files Browse the repository at this point in the history 
FOLIO-873 improve docs
  • Loading branch information
@dcrossleyau
dcrossleyau authored Jun 19, 2024
2 parents 04770cc + 441ad72 commit df38187
Show file tree
Hide file tree
Showing 4 changed files with 108 additions and 41 deletions.
37 changes: 22 additions & 15 deletions _data/repos.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"metadata": {
"generatedDateTime": "2024-05-22T06:26:22.691494+00:00"
"generatedDateTime": "2024-06-18T05:30:36.498100+00:00"
},
"repos": [
{
Expand Down Expand Up @@ -140,7 +140,7 @@
"snippetIntro": "<p>Utilities for DataImport modules.</p>"
},
{
"defaultBranch": "poppy",
"defaultBranch": "quesnelia",
"description": "FOLIO Documentation",
"docDirName": null,
"name": "docs",
Expand Down Expand Up @@ -427,7 +427,7 @@
"ramlDirName": "ramls",
"repoLanguageHint": "java",
"repoType": "backend-edge",
"snippetIntro": "<p>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.</p>",
"snippetIntro": "<p>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.</p>",
"workflows": [
"api-doc.yml",
"api-lint.yml",
Expand Down Expand Up @@ -658,7 +658,7 @@
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": "<p>FOLIO Helm charts modules repository.</p>"
"snippetIntro": "<p>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.</p>"
},
{
"defaultBranch": "master",
Expand Down Expand Up @@ -1081,7 +1081,12 @@
"ramlDirName": null,
"repoLanguageHint": "gradle",
"repoType": "backend-mod",
"snippetIntro": "<p>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.</p>"
"snippetIntro": "<p>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.</p>",
"workflows": [
"int-tests.yml",
"run-int-tests.yml",
"stuck-license-cla.yml"
]
},
{
"apiTypes": "RAML",
Expand Down Expand Up @@ -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": "<p>Introduction ... ## Additional information</p>"
"snippetIntro": "<p>This module provides a <strong>Workflow</strong> backend <strong>FOLIO</strong> module intended to help facilite and interact with one or more <strong>Workflow Engines</strong>. A <strong>Workflow Engine</strong> is able to react to events generated in FOLIO and may also trigger events based on some schedule.</p>"
},
{
"defaultBranch": "master",
Expand Down Expand Up @@ -3560,12 +3565,10 @@
"repoType": "stripes",
"snippetIntro": "<p>Stripes is a toolkit for building single-page web applications that FOLIO UI modules can run in. UI modules are made up of <a href='https://facebook.github.io/react/'>React</a> components, some of which will be connected to back-end services provided by <a href='https://github.com/folio-org/okapi'>Okapi</a>. 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.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
"ui.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
"ui.yml"
]
},
{
Expand Down Expand Up @@ -3597,7 +3600,8 @@
"snippetIntro": "<p>This is a library of React components and utility functions for use with <a href='https://github.com/folio-org/stripes-core/'>the Stripes UI toolkit</a>, part of <a href='https://www.folio.org/'>the FOLIO project</a>.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
"build-npm.yml",
"stuck-license-cla.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
Expand Down Expand Up @@ -3905,7 +3909,8 @@
"snippetIntro": "<p>The Agreements UI Module, or <code>ui-agreements</code>, is a Stripes UI module used for management of various E-resource tasks including handling agreements and viewing available E-resources.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
"build-npm.yml",
"stuck-license-cla.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
Expand Down Expand Up @@ -4610,7 +4615,8 @@
"snippetIntro": "<p>The Open Access UI Module or ui-oa, is a Stripes UI module for the management of OA publication requests and related resources</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
"build-npm.yml",
"stuck-license-cla.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
Expand Down Expand Up @@ -5229,7 +5235,8 @@
"snippetIntro": "<p>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</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
"build-npm.yml",
"stuck-license-cla.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
Expand Down
49 changes: 23 additions & 26 deletions _remote/edge-common/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
44 changes: 44 additions & 0 deletions images/FOLIO_Bee.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions images/FOLIO_homebutton.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit df38187

Please sign in to comment.