planx-new/.env.example at main · theopensystemslab/planx-new · 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
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# Please see https://github.com/theopensystemslab/planx-new/blob/main/doc/architecture/decisions/0004-secret-generation.md for procedure on secrets generation

# Uncomment if you're on Apple Silicon
# DOCKER_DEFAULT_PLATFORM=linux/arm64

# Used by docker-compose in local development and pull request (aka pizza) environments

# API
API_PORT=7002
API_URL_EXT=http://localhost:${API_PORT}
ENCRYPTION_KEY=👻

# JWT_SECRET must be at least 32 characters
JWT_SECRET=👻

SESSION_SECRET=👻

# Google Cloud OAuth 2.0 Client ID
GOOGLE_CLIENT_ID=👻
GOOGLE_CLIENT_SECRET=👻

# Microsoft Azure OIDC credentials
MICROSOFT_CLIENT_ID=👻
MICROSOFT_CLIENT_SECRET=👻

# AWS credentials for uploading user files from local and pull request environments to a staging S3 bucket
AWS_S3_REGION=eu-west-2
AWS_S3_BUCKET=👻
AWS_ACCESS_KEY=👻
AWS_SECRET_KEY=👻

# Vultr API key for pizzas to handle DNS challenge
VULTR_API_KEY=👻

# Vultr container registry credentials
VULTR_CR_URN=lhr.vultrcr.com/planx
VULTR_CR_ID=👻
VULTR_CR_API_KEY=👻

# User-uploaded S3 files require token-based access (token is used internally and shared with BOPS; local and pull request environments use the staging token)
FILE_API_KEY=👻
FILE_API_KEY_BARNET=👻
FILE_API_KEY_CAMDEN=👻
FILE_API_KEY_DONCASTER=👻
FILE_API_KEY_EPSOM_EWELL=👻
FILE_API_KEY_GATESHEAD=👻
FILE_API_KEY_GLOUCESTER=👻
FILE_API_KEY_LAMBETH=👻
FILE_API_KEY_MEDWAY=👻
FILE_API_KEY_NEXUS=👻
FILE_API_KEY_SOUTHWARK=👻
FILE_API_KEY_TEWKESBURY=👻

# Used to circumvent API rate limiting for development purposes (e.g. load testing)
SKIP_RATE_LIMIT_SECRET=👻

# Editor
EDITOR_URL_EXT=http://localhost:3000

# LocalPlanning.services
LPS_PORT=4321
LPS_URL_EXT=http://localhost:${LPS_PORT}

# Hasura
HASURA_GRAPHQL_ADMIN_SECRET=👻
HASURA_PROXY_PORT=7100
HASURA_GRAPHQL_URL=http://localhost:${HASURA_PROXY_PORT}/v1/graphql
HASURA_CONSOLE_PORT=9695

# Hasura Metadata API
HASURA_PLANX_API_URL=http://api:${API_PORT}
HASURA_PLANX_API_KEY=👻

# Hasura Events send messages to #planx-notifications channel
SLACK_WEBHOOK_URL=👻

# Metabase analytics
METABASE_PORT=5000
METABASE_API_KEY=👻
METABASE_URL_EXT=http://localhost:${METABASE_PORT}

# Minio object storage server
MINIO_PORT=9000
MINIO_ADMIN_PORT=9001

# PostgreSQL
PG_PORT=7001
PG_DATABASE=planxdb
PG_USERNAME=dbuser
PG_PASSWORD=👻

# PG user with permission to sync content between environments
PRODUCTION_PG_URL_FOR_USER_GITHUB_ACTIONS=👻

# ShareDB
SHAREDB_PORT=7003

# Integrations (local and pull request environments point to third party staging environments)
GOVUK_NOTIFY_API_KEY=👻

UNIFORM_TOKEN_URL=👻
UNIFORM_SUBMISSION_URL=👻

ORDNANCE_SURVEY_API_KEY=👻

# Data retention policy
RETENTION_PERIOD_MONTHS=6;

# E2E mock server
E2E_MOCK_SERVER_PORT=11111
E2E_MOCK_SERVER=http://localhost:${E2E_MOCK_SERVER_PORT}
E2E_MOCK_SERVER_INTERFACE_PORT=11112
E2E_MOCK_SERVER_INTERFACE=http://localhost:${E2E_MOCK_SERVER_INTERFACE_PORT}

# Set this if you want to hide debug output locally
SUPPRESS_LOGS=true

# Local authority specific integrations
UNIFORM_CLIENT_LAMBETH=👻
UNIFORM_CLIENT_SOUTHWARK=👻
UNIFORM_CLIENT_BUCKINGHAMSHIRE=👻

## Forthcoming Idox Nexus integration
IDOX_NEXUS_CLIENT=👻
IDOX_NEXUS_TOKEN_URL=👻
IDOX_NEXUS_SUBMISSION_URL=👻

## End-to-end test team (borrows Lambeth's details)
GOV_UK_PAY_SECRET_E2E=👻
UNIFORM_CLIENT_E2E=👻

# Vercel AI Gateway
AI_GATEWAY_API_KEY=👻