@@ -65,13 +65,13 @@ spec:
6565 ports :
6666 - containerPort : 8000
6767 env :
68- - name : HF_SERVER_ENABLED
68+ - name : ORB_SERVER_ENABLED
6969 value : " true"
70- - name : HF_AUTH_ENABLED
70+ - name : ORB_AUTH_ENABLED
7171 value : " true"
72- - name : HF_AUTH_STRATEGY
72+ - name : ORB_AUTH_STRATEGY
7373 value : " bearer_token"
74- - name : HF_AUTH_BEARER_SECRET_KEY
74+ - name : ORB_AUTH_BEARER_SECRET_KEY
7575 valueFrom :
7676 secretKeyRef :
7777 name : orb-secrets
@@ -108,7 +108,7 @@ gcloud run deploy orb-api \
108108 --image gcr.io/your-project/orb-api:latest \
109109 --platform managed \
110110 --region us-central1 \
111- --set-env-vars HF_SERVER_ENABLED =true,HF_AUTH_ENABLED =true
111+ --set-env-vars ORB_SERVER_ENABLED =true,ORB_AUTH_ENABLED =true
112112```
113113
114114### [ Server] Traditional Server Deployment
@@ -127,8 +127,11 @@ pip install -e .
127127cp config/default_config.json config/production.json
128128# Edit config/production.json
129129
130- # Start server
131- orb system serve --host 0.0.0.0 --port 8000 --config config/production.json
130+ # Start server (foreground)
131+ orb --config config/production.json server start --foreground --host 0.0.0.0 --port 8000
132+
133+ # Or daemonise (writes a PID file under <work_dir>/server/orb-server.pid)
134+ orb --config config/production.json server start --host 0.0.0.0 --port 8000
132135```
133136
134137#### Systemd Service
@@ -143,9 +146,9 @@ Type=simple
143146User =orb
144147Group =orb
145148WorkingDirectory =/opt/orb
146- Environment =HF_SERVER_ENABLED =true
147- Environment =HF_AUTH_ENABLED =true
148- ExecStart =/opt/orb/.venv/bin/python src/run.py system serve --config config/production.json
149+ Environment =ORB_SERVER_ENABLED =true
150+ Environment =ORB_AUTH_ENABLED =true
151+ ExecStart =/opt/orb/.venv/bin/orb --config config/production.json server start --foreground
149152Restart =always
150153RestartSec =10
151154
@@ -161,38 +164,38 @@ WantedBy=multi-user.target
161164
162165``` bash
163166# Server Configuration
164- HF_SERVER_ENABLED =true
165- HF_SERVER_HOST =0.0.0.0
166- HF_SERVER_PORT =8000
167- HF_SERVER_WORKERS =4
168- HF_SERVER_LOG_LEVEL =info
169- HF_SERVER_DOCS_ENABLED =false # Disable in production
167+ ORB_SERVER_ENABLED =true
168+ ORB_SERVER_HOST =0.0.0.0
169+ ORB_SERVER_PORT =8000
170+ ORB_SERVER_WORKERS =4
171+ ORB_SERVER_LOG_LEVEL =info
172+ ORB_SERVER_DOCS_ENABLED =false # Disable in production
170173
171174# Authentication Configuration
172- HF_AUTH_ENABLED =true
173- HF_AUTH_STRATEGY =bearer_token
174- HF_AUTH_BEARER_SECRET_KEY =your-very-secure-secret-key
175- HF_AUTH_BEARER_TOKEN_EXPIRY =3600
175+ ORB_AUTH_ENABLED =true
176+ ORB_AUTH_STRATEGY =bearer_token
177+ ORB_AUTH_BEARER_SECRET_KEY =your-very-secure-secret-key
178+ ORB_AUTH_BEARER_TOKEN_EXPIRY =3600
176179
177180# AWS Provider Configuration
178- HF_PROVIDER_TYPE =aws
179- HF_PROVIDER_AWS_REGION =us-east-1
181+ ORB_PROVIDER_TYPE =aws
182+ ORB_PROVIDER_AWS_REGION =us-east-1
180183AWS_ACCESS_KEY_ID=your-access-key
181184AWS_SECRET_ACCESS_KEY=your-secret-key
182185
183186# Storage Configuration
184- HF_STORAGE_STRATEGY =json
185- HF_STORAGE_BASE_PATH =/app/data
187+ ORB_STORAGE_STRATEGY =json
188+ ORB_STORAGE_BASE_PATH =/app/data
186189
187190# Logging Configuration
188- HF_LOGGING_LEVEL =INFO
189- HF_LOGGING_CONSOLE_ENABLED =true
190- HF_LOGGING_FILE_ENABLED =true
191- HF_LOGGING_FILE_PATH =/app/logs/app .log
191+ ORB_LOGGING_LEVEL =INFO
192+ ORB_LOGGING_CONSOLE_ENABLED =true
193+ ORB_LOGGING_FILE_ENABLED =true
194+ ORB_LOGGING_FILE_PATH =/app/logs/orb .log
192195
193196# Security Configuration
194- HF_SERVER_REQUIRE_HTTPS =true
195- HF_SERVER_TRUSTED_HOSTS =your-domain.com,api.your-domain.com
197+ ORB_SERVER_REQUIRE_HTTPS =true
198+ ORB_SERVER_TRUSTED_HOSTS =your-domain.com,api.your-domain.com
196199```
197200
198201### Configuration Files
@@ -217,7 +220,7 @@ services:
217220 secrets:
218221 - orb-jwt-secret
219222 environment:
220- HF_AUTH_BEARER_SECRET_KEY_FILE : /run/secrets/orb-jwt-secret
223+ ORB_AUTH_BEARER_SECRET_KEY_FILE : /run/secrets/orb-jwt-secret
221224```
222225
223226#### Kubernetes Secrets
@@ -244,7 +247,7 @@ aws secretsmanager create-secret \
244247{
245248 " secrets " : [
246249 {
247- " name " : " HF_AUTH_BEARER_SECRET_KEY " ,
250+ " name " : " ORB_AUTH_BEARER_SECRET_KEY " ,
248251 " valueFrom " : " arn:aws:secretsmanager:region:account:secret:orb/jwt-secret"
249252 }
250253 ]
@@ -255,11 +258,11 @@ aws secretsmanager create-secret \
255258
256259### Production Security Checklist
257260
258- - [ ] ** Authentication enabled** : ` HF_AUTH_ENABLED =true`
261+ - [ ] ** Authentication enabled** : ` ORB_AUTH_ENABLED =true`
259262- [ ] ** Strong JWT secret** : Use cryptographically secure random key
260- - [ ] ** HTTPS required** : ` HF_SERVER_REQUIRE_HTTPS =true`
263+ - [ ] ** HTTPS required** : ` ORB_SERVER_REQUIRE_HTTPS =true`
261264- [ ] ** Trusted hosts configured** : Limit to your domains
262- - [ ] ** API docs disabled** : ` HF_SERVER_DOCS_ENABLED =false`
265+ - [ ] ** API docs disabled** : ` ORB_SERVER_DOCS_ENABLED =false`
263266- [ ] ** Non-root execution** : Container runs as ` orb ` user
264267- [ ] ** Resource limits** : Set CPU and memory limits
265268- [ ] ** Network isolation** : Use private networks where possible
@@ -323,7 +326,7 @@ livenessProbe:
323326{
324327 "logging" : {
325328 "level" : " INFO" ,
326- "file_path" : " /app/logs/app .log" ,
329+ "file_path" : " /app/logs/orb .log" ,
327330 "console_enabled" : true ,
328331 "file_enabled" : true ,
329332 "max_file_size" : " 50MB" ,
@@ -441,7 +444,7 @@ docker exec -i orb-postgres psql -U orb orb < backup-20250107.sql
441444docker logs container-name
442445
443446# Check configuration
444- docker exec container-name env | grep HF_
447+ docker exec container-name env | grep ORB_
445448
446449# Test configuration
447450docker run --rm -it orb-api:latest bash
@@ -456,7 +459,7 @@ docker stats
456459curl http://localhost:8000/metrics
457460
458461# Increase workers
459- docker run -e HF_SERVER_WORKERS =4 orb-api:latest
462+ docker run -e ORB_SERVER_WORKERS =4 orb-api:latest
460463```
461464
462465** Authentication problems:**
@@ -476,7 +479,7 @@ print(config.get_typed(ServerConfig).auth.enabled)
476479
477480``` bash
478481# Enable debug mode
479- docker run -e HF_DEBUG =true -e HF_LOGGING_LEVEL =DEBUG orb-api:latest
482+ docker run -e ORB_DEBUG =true -e ORB_LOGGING_LEVEL =DEBUG orb-api:latest
480483
481484# Interactive debugging
482485docker run -it --rm orb-api:latest bash
@@ -501,11 +504,11 @@ resources:
501504
502505` ` ` bash
503506# Increase worker processes
504- HF_SERVER_WORKERS =4
507+ ORB_SERVER_WORKERS =4
505508
506509# Optimize for high concurrency
507- HF_SERVER_WORKER_CLASS =uvicorn.workers.UvicornWorker
508- HF_SERVER_WORKER_CONNECTIONS =1000
510+ ORB_SERVER_WORKER_CLASS =uvicorn.workers.UvicornWorker
511+ ORB_SERVER_WORKER_CONNECTIONS =1000
509512```
510513
511514## Migration Guide
0 commit comments