feat: Standardize sync frequency to minutes, remove Baïkal service from Docker Compose, and utilize a pre-built image for the sync container.
This commit is contained in:
20
README.md
20
README.md
@@ -9,7 +9,7 @@ A Dockerized Python service that periodically synchronizes an external Outlook I
|
||||
|
||||
## Prerequisites
|
||||
- Docker & Docker Compose installed.
|
||||
- A running Baïkal instance (included in the example `docker-compose.yml`).
|
||||
- An existing Baïkal instance.
|
||||
- An Outlook ICS link.
|
||||
|
||||
## Configuration (Environment Variables)
|
||||
@@ -20,7 +20,7 @@ A Dockerized Python service that periodically synchronizes an external Outlook I
|
||||
| `BAIKAL_URL` | The URL to your Baïkal calendar (e.g., `http://baikal/dav.php/calendars/user/id/`). | **Required** |
|
||||
| `BAIKAL_USER` | Your Baïkal username. | **Required** |
|
||||
| `BAIKAL_PASS` | Your Baïkal password. | **Required** |
|
||||
| `SYNC_FREQUENCY` | How often to sync in seconds. | `300` (5 mins) |
|
||||
| `SYNC_FREQUENCY` | How often to sync **in minutes**. | `5` |
|
||||
|
||||
## Quick Start with Docker Compose
|
||||
|
||||
@@ -29,16 +29,18 @@ A Dockerized Python service that periodically synchronizes an external Outlook I
|
||||
|
||||
```bash
|
||||
ICS_URL="https://outlook.office365.com/..."
|
||||
BAIKAL_URL="http://localhost:8080/dav.php/calendars/Lago/beterna/"
|
||||
BAIKAL_URL="http://localhost:8080/dav.php/calendars/Lago/default/"
|
||||
BAIKAL_USER="Lago"
|
||||
BAIKAL_PASS="secret"
|
||||
SYNC_FREQUENCY=5
|
||||
```
|
||||
|
||||
3. **Run with Docker Compose**:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
docker compose up -d
|
||||
```
|
||||
*Note: This will verify the image usage. If you need to rebuild locally, run `docker compose up -d --build`.*
|
||||
|
||||
4. **Check Logs**:
|
||||
|
||||
@@ -46,16 +48,14 @@ A Dockerized Python service that periodically synchronizes an external Outlook I
|
||||
docker compose logs -f baikal-sync
|
||||
```
|
||||
|
||||
## Building & Publishing the Image manually
|
||||
|
||||
If you want to build and push the image to Docker Hub yourself:
|
||||
## Building & Publishing the Image
|
||||
|
||||
1. **Build**:
|
||||
```bash
|
||||
docker build -t yourusername/baikal-sync:latest .
|
||||
docker build -t lagortinez/baikal-sync:latest .
|
||||
```
|
||||
|
||||
2. **Push**:
|
||||
2. **Push** (requires `docker login`):
|
||||
```bash
|
||||
docker push yourusername/baikal-sync:latest
|
||||
docker push lagortinez/baikal-sync:latest
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user