Skip to content

Commit

Permalink
docs(jans-cedarling): update sidecar readme
Browse files Browse the repository at this point in the history
Signed-off-by: SafinWasi <[email protected]>
  • Loading branch information
SafinWasi committed Jan 17, 2025
1 parent 1af662a commit c0d8ff7
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion jans-cedarling/flask-sidecar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,36 @@ For running via poetry, the sidecar supports the following environment variables
- Set environment variables like so:
```
APP_MODE=development
CEDARLING_BOOTSTRAP_CONFIG_FILE=/path/to/bootstrap.json
SIDECAR_DEBUG_RESPONSE=False
```
## Tests
Not yet implemented
## Docker Instructions
# Docker Instructions
- Create a file called `bootstrap.json`. You may use this [sample](https://github.com/JanssenProject/jans/blob/main/jans-cedarling/flask-sidecar/secrets/bootstrap.json) file.
- Modify the file to your specifications. Configuration values are described [here](https://github.com/JanssenProject/jans/blob/main/jans-cedarling/bindings/cedarling_python/cedarling_python.pyi).
- Pull the docker image:
```
docker pull ghcr.io/janssenproject/jans/cedarling-flask-sidecar:0.0.0-nightly
```
- Run the docker image, replacing `</absolute/path/to/bootstrap.json>` with the absolute path to your bootstrap file:
```bash
docker run -d \
-e APP_MODE='development' \
-e CEDARLING_BOOTSTRAP_CONFIG_FILE=/bootstrap.json \
-e SIDECAR_DEBUG_RESPONSE=False \
--mount type=bind,src=</absolute/path/to/bootstrap.json>,dst=/bootstrap.json \
-p 5000:5000\
ghcr.io/janssenproject/jans/cedarling-flask-sidecar:0.0.0-nightly
```
- The service is running on `http://0.0.0.0:5000`. OpenAPI documentation is available at `/swagger-ui`
## Docker Compose Instructions (for development)
- Clone the [Janssen](https://github.com/JanssenProject/jans) repository
- Navigate to `jans/jans-cedarling/flask-sidecar/`
Expand Down

0 comments on commit c0d8ff7

Please sign in to comment.