cloudproxy/.env.example at main · claffin/cloudproxy · 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# CloudProxy Environment Configuration Example
# Copy this file to .env and fill in your values

# ====================
# Authentication Settings
# ====================
# Required: Set credentials for proxy authentication (alphanumeric only)
PROXY_USERNAME=changeme
PROXY_PASSWORD=changeme

# Optional: Restrict access to host IP only
# ONLY_HOST_IP=False

# Optional: Proxy age limit in seconds (0 = disabled)
# AGE_LIMIT=0

# ====================
# Rolling Deployment Settings
# ====================
# Optional: Enable rolling deployments for zero-downtime proxy recycling
# ROLLING_DEPLOYMENT=False

# Optional: Minimum number of proxies to keep available during recycling
# ROLLING_MIN_AVAILABLE=3

# Optional: Maximum number of proxies to recycle simultaneously
# ROLLING_BATCH_SIZE=2

# ====================
# DigitalOcean Provider
# ====================
# Enable provider
DIGITALOCEAN_ENABLED=False

# Required if enabled
DIGITALOCEAN_ACCESS_TOKEN=your_digitalocean_token_here

# Optional settings
# DIGITALOCEAN_REGION=lon1
# DIGITALOCEAN_IMAGE=ubuntu-22-04-x64  # User data script tested with Ubuntu images only
# DIGITALOCEAN_MIN_SCALING=2
# DIGITALOCEAN_MAX_SCALING=2
# DIGITALOCEAN_SIZE=s-1vcpu-1gb

# Additional DigitalOcean instance example
# DIGITALOCEAN_NYC_ENABLED=False
# DIGITALOCEAN_NYC_ACCESS_TOKEN=your_second_token_here
# DIGITALOCEAN_NYC_REGION=nyc1
# DIGITALOCEAN_NYC_MIN_SCALING=3
# DIGITALOCEAN_NYC_SIZE=s-1vcpu-1gb
# DIGITALOCEAN_NYC_DISPLAY_NAME=NYC Proxies

# ====================
# AWS Provider
# ====================
# Enable provider
AWS_ENABLED=False

# Required if enabled
AWS_ACCESS_KEY_ID=your_aws_access_key_here
AWS_SECRET_ACCESS_KEY=your_aws_secret_key_here

# Optional settings
# AWS_REGION=eu-west-2
# AWS_MIN_SCALING=2
# AWS_MAX_SCALING=2
# AWS_SIZE=t2.micro
# AWS_AMI=ami-096cb92bb3580c759
# AWS_SPOT=False

# Additional AWS instance example
# AWS_USEAST_ENABLED=False
# AWS_USEAST_ACCESS_KEY_ID=your_second_key_here
# AWS_USEAST_SECRET_ACCESS_KEY=your_second_secret_here
# AWS_USEAST_REGION=us-east-1
# AWS_USEAST_MIN_SCALING=2
# AWS_USEAST_AMI=ami-0c02fb55731490381
# AWS_USEAST_DISPLAY_NAME=US East Proxies

# ====================
# Google Cloud Provider
# ====================
# Enable provider
GCP_ENABLED=False

# Required if enabled
GCP_PROJECT=your_gcp_project_id_here
GCP_SERVICE_ACCOUNT_KEY=your_service_account_json_here

# Optional: Use a JSON file instead
# GCP_SA_JSON=/path/to/service-account.json

# Optional settings
# GCP_ZONE=us-central1-a
# GCP_MIN_SCALING=2
# GCP_MAX_SCALING=2
# GCP_SIZE=f1-micro
# GCP_IMAGE_PROJECT=ubuntu-os-cloud
# GCP_IMAGE_FAMILY=ubuntu-minimal-2004-lts

# Additional GCP instance example
# GCP_EUROPE_ENABLED=False
# GCP_EUROPE_PROJECT=your_project_id_here
# GCP_EUROPE_SERVICE_ACCOUNT_KEY=your_key_here
# GCP_EUROPE_ZONE=europe-west1-b
# GCP_EUROPE_MIN_SCALING=2
# GCP_EUROPE_DISPLAY_NAME=Europe Proxies

# ====================
# Hetzner Provider
# ====================
# Enable provider
HETZNER_ENABLED=False

# Required if enabled
HETZNER_ACCESS_TOKEN=your_hetzner_token_here

# Optional settings
# HETZNER_LOCATION=nbg1
# HETZNER_IMAGE=ubuntu-22.04  # User data script tested with Ubuntu images only
# HETZNER_MIN_SCALING=2
# HETZNER_MAX_SCALING=2
# HETZNER_SIZE=cx21

# Additional Hetzner instance example
# HETZNER_US_ENABLED=False
# HETZNER_US_ACCESS_TOKEN=your_second_token_here
# HETZNER_US_LOCATION=ash
# HETZNER_US_MIN_SCALING=2
# HETZNER_US_SIZE=cx21
# HETZNER_US_DISPLAY_NAME=US Proxies

# ====================
# Vultr Provider
# ====================
# Enable provider
VULTR_ENABLED=False

# Required if enabled
VULTR_API_TOKEN=your_vultr_api_token_here

# Optional settings
# VULTR_REGION=ewr
# VULTR_MIN_SCALING=2
# VULTR_MAX_SCALING=2
# VULTR_PLAN=vc2-1c-1gb
# VULTR_OS_ID=387

# Additional Vultr instance example
# VULTR_EUROPE_ENABLED=False
# VULTR_EUROPE_API_TOKEN=your_second_token_here
# VULTR_EUROPE_REGION=ams
# VULTR_EUROPE_MIN_SCALING=3
# VULTR_EUROPE_PLAN=vc2-1c-1gb
# VULTR_EUROPE_DISPLAY_NAME=Europe Proxies

# Additional Vultr instance for Asia
# VULTR_ASIA_ENABLED=False
# VULTR_ASIA_API_TOKEN=your_third_token_here
# VULTR_ASIA_REGION=sgp
# VULTR_ASIA_MIN_SCALING=2
# VULTR_ASIA_PLAN=vc2-1c-2gb
# VULTR_ASIA_DISPLAY_NAME=Asia Proxies

# ====================
# Azure Provider (Planned)
# ====================
# AZURE_ENABLED=False
# AZURE_SUBSCRIPTION_ID=your_subscription_id_here
# AZURE_CLIENT_ID=your_client_id_here
# AZURE_CLIENT_SECRET=your_client_secret_here
# AZURE_TENANT_ID=your_tenant_id_here
# AZURE_RESOURCE_GROUP=cloudproxy-rg
# AZURE_LOCATION=eastus
# AZURE_MIN_SCALING=2
# AZURE_MAX_SCALING=2
# AZURE_SIZE=Standard_B1s