shexmap-repository/.env.example at main · micheldumontier/shexmap-repository · 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# Copy this file to .env and fill in values for local development

# ─── API ─────────────────────────────────────────────────────────────────────
NODE_ENV=development
PORT=3000
LOG_LEVEL=info

# ─── JWT ─────────────────────────────────────────────────────────────────────
JWT_SECRET=change-me-in-production-use-a-long-random-string
JWT_EXPIRY=86400

# ─── Authentication ──────────────────────────────────────────────────────────
# Set to false to run the platform without any authentication (public read+write)
AUTH_ENABLED=false

# OAuth2 providers (only needed when AUTH_ENABLED=true)
OAUTH_GITHUB_CLIENT_ID=
OAUTH_GITHUB_CLIENT_SECRET=

OAUTH_ORCID_CLIENT_ID=
OAUTH_ORCID_CLIENT_SECRET=

OAUTH_GOOGLE_CLIENT_ID=
OAUTH_GOOGLE_CLIENT_SECRET=

# Base URL for OAuth callbacks (must match what's registered with the provider)
OAUTH_CALLBACK_BASE_URL=http://localhost

# ─── QLever ──────────────────────────────────────────────────────────────────
QLEVER_HOST=localhost
QLEVER_PORT=7001
QLEVER_SPARQL_URL=http://localhost:7001/sparql
QLEVER_UPDATE_URL=http://localhost:7001/update
QLEVER_ACCESS_TOKEN=shexmap-dev-token

# Path to ShEx files — in Docker this is mounted as /shex-files, in dev use the local path
SHEX_FILES_DIR=../sparql/files

# ─── Rate limiting ────────────────────────────────────────────────────────────
# Raise RATE_LIMIT_MAX for bulk imports (e.g. 10000). Restart the API to apply.
RATE_LIMIT_MAX=200
RATE_LIMIT_WINDOW=1 minute

# ─── RDF namespace ────────────────────────────────────────────────────────────
# Base IRI for all project-minted RDF resources and ontology terms.
# Changing this requires a QLever index rebuild (./scripts/rebuild-index.sh).
BASE_NAMESPACE=https://w3id.org/shexmap/

# ─── Frontend (Vite build-time) ───────────────────────────────────────────────
# These are embedded at build time; VITE_ prefix required
VITE_API_BASE_URL=/api/v1
VITE_SPARQL_ENDPOINT=/sparql
VITE_AUTH_ENABLED=false
VITE_BASE_NAMESPACE=https://w3id.org/shexmap/

# ─── GitHub ShEx Harvester ────────────────────────────────────────────────────
# GitHub Personal Access Token — strongly recommended; raises code-search rate
# limit from 10 req/min (unauthenticated) to 30 req/min (authenticated).
# Create one at: https://github.com/settings/tokens (no special scopes needed
# for public repo search; add `repo` scope to also harvest private repos).
GITHUB_TOKEN=

# API key used by the harvester when AUTH_ENABLED=true.
# Leave empty when auth is disabled (the default).
HARVESTER_API_KEY=

# Delay in milliseconds between REST API import calls (default: 200).
HARVEST_DELAY_MS=200

# How often the Docker harvester service re-runs, in hours (default: 24).
HARVEST_INTERVAL_HOURS=24

# ─── Database restore ─────────────────────────────────────────────────────────
# To restore from a backup on next `docker compose up --build`, set this to the
# filename inside sparql/backup/ (the directory is mounted at /backups).
# Example: RESTORE_FROM=/backups/2024-01-01T12-00-00.ttl
# The following contains one example pairing and two maps for testing; remove or replace with an actual backup for real use.
# Example: RESTORE_FROM=/backups/example_db.ttl
# Leave empty for normal startup.
RESTORE_FROM=