Compare commits

..

5 Commits

Author SHA1 Message Date
Elisiário Couto
da6c7bbf3e chore(ci): Bump version to 2025.9.3 2025-09-10 01:21:49 +01:00
Elisiário Couto
90e58734ad chore(ci): Fix GitHub Actions syntax. 2025-09-10 01:21:39 +01:00
Elisiário Couto
03e16a9b54 chore(ci): Bump version to 2025.9.2 2025-09-10 01:12:08 +01:00
Elisiário Couto
53e08e8e4b fix(ci): Prevent duplicate Docker tags in GitHub Actions
- Add latest=false flavor to both backend and frontend jobs
- Fix confusion between latest and latest-frontend tags
- Ensure proper image separation in Docker registries
2025-09-10 01:11:38 +01:00
Elisiário Couto
84fe79b37b feat(docker): Add Docker containerization for React frontend
- Add production compose.yml using published ghcr.io images
- Rename compose.yml to compose.dev.yml for development
- Create config.example.toml configuration template
- Update README.md with Docker setup instructions
- Use ./data directory for configuration and database storage
- Separate development and production Docker workflows
2025-09-10 00:53:49 +01:00
8 changed files with 233 additions and 96 deletions

View File

@@ -45,87 +45,91 @@ jobs:
push-docker-backend: push-docker-backend:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Set up QEMU - name: Set up QEMU
uses: docker/setup-qemu-action@v3 uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3 uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub - name: Login to Docker Hub
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
username: elisiariocouto username: elisiariocouto
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GitHub Container Registry - name: Login to GitHub Container Registry
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
registry: ghcr.io registry: ghcr.io
username: ${{ github.repository_owner }} username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }} password: ${{ secrets.GITHUB_TOKEN }}
- name: Docker meta backend - name: Docker meta backend
id: meta-backend id: meta-backend
uses: docker/metadata-action@v5 uses: docker/metadata-action@v5
with: with:
# list of Docker images to use as base name for tags flavor: |
images: | latest=false
elisiariocouto/leggen # list of Docker images to use as base name for tags
ghcr.io/elisiariocouto/leggen images: |
# generate Docker tags based on the following events/attributes elisiariocouto/leggen
tags: | ghcr.io/elisiariocouto/leggen
type=ref,event=tag # generate Docker tags based on the following events/attributes
type=semver,pattern={{version}} tags: |
type=semver,pattern={{major}}.{{minor}} type=ref,event=tag
type=raw,value=latest type=semver,pattern={{version}}
- name: Build and push backend type=semver,pattern={{major}}.{{minor}}
uses: docker/build-push-action@v5 type=raw,value=latest
with: - name: Build and push backend
context: . uses: docker/build-push-action@v5
file: ./Dockerfile with:
platforms: linux/amd64,linux/arm64 context: .
push: true file: ./Dockerfile
tags: ${{ steps.meta-backend.outputs.tags }} platforms: linux/amd64,linux/arm64
labels: ${{ steps.meta-backend.outputs.labels }} push: true
tags: ${{ steps.meta-backend.outputs.tags }}
labels: ${{ steps.meta-backend.outputs.labels }}
push-docker-frontend: push-docker-frontend:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Set up QEMU - name: Set up QEMU
uses: docker/setup-qemu-action@v3 uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3 uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub - name: Login to Docker Hub
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
username: elisiariocouto username: elisiariocouto
password: ${{ secrets.DOCKERHUB_TOKEN }} password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Login to GitHub Container Registry - name: Login to GitHub Container Registry
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
registry: ghcr.io registry: ghcr.io
username: ${{ github.repository_owner }} username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }} password: ${{ secrets.GITHUB_TOKEN }}
- name: Docker meta frontend - name: Docker meta frontend
id: meta-frontend id: meta-frontend
uses: docker/metadata-action@v5 uses: docker/metadata-action@v5
with: with:
# list of Docker images to use as base name for tags flavor: |
images: | latest=false
elisiariocouto/leggen # list of Docker images to use as base name for tags
ghcr.io/elisiariocouto/leggen images: |
# generate Docker tags based on the following events/attributes elisiariocouto/leggen
tags: | ghcr.io/elisiariocouto/leggen
type=ref,event=tag,suffix=-frontend # generate Docker tags based on the following events/attributes
type=semver,pattern={{version}},suffix=-frontend tags: |
type=semver,pattern={{major}}.{{minor}},suffix=-frontend type=ref,event=tag,suffix=-frontend
type=raw,value=latest-frontend type=semver,pattern={{version}},suffix=-frontend
- name: Build and push frontend type=semver,pattern={{major}}.{{minor}},suffix=-frontend
uses: docker/build-push-action@v5 type=raw,value=latest-frontend
with: - name: Build and push frontend
context: ./frontend uses: docker/build-push-action@v5
file: ./frontend/Dockerfile with:
platforms: linux/amd64,linux/arm64 context: ./frontend
push: true file: ./frontend/Dockerfile
tags: ${{ steps.meta-frontend.outputs.tags }} platforms: linux/amd64,linux/arm64
labels: ${{ steps.meta-frontend.outputs.labels }} push: true
tags: ${{ steps.meta-frontend.outputs.tags }}
labels: ${{ steps.meta-frontend.outputs.labels }}

View File

@@ -1,4 +1,46 @@
## 2025.9.3 (2025/09/10)
### Miscellaneous Tasks
- **ci:** Fix GitHub Actions syntax. ([90e58734](https://github.com/elisiariocouto/leggen/commit/90e58734adb9638efd695719321874658529561d))
## 2025.9.3 (2025/09/10)
### Miscellaneous Tasks
- **ci:** Fix GitHub Actions syntax. ([90e58734](https://github.com/elisiariocouto/leggen/commit/90e58734adb9638efd695719321874658529561d))
## 2025.9.2 (2025/09/10)
### Bug Fixes
- **ci:** Prevent duplicate Docker tags in GitHub Actions ([53e08e8e](https://github.com/elisiariocouto/leggen/commit/53e08e8e4b909b4895b5a447cfbce515893d31a5))
### Features
- **docker:** Add Docker containerization for React frontend ([84fe79b3](https://github.com/elisiariocouto/leggen/commit/84fe79b37b4f154fa0758f8d037cdba0d166dd3b))
## 2025.9.2 (2025/09/10)
### Bug Fixes
- **ci:** Prevent duplicate Docker tags in GitHub Actions ([53e08e8e](https://github.com/elisiariocouto/leggen/commit/53e08e8e4b909b4895b5a447cfbce515893d31a5))
### Features
- **docker:** Add Docker containerization for React frontend ([84fe79b3](https://github.com/elisiariocouto/leggen/commit/84fe79b37b4f154fa0758f8d037cdba0d166dd3b))
## 2025.9.1 (2025/09/09) ## 2025.9.1 (2025/09/09)
### Bug Fixes ### Bug Fixes

View File

@@ -64,8 +64,8 @@ git clone https://github.com/elisiariocouto/leggen.git
cd leggen cd leggen
# Create your configuration # Create your configuration
mkdir -p leggen && cp config.example.toml leggen/config.toml mkdir -p data && cp config.example.toml data/config.toml
# Edit leggen/config.toml with your GoCardless credentials # Edit data/config.toml with your GoCardless credentials
# Start all services (frontend + backend) # Start all services (frontend + backend)
docker compose up -d docker compose up -d
@@ -74,6 +74,31 @@ docker compose up -d
# API is available at http://localhost:8000 # API is available at http://localhost:8000
``` ```
#### Production Deployment
For production deployment using published Docker images:
```bash
# Clone the repository
git clone https://github.com/elisiariocouto/leggen.git
cd leggen
# Create your configuration
mkdir -p data && cp config.example.toml data/config.toml
# Edit data/config.toml with your GoCardless credentials
# Start production services
docker compose up -d
# Access the web interface at http://localhost:3000
# API is available at http://localhost:8000
```
### Development vs Production
- **Development**: Use `docker compose -f compose.dev.yml up -d` (builds from source)
- **Production**: Use `docker compose up -d` (uses published images)
#### Option 2: Local Development #### Option 2: Local Development
For development or local installation: For development or local installation:
@@ -90,7 +115,7 @@ uv run leggen --help
### Configuration ### Configuration
Create a configuration file at `~/.config/leggen/config.toml`: Create a configuration file at `./data/config.toml` (for Docker) or `~/.config/leggen/config.toml` (for local development):
```toml ```toml
[gocardless] [gocardless]
@@ -188,8 +213,25 @@ leggen status
### Docker Usage ### Docker Usage
#### Development (build from source)
```bash ```bash
# Start all services (frontend + backend) # Start development services
docker compose -f compose.dev.yml up -d
# View service status
docker compose -f compose.dev.yml ps
# Check logs
docker compose -f compose.dev.yml logs frontend
docker compose -f compose.dev.yml logs leggend
# Stop development services
docker compose -f compose.dev.yml down
```
#### Production (use published images)
```bash
# Start production services
docker compose up -d docker compose up -d
# View service status # View service status
@@ -202,7 +244,7 @@ docker compose logs leggend
# Access the web interface at http://localhost:3000 # Access the web interface at http://localhost:3000
# API documentation at http://localhost:8000/docs # API documentation at http://localhost:8000/docs
# Stop all services # Stop production services
docker compose down docker compose down
``` ```

25
compose.dev.yml Normal file
View File

@@ -0,0 +1,25 @@
services:
# React frontend service
frontend:
build:
context: ./frontend
dockerfile: Dockerfile
restart: "unless-stopped"
ports:
- "127.0.0.1:3000:80"
environment:
- API_BACKEND_URL=${API_BACKEND_URL:-http://leggend:8000}
depends_on:
leggend:
condition: service_healthy
# FastAPI backend service
leggend:
build:
context: .
dockerfile: Dockerfile
restart: "unless-stopped"
ports:
- "127.0.0.1:8000:8000"
volumes:
- "./data:/root/.config/leggen"

View File

@@ -1,25 +1,19 @@
services: services:
# React frontend service # React frontend service
frontend: frontend:
build: image: ghcr.io/elisiariocouto/leggen:latest-frontend
context: ./frontend
dockerfile: Dockerfile
restart: "unless-stopped" restart: "unless-stopped"
ports: ports:
- "127.0.0.1:3000:80" - "127.0.0.1:3000:80"
environment:
- API_BACKEND_URL=${API_BACKEND_URL:-http://leggend:8000}
depends_on: depends_on:
leggend: leggend:
condition: service_healthy condition: service_healthy
# FastAPI backend service # FastAPI backend service
leggend: leggend:
build: image: ghcr.io/elisiariocouto/leggen:latest
context: .
dockerfile: Dockerfile
restart: "unless-stopped" restart: "unless-stopped"
ports: ports:
- "127.0.0.1:8000:8000" - "127.0.0.1:8000:8000"
volumes: volumes:
- "./data:/root/.config/leggen" - "./data:/root/.config/leggen" # Configuration and database directory

30
config.example.toml Normal file
View File

@@ -0,0 +1,30 @@
[gocardless]
key = "your-api-key"
secret = "your-secret-key"
url = "https://bankaccountdata.gocardless.com/api/v2"
[database]
sqlite = true
# Optional: Background sync scheduling
[scheduler.sync]
enabled = true
hour = 3 # 3 AM
minute = 0
# cron = "0 3 * * *" # Alternative: use cron expression
# Optional: Discord notifications
[notifications.discord]
webhook = "https://discord.com/api/webhooks/..."
enabled = true
# Optional: Telegram notifications
[notifications.telegram]
token = "your-bot-token"
chat_id = 12345
enabled = true
# Optional: Transaction filters for notifications
[filters]
case-insensitive = ["salary", "utility"]
case-sensitive = ["SpecificStore"]

View File

@@ -1,6 +1,6 @@
[project] [project]
name = "leggen" name = "leggen"
version = "2025.9.1" version = "2025.9.3"
description = "An Open Banking CLI" description = "An Open Banking CLI"
authors = [{ name = "Elisiário Couto", email = "elisiario@couto.io" }] authors = [{ name = "Elisiário Couto", email = "elisiario@couto.io" }]
requires-python = "~=3.13.0" requires-python = "~=3.13.0"

2
uv.lock generated
View File

@@ -222,7 +222,7 @@ wheels = [
[[package]] [[package]]
name = "leggen" name = "leggen"
version = "2025.9.1" version = "2025.9.3"
source = { editable = "." } source = { editable = "." }
dependencies = [ dependencies = [
{ name = "apscheduler" }, { name = "apscheduler" },