Skip to content

Commit 1f91d7c

Browse files
authored
Merge pull request #1 from softrams/patch-1
Update README.md
2 parents 7db4d5c + e64d438 commit 1f91d7c

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Proxy Authorization Service for Prefect UI and Prefect CLI
1+
# Proxy Authorization Service for Prefect UI and Prefect CLI
2+
![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/softrams/prefect-auth-proxy)
23

34
[Prefect](https://prefect.io) is a great platform for building data flows/pipelines. It supports hybrid execution with execution engines running on-premises with
45
all command control and monitoring capabilities via the Prefect UI hosted on the cloud. This means metadata about flows, logs and metrics
@@ -62,14 +63,29 @@ The following Environment Variables are available to configure the Proxy service
6263
| `DB_PASSWORD` | `NULL` | MySQL Database Server Password |
6364
| `DB_DATABASE` | `NULL` | MySQL Database Name |
6465

65-
### Docker Build
66+
### Docker Image
6667

68+
#### Use pre-built docker image
69+
70+
Use docker image from Docker hub
6771
```bash
68-
# Run docker image
72+
# Run using pre-built docker image from docker hub
6973
# Prepare environment variables in .env file
7074
docker run -d -p 3000:3000 --env-file ./.env --name auth-proxy softrams/prefect-auth-proxy:latest
7175
```
7276

77+
#### Build a local docker image
78+
79+
Build a local docker image (with any changes as needed) and publish to your own repository.
80+
81+
```bash
82+
# Build local docker image
83+
docker build -t prefect-auth-proxy .
84+
# Run local docker image
85+
# Prepare environment variables in .env file
86+
docker run -d -p 3000:3000 --env-file ./.env --name auth-proxy prefect-auth-proxy
87+
```
88+
7389
### Running the service
7490

7591
This is a typical node.js application. So you can simply clone this repo and run.

0 commit comments

Comments
 (0)