Mirror/gitea-mirror
1
0
Fork 0
mirror of https://github.com/RayLabsHQ/gitea-mirror.git synced 2025-12-07 03:56:46 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added docs around scheduling using corn

Browse Source
This commit is contained in:
Arunavo Ray
2025-09-07 16:51:51 +05:30
parent 4a54cf9009
commit c4b353aae8
2 changed files with 33 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -216,28 +216,32 @@ Gitea Mirror provides powerful automatic synchronization features:
- **Repository cleanup**: Removes repositories that no longer exist in GitHub - **Repository cleanup**: Removes repositories that no longer exist in GitHub
- **Proper intervals**: Mirrors respect your configured sync intervals (not Gitea's default 24h) - **Proper intervals**: Mirrors respect your configured sync intervals (not Gitea's default 24h)
- **Smart scheduling**: Only syncs repositories that need updating - **Smart scheduling**: Only syncs repositories that need updating
- **Auto-start on boot** (v3.5.3+): Automatically imports and mirrors all repositories when `SCHEDULE_ENABLED=true` or `GITEA_MIRROR_INTERVAL` is set - **Auto-start on boot** (v3.5.3+): Automatically imports and mirrors all repositories when `SCHEDULE_ENABLED=true` or `GITEA_MIRROR_INTERVAL` is set - no manual clicks required!
#### Configuration via Web Interface (Recommended) #### Configuration via Web Interface (Recommended)
Navigate to the Configuration page and enable "Automatic Syncing" with your preferred interval. Navigate to the Configuration page and enable "Automatic Syncing" with your preferred interval.
#### Configuration via Environment Variables #### Configuration via Environment Variables
**Set it and forget it!** With these environment variables, Gitea Mirror will automatically: **🚀 Set it and forget it!** With these environment variables, Gitea Mirror will automatically:
1. Import all your GitHub repositories on startup 1. **Import** all your GitHub repositories on startup (no manual import needed!)
2. Mirror them to Gitea immediately 2. **Mirror** them to Gitea immediately
3. Keep them synchronized based on your interval 3. **Keep them synchronized** based on your interval
4. Auto-discover new repos you create/star on GitHub 4. **Auto-discover** new repos you create/star on GitHub
5. Clean up repos you delete from GitHub 5. **Clean up** repos you delete from GitHub
```bash ```bash
# Enable automatic scheduling (required for auto features) # Option 1: Enable automatic scheduling (triggers auto-start)
SCHEDULE_ENABLED=true SCHEDULE_ENABLED=true
SCHEDULE_INTERVAL=3600 # Check every hour (or use cron: "0 * * * *")
# Mirror interval (how often to sync) # Option 2: Set mirror interval (also triggers auto-start)
GITEA_MIRROR_INTERVAL=8h # Every 8 hours (default) GITEA_MIRROR_INTERVAL=8h # Every 8 hours
# Other examples: 5m, 30m, 1h, 24h, 1d, 7d # Other examples: 5m, 30m, 1h, 24h, 1d, 7d
# Advanced: Use cron expressions for specific times
SCHEDULE_INTERVAL="0 2 * * *" # Daily at 2 AM (optimize bandwidth usage)
# Auto-import new repositories (default: true) # Auto-import new repositories (default: true)
AUTO_IMPORT_REPOS=true AUTO_IMPORT_REPOS=true

26
docs/ENVIRONMENT_VARIABLES.md
View File

@@ -151,15 +151,27 @@ Configure automatic scheduled mirroring.
| Variable | Description | Default | Options | | Variable | Description | Default | Options |
|----------|-------------|---------|---------| |----------|-------------|---------|---------|
| `SCHEDULE_ENABLED` | Enable automatic mirroring. **When set to `true`, automatically imports and mirrors all repositories on startup** (v3.5.3+) | `false` | `true`, `false` | | `SCHEDULE_ENABLED` | Enable automatic mirroring. **When set to `true`, automatically imports and mirrors all repositories on startup** (v3.5.3+) | `false` | `true`, `false` |
| `SCHEDULE_INTERVAL` | Interval in seconds or cron expression | `3600` | Number or cron string (e.g., `"0 2 * * *"`) | | `SCHEDULE_INTERVAL` | Interval in seconds or cron expression. **Supports cron syntax for scheduled runs** (e.g., `"0 2 * * *"` for 2 AM daily) | `3600` | Number (seconds) or cron string |
| `DELAY` | Legacy: same as SCHEDULE_INTERVAL | `3600` | Number (seconds) | | `DELAY` | Legacy: same as SCHEDULE_INTERVAL | `3600` | Number (seconds) |
> **Note**: Setting either `SCHEDULE_ENABLED=true` or `GITEA_MIRROR_INTERVAL` triggers auto-start functionality where the service will: > **🚀 Auto-Start Feature (v3.5.3+)**
> 1. Import all GitHub repositories on startup > Setting either `SCHEDULE_ENABLED=true` or `GITEA_MIRROR_INTERVAL` triggers auto-start functionality where the service will:
> 2. Mirror them to Gitea immediately > 1. **Import** all GitHub repositories on startup
> 3. Continue syncing at the configured interval > 2. **Mirror** them to Gitea immediately
> 4. Auto-discover new repositories > 3. **Continue syncing** at the configured interval
> 5. Clean up deleted repositories (if configured) > 4. **Auto-discover** new repositories
> 5. **Clean up** deleted repositories (if configured)
>
> This eliminates the need for manual button clicks - perfect for Docker/Kubernetes deployments!
> **⏰ Scheduling with Cron Expressions**
> Use cron expressions in `SCHEDULE_INTERVAL` to run at specific times:
> - `"0 2 * * *"` - Daily at 2 AM
> - `"0 */6 * * *"` - Every 6 hours
> - `"0 0 * * 0"` - Weekly on Sunday at midnight
> - `"0 3 * * 1-5"` - Weekdays at 3 AM (Monday-Friday)
>
> This is useful for optimizing bandwidth usage during low-activity periods.
### Execution Settings ### Execution Settings