From e4194e6ccb2a88da041f3fa403ddaa7452b0d9b9 Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Fri, 15 Sep 2023 17:53:10 +0000 Subject: [PATCH 1/2] fix(docs): remove broken/unused extension --- docs/requirements.txt | 1 - mkdocs.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 80d1f6e3..f7699d91 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,3 @@ -fontawesome_markdown mkdocs mkdocs-awesome-pages-plugin mkdocs-macros-plugin diff --git a/mkdocs.yml b/mkdocs.yml index a1152c46..82e6f06d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,4 +57,3 @@ markdown_extensions: # insert a blank space before the character permalink: " ΒΆ" - smarty - - fontawesome_markdown From ba6f113522e5b5669b4714d139eaf768b34d5e96 Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Fri, 15 Sep 2023 18:13:53 +0000 Subject: [PATCH 2/2] docs(configuration): creating keypairs --- .markdownlint.yaml | 3 +++ docs/configuration/README.md | 34 +++++++++++++++++++++++++++++++--- keys/README.md | 4 +++- 3 files changed, 37 insertions(+), 4 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 9de30c91..b6b146b4 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -13,3 +13,6 @@ MD024: false # Allow inline HTML MD033: false + +# Allow fenced code blocks +MD046: false diff --git a/docs/configuration/README.md b/docs/configuration/README.md index 621808f5..a62f529d 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -9,7 +9,35 @@ If you want to run with different settings, you should: 1. Set the `ELIGIBILITY_SERVER_SETTINGS` environment variable to the path of your new file !!! note -The Eligibility server loads in settings using Flask's methods for [Configuration Handling](https://flask.palletsprojects.com/en/2.2.x/config/). -!!! important -The default settings that will always be loaded are in [eligibility_server/settings.py](https://github.com/cal-itp/eligibility-server/blob/dev/eligibility_server/settings.py) + The Eligibility server loads in settings using Flask's methods for [Configuration Handling](https://flask.palletsprojects.com/en/2.3.x/config/). + +!!! note + + The default settings that will always be loaded are in [eligibility_server/settings.py](https://github.com/cal-itp/eligibility-server/blob/dev/eligibility_server/settings.py) + +## Creating a new keypair + +!!! warning + + The sample keys cannot be used for production. You must create and use a new keypair. + +To create a new keypair, start by creating the private key e.g. using [OpenSSL](https://www.openssl.org/docs/man3.1/man1/openssl-genrsa.html): + +```console +openssl genrsa -out private.pem -traditional 4096 +``` + +Next, extract the public key e.g. using [OpenSSL](https://www.openssl.org/docs/man3.1/man1/openssl-rsa.html): + +```console +openssl rsa -in private.pem -pubout -out public.pem +``` + +Now there are two files: + +- The private key, kept secret for this server instance only: `private.pem` +- The public key, shared with all clients of this server: `public.pem` + +The server instance also needs a public key reference from its client, so the above process should be repeated on the client- +side and the client's _public key_ should be shared with the server. diff --git a/keys/README.md b/keys/README.md index bc80db72..a649549b 100644 --- a/keys/README.md +++ b/keys/README.md @@ -1,3 +1,5 @@ # keys -*These keys are just samples*. They cannot be used for production systems. +_These keys are just samples_. They cannot be used for production systems. + +See more at