Skip to content

Commit 3715a97

Browse files
committed
docs: add QUEUE_DB_PATH context and create .env.example
Added QUEUE_DB_PATH documentation to README and created .env.example with queue config variables. Job queue types remain in utils due to import cycle.
1 parent de09939 commit 3715a97

3 files changed

Lines changed: 24 additions & 1 deletion

File tree

backend/.env.example

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Google OAuth Configuration
2+
CLIENT_ID="your_client_id_here"
3+
CLIENT_SEC="your_client_secret_here"
4+
REDIRECT_URL_DEV="http://localhost:8000/auth/callback"
5+
SESSION_KEY="your_session_key_here"
6+
7+
# Frontend Configuration
8+
# For Docker:
9+
FRONTEND_ORIGIN_DEV="http://localhost"
10+
CONTAINER_ORIGIN="http://YOUR_CONTAINER_NAME:8080/"
11+
# For npm run dev:
12+
# FRONTEND_ORIGIN_DEV="http://localhost:5173"
13+
# CONTAINER_ORIGIN="http://localhost:8080/"
14+
15+
# Optional: Custom Backend Port
16+
# CCSYNC_PORT="8081"
17+
18+
# Job Queue Configuration
19+
CLEANUP_CRON_SCHEDULE="0 0 * * *" # Daily at midnight
20+
CLEANUP_RETENTION_DAYS="7" # Keep logs for 7 days
21+
QUEUE_DB_PATH="/app/data/queue.db" # Queue database location

backend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The job queue system uses the following environment variables:
8282

8383
### Database Location
8484

85-
The queue database is stored at `/app/data/queue.db` inside the container, which is mounted to `./backend/data/queue.db` on the host system via Docker volume.
85+
The queue database is stored at `/app/data/queue.db` inside the container, which is mounted to `./backend/data/queue.db` on the host system via Docker volume. The `QUEUE_DB_PATH` environment variable can be used to customize this location if needed.
8686

8787
- Run the application:
8888

backend/utils/persistent_queue.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import (
1010
"go.etcd.io/bbolt"
1111
)
1212

13+
// IMP ==> JobState and PersistentJob remain in utils due to import cycle with models/logs.go
14+
1315
type JobState string
1416

1517
const (

0 commit comments

Comments
 (0)