Set up docs container #7
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The moved files are from the 'eligibility-server' project and were originally moved from the 'benefits' project. docker-compose.yml needed a small change with the build context in order for the 'COPY docs/requirements.txt ...' to work properly.
thekaveman
requested changes
Nov 16, 2021
docs/token-signing-encryption.md
Outdated
|
|
||
| The Eligiblity Verification API makes use of Signed and Encrypted JSON Web Tokens (JWS, JWE, JWT) as a means of data transfer. | ||
|
|
||
| A public/private keypair must be generated by each party (Benefits Client and Eligibility Verification Server). |
There was a problem hiding this comment.
Let's make this more generic here:
A public/private keypair must be generated by each party (Client and Server).
docs/token-signing-encryption.md
Outdated
| The Eligiblity Verification API makes use of Signed and Encrypted JSON Web Tokens (JWS, JWE, JWT) as a means of data transfer. | ||
|
|
||
| A public/private keypair must be generated by each party (Benefits Client and Eligibility Verification Server). | ||
| [Example keys](https://github.com/cal-itp/benefits/tree/dev/localhost/keys) are included for the test verification server |
There was a problem hiding this comment.
Expand to point to example keys in both benefits and eligibility-server
docs/token-signing-encryption.md
Outdated
|
|
||
| There are two new files: | ||
|
|
||
| * `[file name].key`: private key in PEM format, apply to a `TransitAgency` instance in Django |
There was a problem hiding this comment.
Again we can make this a little more generic:
private key in PEM format, needed by the Client only
docs/token-signing-encryption.md
Outdated
| * `[file name].pub`: public key in PEM format, give to the Eligibility Verification server | ||
|
|
||
| A public key in PEM format from the Eligibility Verification server is also required, and must be applied to an | ||
| `EligiblityVerifier` instance in Django. |
There was a problem hiding this comment.
The Client also requires a public key from the Eligibility Verification server, so this process must be repeated to generate the Server's keypair.
The Server's private key should not be shared.
|
Thanks for the feedback @thekaveman . I pushed new changes - let me know if anything looks off. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does
docscontainer that starts upmkdocsdocsfolder