-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md, introduce INSTALL.md #174
Merged
borisrizov-zf
merged 6 commits into
eclipse-tractusx:develop
from
pmoscode:chore/update-readme
Nov 28, 2023
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8816c89
feat(devel): make application port dynamic (parameter)
pmoscode 6919b71
feat(readme): add "usage" section [WIP]
pmoscode 4a3d317
fix(dev): adjust port to request against keycloak
pmoscode 54b8d4a
feat(dev): update README.md and introduce INSTALL.md for usage
pmoscode a7c1b71
fix(dev): add important notes to INSTALL.md
pmoscode 59b6df4
fix(dev): small adjustment to INSTALL.md
pmoscode File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Managed Identity Wallets | ||
|
||
If you just want to try out MIW (without any developer setup), then you can find a quick start guide here: | ||
|
||
(It will only work on macOS or GNU/Linux - For Windows, | ||
you need to use the [WSL](https://learn.microsoft.com/de-de/windows/wsl/install)) | ||
|
||
- You need to install these tools: | ||
- [Docker](https://docs.docker.com/desktop/) (or from your package manager) | ||
-> Configure it to run without root permission | ||
- Docker [compose plugin](https://docs.docker.com/compose/) | ||
- [Taskfile](https://taskfile.dev) | ||
- [jq](https://jqlang.github.io/jq/) | ||
- Clone this repo | ||
- (Optional) Checkout main (stable) or develop (latest), if not already checked out | ||
- Copy `dev-assets/env-files/env.docker.dist` to `dev-assets/env-files/env.docker` | ||
- Set these variables in `env.docker` | ||
- POSTGRES_PASSWORD | ||
- POSTGRES_PASSWORD_MIW | ||
- KEYCLOAK_ADMIN_PASSWORD | ||
- ENCRYPTION_KEY (32 random alphanumeric characters) | ||
- GITHUB_USERNAME | ||
- GITHUB_TOKEN | ||
- Follow the "docker" path of the "Development setup" to get it up and running: | ||
1. Run `task docker:start-app` and wait until it shows "Started ManagedIdentityWalletsApplication in ... seconds" | ||
2. Run `task app:get-token` in another shell and copy the token (including "BEARER" prefix) (Mac users have the token already in their clipboard :) ) | ||
3. Open API doc on http://localhost:8000 | ||
4. Click on Authorize on Swagger UI and on the dialog paste the token (incl. "Bearer") into the "value" input | ||
5. Click on "Authorize" and "close" | ||
6. MIW is up, running, and you are authorized to fire requests in the Swagger UI | ||
7. If you're done, then run `task docker:stop-app` to clean up everything | ||
|
||
> [!IMPORTANT] | ||
> To compile MIW, | ||
> you need a PAT with the permission `read:packages` to | ||
> access `https://maven.pkg.github.com/catenax-ng/product-lab-ssi`. | ||
> | ||
> That is, why you need to set `GITHUB_USERNAME` and `GITHUB_TOKEN`. Otherwise, you are not able to get the SSI-lib. | ||
|
||
> [!IMPORTANT] | ||
> You need to use Java 17! | ||
|
||
> [!WARNING] | ||
> If you encounter some kind of database connection errors, then execute `task docker:stop-app`. | ||
> This will remove all existing Docker volumes, which may cause this error. | ||
|
||
> [!IMPORTANT] | ||
> Ensure you have exactly 32 random alphanumeric characters set | ||
> for `ENCRYPTION_KEY` in `dev-assets/env-files/env.docker` |
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
References to catenax-ng is prohibited.
INSTALL.md
is supposed to contain deployment information for productive use, not local test installations.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.