PurdueApi/.env.example at main · Purdue-io/PurdueApi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# ===================================================================
# Purdue.io Docker Configuration
# ===================================================================
# Copy this file to .env and update with your configuration
#
# IMPORTANT: Never commit .env file to version control!
# ===================================================================

# -------------------------------------------------------------------
# PostgreSQL Database Configuration
# -------------------------------------------------------------------
POSTGRES_DB=purdueio
POSTGRES_USER=purdueio
POSTGRES_PASSWORD=changeme_in_production

# -------------------------------------------------------------------
# API Configuration
# -------------------------------------------------------------------
# Port to expose the API on the host machine
API_PORT=8080

# ASP.NET Core environment (Development or Production)
ASPNETCORE_ENVIRONMENT=Production

# -------------------------------------------------------------------
# CatalogSync Configuration
# -------------------------------------------------------------------

# Sync Schedule (cron expression)
# Determines when the catalog sync runs automatically
#
# Default: 0 2 * * * (Daily at 2:00 AM)
#
# Common Examples:
#   - "0 2 * * *"    = Daily at 2:00 AM (DEFAULT)
#   - "0 */6 * * *"  = Every 6 hours
#   - "0 */2 * * *"  = Every 2 hours
#   - "*/30 * * * *" = Every 30 minutes
#   - "0 0 * * 0"    = Weekly on Sunday at midnight
#
SYNC_SCHEDULE=0 2 * * *

# Terms to Sync (optional)
# Comma-separated list of term codes to sync
# Example: SYNC_TERMS=202410,202510,202520
# Leave empty to sync all available terms based on SYNC_ALL_TERMS setting
SYNC_TERMS=

# Subjects to Sync (optional)
# Comma-separated list of subject codes to sync
# Example: SYNC_SUBJECTS=CS,MA,PHYS,ECE,ENGL
# Leave empty to sync all subjects
SYNC_SUBJECTS=

# Sync All Terms
# Controls whether to sync all historical terms or only current/future terms
#   - false (default): Only sync current and future terms
#   - true: Sync all available terms including historical data
SYNC_ALL_TERMS=false

# Run Once Mode (for testing/initialization)
# Set to "true" to run the sync once and exit (useful for testing)
# Set to "false" for continuous cron scheduling (production mode)
RUN_ONCE=false