Skip to content

Commit 5aa306e

Browse files
committed
fix(readme): update readme and example env
1 parent e018ff1 commit 5aa306e

File tree

2 files changed

+35
-17
lines changed

2 files changed

+35
-17
lines changed

.env.example

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
# Local variables
2-
GEMINI_API_KEY=YOUR_API_KEY
2+
GEMINI_API_KEY=YOUR_GEMINI_API_KEY
33
TUNED_MODEL_NAME=pugo-hilion
4+
45
# Tuning parameters
56
TUNING_SOURCE_MODEL=models/gemini-1.5-flash-001-tuning
67
TUNING_EPOCH_COUNT=100
78
TUNING_BATCH_SIZE=4
89
TUNING_LEARNING_RATE=0.001
9-
# X API (optional)
10-
X_API_KEY=YOUR_API_KEY
11-
X_API_KEY_SECRET=YOUR_API_KEY_SECRET
12-
X_BEARER_TOKEN=YOUR_BEARER_TOKEN
13-
X_ACCESS_TOKEN=YOUR_ACCESS_TOKEN
14-
X_ACCESS_TOKEN_SECRET=YOUR_ACCESS_TOKEN_SECRET
10+
1511
# For TEE deployment only
16-
TEE_IMAGE_REFERENCE=ghcr.io/flare-foundation/flare-ai-defai:main
17-
INSTANCE_NAME=PROJECT_NAME-TEAM-_NAME
12+
TEE_IMAGE_REFERENCE=ghcr.io/YOUR_REPO_IMAGE:main
13+
INSTANCE_NAME=PROJECT_NAME-TEAM-_NAME
14+
15+
# X API (optional)
16+
X_API_KEY=YOUR_X_API_KEY
17+
X_API_KEY_SECRET=YOUR_X_API_KEY_SECRET
18+
X_BEARER_TOKEN=YOUR_X_BEARER_TOKEN
19+
X_ACCESS_TOKEN=YOUR_X_ACCESS_TOKEN
20+
X_ACCESS_TOKEN_SECRET=YOUR_X_ACCESS_TOKEN_SECRET

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Deploy Flare AI DeFAI on a Confidential Space Instances (using AMD SEV or Intel
8585
Update your `.env` file with:
8686

8787
```bash
88-
TEE_IMAGE_REFERENCE=ghcr.io/flare-foundation/flare-ai-social:main # Replace with your repo build image
88+
TEE_IMAGE_REFERENCE=ghcr.io/flare-foundation/flare-ai-defai:main # Replace with your repo build image
8989
INSTANCE_NAME=<PROJECT_NAME-TEAM_NAME>
9090
```
9191

@@ -101,25 +101,23 @@ Deploy Flare AI DeFAI on a Confidential Space Instances (using AMD SEV or Intel
101101

102102
```bash
103103
echo $TEE_IMAGE_REFERENCE
104-
# Expected output: ghcr.io/flare-foundation/flare-ai-social:main
104+
# Expected output: ghcr.io/YOUR_REPO_IMAGE:main
105105
```
106106

107107
### Deploying to Confidential Space
108108

109-
For deployment on Confidential Space (AMD SEV):
109+
For deployment on Confidential Space (AMD SEV TEE):
110110

111111
```bash
112112
gcloud compute instances create $INSTANCE_NAME \
113113
--project=verifiable-ai-hackathon \
114-
--zone=us-central1-c \
114+
--zone=us-central1-a \
115115
--machine-type=n2d-standard-2 \
116116
--network-interface=network-tier=PREMIUM,nic-type=GVNIC,stack-type=IPV4_ONLY,subnet=default \
117117
--metadata=tee-image-reference=$TEE_IMAGE_REFERENCE,\
118118
tee-container-log-redirect=true,\
119119
tee-env-GEMINI_API_KEY=$GEMINI_API_KEY,\
120-
tee-env-GEMINI_MODEL=$GEMINI_MODEL,\
121-
tee-env-WEB3_PROVIDER_URL=$WEB3_PROVIDER_URL,\
122-
tee-env-SIMULATE_ATTESTATION=false \
120+
tee-env-TUNED_MODEL_NAME=$TUNED_MODEL_NAME,\
123121
--maintenance-policy=MIGRATE \
124122
--provisioning-model=STANDARD \
125123
--service-account=confidential-sa@verifiable-ai-hackathon.iam.gserviceaccount.com \
@@ -150,10 +148,27 @@ social-team1 us-central1-c n2d-standard-2 10.128.0.18 34.41.12
150148
```
151149

152150
It may take a few minutes for Confidential Space to complete startup checks.
153-
You can monitor progress via the [GCP Console](https://console.cloud.google.com/welcome?project=verifiable-ai-hackathon) by clicking **Serial port 1 (console)**. When you see a message like:
151+
You can monitor progress via the [GCP Console](https://console.cloud.google.com/welcome?project=verifiable-ai-hackathon) by clicking **Serial port 1 (console)**.
152+
When you see a message like:
154153

155154
```plaintext
156155
INFO: Uvicorn running on http://0.0.0.0:8080 (Press CTRL+C to quit)
157156
```
158157

159158
the container is ready. Navigate to the external IP of the instance (visible in the GCP Console) to access the Chat UI.
159+
160+
### 🔧 Troubleshooting
161+
162+
If you encounter issues, follow these steps:
163+
164+
1. **Check Logs:**
165+
166+
```bash
167+
gcloud compute instances get-serial-port-output $INSTANCE_NAME --project=verifiable-ai-hackathon
168+
```
169+
170+
2. **Verify API Key(s):**
171+
Ensure that all API Keys are set correctly (e.g. `GEMINI_API_KEY`).
172+
173+
3. **Check Firewall Settings:**
174+
Confirm that your instance is publicly accessible on port `80`.

0 commit comments

Comments
 (0)