Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix(core): 1269 readme quickstart has incorrect steps #1268

Merged
merged 2 commits into from
Aug 8, 2024
Merged

fix(core): 1269 readme quickstart has incorrect steps #1268

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a28de3b
update readme
ryanulit Aug 6, 2024
3cc1aee
Merge branch 'main' into fix/quick-start-readme-issues
ryanulit Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,26 +72,29 @@ To get started with the OpenTDF platform make sure you are running the same Go v
<!-- markdownlint-disable MD034 github embedded sourcecode -->
https://github.com/opentdf/platform/blob/main/service/go.mod#L3

Generate development keys/certs for the platform infrastructure.

```sh
./.github/scripts/init-temp-keys.sh
```

Start the required infrastructure with [compose-spec](https://compose-spec.io).

```sh
# Note this might be `podman compose` on some systems
docker compose -f docker-compose.yaml up
```

Copy the configuration file from the example and update it with your own values.
Copy the development configuration file from the example and update it with your own values (if necessary, not common).

```sh
cp opentdf-example.yaml opentdf.yaml
cp opentdf-dev.yaml opentdf.yaml
```

Provision default configurations.
Provision keycloak with the default configuration.

```sh
# Provision keycloak with the default configuration.
go run ./service provision keycloak
# Generate the temporary keys for KAS
./.github/scripts/init-temp-keys.sh
```

Run the OpenTDF platform service.
Expand Down
Loading