generated from kbase/kbase-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.env.example
More file actions
109 lines (96 loc) · 4.89 KB
/
.env.example
File metadata and controls
109 lines (96 loc) · 4.89 KB
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# =============================================================================
# TableScanner Environment Configuration
# =============================================================================
# Copy this file to .env and fill in your values.
#
# IMPORTANT: The KB_ENV variable controls which KBase services the backend
# calls (workspace, shock, handle). All route defaults and client constructors
# read from this value. If deploying to production, you MUST set KB_ENV=prod.
# =============================================================================
# ---------------------------------------------------------------------------
# Authentication
# ---------------------------------------------------------------------------
# KBase authentication token (for local development / testing only).
# In production, user tokens are passed via the Authorization header or
# kbase_session cookie — this variable is NOT used for production auth.
# Get your token from: https://narrative.kbase.us/#auth/account
KB_SERVICE_AUTH_TOKEN=your_token_here
# ---------------------------------------------------------------------------
# Environment *** CRITICAL FOR PRODUCTION ***
# ---------------------------------------------------------------------------
# Controls which KBase service URLs the backend uses for workspace, shock,
# and handle resolution.
# appdev → https://appdev.kbase.us/services/...
# ci → https://ci.kbase.us/services/...
# prod → https://kbase.us/services/...
# Default: appdev
KB_ENV=appdev
# ---------------------------------------------------------------------------
# Cache
# ---------------------------------------------------------------------------
# Directory for downloaded SQLite databases. In production, mount a persistent
# volume here to survive container restarts.
CACHE_DIR=/tmp/tablescanner_cache
# Maximum age of cached files (hours) before re-download.
CACHE_MAX_AGE_HOURS=24
# ---------------------------------------------------------------------------
# Debugging
# ---------------------------------------------------------------------------
DEBUG=false
# ---------------------------------------------------------------------------
# CORS
# ---------------------------------------------------------------------------
# Allowed origins (JSON array). For production, restrict to KBase domains.
# CORS_ORIGINS=["https://kbase.us","https://narrative.kbase.us","https://berdl.kbase.us"]
CORS_ORIGINS=["*"]
# ---------------------------------------------------------------------------
# KBase Service URLs (optional overrides)
# ---------------------------------------------------------------------------
# These are usually auto-resolved from KB_ENV. Only set them if you need to
# override the defaults (e.g., pointing to a custom workspace deployment).
# WORKSPACE_URL=https://kbase.us/services/ws
# KBASE_ENDPOINT=https://kbase.us/services
# BLOBSTORE_URL=https://kbase.us/services/shock-api
# ---------------------------------------------------------------------------
# Timeout Settings (seconds)
# ---------------------------------------------------------------------------
DOWNLOAD_TIMEOUT_SECONDS=30.0
KBASE_API_TIMEOUT_SECONDS=10.0
# ---------------------------------------------------------------------------
# Upload Settings
# ---------------------------------------------------------------------------
MAX_UPLOAD_SIZE_MB=500
MAX_UPLOAD_STORAGE_GB=10
# ---------------------------------------------------------------------------
# Proxy / Root Path
# ---------------------------------------------------------------------------
# Set this when deploying behind a reverse proxy with a path prefix.
# AppDev: /services/berdl_table_scanner
# Production: /apis/dev_tablescanner
KB_SERVICE_ROOT_PATH=
# =============================================================================
# EXAMPLE: Production Deployment (.env for berdl.kbase.us)
# =============================================================================
# KB_ENV=prod
# CACHE_DIR=/data/tablescanner_cache
# CACHE_MAX_AGE_HOURS=24
# DEBUG=false
# CORS_ORIGINS=["https://kbase.us","https://narrative.kbase.us","https://berdl.kbase.us"]
# KB_SERVICE_ROOT_PATH=/apis/dev_tablescanner
# DOWNLOAD_TIMEOUT_SECONDS=30.0
# KBASE_API_TIMEOUT_SECONDS=10.0
# MAX_UPLOAD_STORAGE_GB=10
# =============================================================================
# =============================================================================
# EXAMPLE: AppDev Deployment (.env for appdev.kbase.us)
# =============================================================================
# KB_ENV=appdev
# CACHE_DIR=/data/tablescanner_cache
# CACHE_MAX_AGE_HOURS=24
# DEBUG=false
# CORS_ORIGINS=["https://appdev.kbase.us","https://narrative-dev.kbase.us"]
# KB_SERVICE_ROOT_PATH=/services/berdl_table_scanner
# DOWNLOAD_TIMEOUT_SECONDS=30.0
# KBASE_API_TIMEOUT_SECONDS=10.0
# MAX_UPLOAD_STORAGE_GB=10
# =============================================================================