Skip to content

Commit

Permalink
Updated readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
EricWittmann committed Nov 4, 2023
1 parent 09238c5 commit 7d51a5b
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ This should result in Quarkus and the in-memory registry starting up, with the R
cd ui
npm install
cd ui-app
./init-dev.sh
npm run dev
```

Expand Down
45 changes: 44 additions & 1 deletion ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,48 @@ npm run package
This will bundle up all of the UI modules into a single `dist` directory at the root of the `ui`
directory. This bundle is then suitable for including in e.g. a container image.

### Containerize
Once the UI is built and packaged, docker/podman can be used to build a container image. This
can be done by using the included `build-docker.sh` script or with the following command (or
equivalent):

```
docker build -t="apicurio/apicurio-registry-ui:latest-snapshot" --rm .
```

## Running the Container Image
You can build the UI container image locally (see the steps above) or you can pull the latest
container image with this command:

```
docker pull apicurio/apicurio-registry-ui:latest-snapshot
```

Either way, you can run the UI using docker with the following command:

```
docker run -it -p 8888:8080 apicurio/apicurio-registry-ui:latest-snapshot
```

Running without passing any environment variables will result in sensible defaults for running
the UI locally against a default locally run backend. However, the following environment
variables can be used to control the behavior of the UI:

| ENV var | Description | Default |
| ----------- | ----------- | ------- |
| REGISTRY_API_URL | Location of the backend API. | http://localhost:8080/apis/registry/v2 |
| REGISTRY_AUTH_TYPE | Type of authentication to use. [none, oidc] | none |
| REGISTRY_AUTH_URL | URL of the OIDC server. | "" |
| REGISTRY_AUTH_CLIENT_ID | Client ID for auth using OIDC. | registry-ui |
| REGISTRY_AUTH_REDIRECT_URL | Redirect URL when authenticating using OIDC. | http://localhost:8888 |
| REGISTRY_AUTH_RBAC_ENABLED | Enable role based access control. | false |
| REGISTRY_AUTH_OBAC_ENABLED | Enable owner based access control. | false |
| REGISTRY_FEATURE_READ_ONLY | Enable read-only mode for the UI only. | false |
| REGISTRY_FEATURE_BREADCRUMBS | Show breadcrumbs in the UI. | true |
| REGISTRY_FEATURE_ROLE_MANAGEMENT | Enable/show the Access tab in the UI. | false |
| REGISTRY_FEATURE_SETTINGS | Enable/show the Settings tab in the UI. | true |


## Developing the UI

If you would like to contribute code changes to the UI, you will want to run the UI application(s)
Expand Down Expand Up @@ -85,4 +127,5 @@ npm install
npm run test
```

The tests assume that the UI is running on localhost port 8888.
The tests assume that the UI is running on localhost port 8888.

0 comments on commit 7d51a5b

Please sign in to comment.