Skip to content

Commit 3b2d6a5

Browse files
committed
Fixes
1 parent 42d6ecb commit 3b2d6a5

File tree

3 files changed

+30
-4
lines changed

3 files changed

+30
-4
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,15 @@ The backend runs at `http://localhost:8000`.
8787

8888
### Running with Docker
8989

90+
A pre-built image is available from GitHub Container Registry:
91+
92+
```bash
93+
docker pull ghcr.io/bigdataboutique/virodraw
94+
docker run -p 8000:8000 ghcr.io/bigdataboutique/virodraw
95+
```
96+
97+
Or build it yourself:
98+
9099
```bash
91100
docker build -t virodraw .
92101
docker run -p 8000:8000 virodraw
@@ -95,9 +104,20 @@ docker run -p 8000:8000 virodraw
95104
Open `http://localhost:8000` in your browser. Exported images are saved to `/app/backend/output` inside the container -- mount a volume if you want to persist them:
96105

97106
```bash
98-
docker run -p 8000:8000 -v $(pwd)/output:/app/backend/output virodraw
107+
docker run -p 8000:8000 -v $(pwd)/output:/app/backend/output ghcr.io/bigdataboutique/virodraw
99108
```
100109

110+
### Deploying to Kubernetes
111+
112+
Ready-made Kubernetes manifests are provided in the `k8s/` directory:
113+
114+
```bash
115+
# Edit k8s/deployment.yaml to set your domain and any other configuration
116+
kubectl apply -f k8s/deployment.yaml
117+
```
118+
119+
This creates a Deployment, Service, and Ingress. Update the Ingress host and TLS settings for your environment.
120+
101121
## Project Structure
102122

103123
```
@@ -113,6 +133,8 @@ backend/
113133
main.py # FastAPI server (proxy-image, save, health, SPA serving)
114134
output/ # Exported images saved here
115135
Dockerfile # Multi-stage build (Node.js build + Python runtime)
136+
k8s/
137+
deployment.yaml # Kubernetes Deployment, Service, and Ingress
116138
```
117139

118140
## License

docs/index.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,12 @@ <h3>Flexible Export</h3>
246246
<h2>Getting Started</h2>
247247

248248
<h3>Run with Docker</h3>
249-
<pre><code>docker build -t virodraw .
250-
docker run -p 8000:8000 virodraw</code></pre>
249+
<pre><code>docker pull ghcr.io/bigdataboutique/virodraw
250+
docker run -p 8000:8000 ghcr.io/bigdataboutique/virodraw</code></pre>
251+
252+
<h3>Deploy to Kubernetes</h3>
253+
<pre><code>kubectl apply -f k8s/deployment.yaml</code></pre>
254+
<p style="color: #555; font-size: 0.95rem; margin-top: 0.5rem;">Ready-made manifests (Deployment, Service, Ingress) are included in the <code>k8s/</code> directory. Edit the Ingress host and TLS settings for your environment.</p>
251255

252256
<h3>Run locally (development)</h3>
253257
<pre><code># Frontend

k8s/deployment.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ spec:
1616
spec:
1717
containers:
1818
- name: virodraw
19-
image: ghcr.io/bigdataboutique/virodraw:main
19+
image: ghcr.io/bigdataboutique/virodraw:latest
2020
ports:
2121
- containerPort: 8000
2222
resources:

0 commit comments

Comments
 (0)