Skip to content

Commit 7f7212a

Browse files
committed
Restore docker-compose.homelab.yml in deployment/ folder for homelab CI/CD
1 parent 1648b69 commit 7f7212a

2 files changed

Lines changed: 70 additions & 0 deletions

File tree

deployment/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Deployment Configurations
2+
3+
This directory contains optional deployment configurations for specific use cases.
4+
5+
## Files
6+
7+
### `docker-compose.homelab.yml`
8+
9+
**Purpose**: For homelab deployments using CI/CD with GHCR (GitHub Container Registry) images.
10+
11+
**When to use**:
12+
- You have CI/CD set up that builds and pushes images to GHCR
13+
- You want automatic updates from your container registry
14+
- You're deploying to a homelab server
15+
16+
**Usage**:
17+
```bash
18+
docker compose -f docker-compose.yml -f deployment/docker-compose.homelab.yml up -d
19+
```
20+
21+
**Note**: Update the image names (`ghcr.io/medevs/portfolio-*`) to match your own registry if using this template.
22+
23+
---
24+
25+
## For Regular Users
26+
27+
If you're just using this as a portfolio template, you don't need any files in this directory. Simply use:
28+
29+
```bash
30+
docker compose up -d
31+
```
32+
33+
This will build the images locally from the Dockerfiles.
34+
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# =============================================================================
2+
# Docker Compose - Homelab Override (OPTIONAL)
3+
# =============================================================================
4+
# This file is for homelab/CI-CD deployments using GHCR images
5+
# Regular users should use docker-compose.yml directly
6+
# =============================================================================
7+
# Use with: docker-compose -f docker-compose.yml -f deployment/docker-compose.homelab.yml up
8+
# =============================================================================
9+
10+
version: '3.8'
11+
12+
services:
13+
# ===========================================================================
14+
# Backend Service - Use GHCR Image
15+
# ===========================================================================
16+
backend:
17+
# Remove build section and use GHCR image instead
18+
image: ghcr.io/medevs/portfolio-backend:latest
19+
# Keep all other settings from base compose
20+
pull_policy: always # Always pull latest image
21+
22+
# ===========================================================================
23+
# Frontend Service - Use GHCR Image
24+
# ===========================================================================
25+
frontend:
26+
# Remove build section and use GHCR image instead
27+
image: ghcr.io/medevs/portfolio-frontend:latest
28+
# Override ports for homelab
29+
ports:
30+
- "3100:3000"
31+
# Override environment variables for homelab
32+
environment:
33+
- NEXT_PUBLIC_API_URL=http://portfolio-api.medevs.local
34+
- NEXT_PUBLIC_ADMIN_API_KEY=${ADMIN_API_KEY}
35+
pull_policy: always # Always pull latest image
36+

0 commit comments

Comments
 (0)