pull/814/merge
Shawn Tian 3 months ago committed by GitHub
commit 3f550e105f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -163,6 +163,10 @@ For more documentation on the CLI [CLICK HERE](https://docs.swarms.world/en/late
--- ---
## TEE
Head to the [TEE README](./tee/README.md) for more detailed instructions.
# Usage Examples 🤖 # Usage Examples 🤖
Here are some example scripts to get you started. For more comprehensive documentation, visit our [docs](https://docs.swarms.world/en/latest/). Here are some example scripts to get you started. For more comprehensive documentation, visit our [docs](https://docs.swarms.world/en/latest/).

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 831 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 352 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 844 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 346 KiB

@ -6,7 +6,7 @@ This guide will walk you through deploying your project to Phala's Trusted Execu
- Docker installed on your system - Docker installed on your system
- A DockerHub account - A DockerHub account
- Access to Phala Cloud dashboard - Register a [Phala Cloud](https://cloud.phala.network/) account
## 🛡️ TEE Overview ## 🛡️ TEE Overview
@ -14,55 +14,80 @@ For detailed instructions about Trusted Execution Environment setup, please refe
## 🚀 Deployment Steps ## 🚀 Deployment Steps
### 1. Build and Publish Docker Image ### 1. Configure Your Environment
```bash First, prepare your `docker-compose.yaml` file. You can find an example in [docker-compose.yaml](./docker-compose.yaml). Make sure to have your OpenAI API key ready.
# Build the Docker image
docker compose build -t <your-dockerhub-username>/swarm-agent-node:latest
# Push to DockerHub
docker push <your-dockerhub-username>/swarm-agent-node:latest
```
### 2. Deploy to Phala Cloud
Choose one of these deployment methods:
- Use [tee-cloud-cli](https://github.com/Phala-Network/tee-cloud-cli) (Recommended)
- Deploy manually via the [Phala Cloud Dashboard](https://cloud.phala.network/)
### 3. Verify TEE Attestation
Visit the [TEE Attestation Explorer](https://proof.t16z.com/) to check and verify your agent's TEE proof.
## 📝 Docker Configuration
Below is a sample Docker Compose configuration for your Swarms agent:
```yaml ```yaml
services: services:
swarms-agent-server: swarms-agent-server:
image: swarms-agent-node:latest image: python:3.12-slim
platform: linux/amd64
volumes: volumes:
- /var/run/tappd.sock:/var/run/tappd.sock
- swarms:/app - swarms:/app
restart: always restart: always
ports: environment:
- 8000:8000 - OPENAI_API_KEY=${OPENAI_API_KEY}
command: # Sample MCP Server command: # Run swarms agent example
- /bin/sh - /bin/sh
- -c - -c
- | - |
cd /app/mcp_example # install dependencies
python mcp_test.py apt update && apt install -y git python3-pip
mkdir -p /app && cd /app
git clone --depth 1 https://github.com/The-Swarm-Corporation/swarms-examples
cd swarms-examples/
pip install -r requirements.txt && pip install langchain-community langchain-core
cd examples/agents/
python o1_preview.py
# keep container running
sleep infinity
volumes: volumes:
swarms: swarms:
``` ```
## 📚 Additional Resources ### 2. Deploy to Phala Cloud
For more comprehensive documentation and examples, visit our [Official Documentation](https://docs.swarms.world/en/latest/). Choose one of these deployment methods:
- Use [tee-cloud-cli](https://github.com/Phala-Network/tee-cloud-cli) (Recommended)
- Deploy manually via the [Phala Cloud Dashboard](https://cloud.phala.network/)
1. Click `Deploy` button on the Phala Cloud dashboard.
2. Choose `docker-compose.yaml` and then click `Advanced` tab to paste the content of your docker-compose.yaml file.
3. Importantly, make sure to add the `OPENAI_API_KEY` in the `Encrypted Secrets` section with your own OpenAI API key.
4. Click `Create` button to create a new Swarms agent application.
<p align="center">
<img src="./imgs/01_create_agent_on_phala_cloud.png" alt="Creating a Swarms agent on Phala Cloud" style="width: 700px;">
</p>
### 3. Monitor Your Deployment
1. Check the initialization logs of your agent
<p align="center">
<img src="./imgs/02_serial_logs.png" alt="Agent initialization logs" style="width: 700px;">
<img src="./imgs/03_serial_logs.png" alt="Detailed initialization logs" style="width: 700px;">
</p>
2. Verify your container is running
<p align="center">
<img src="./imgs/04_swarms_agent_containers.png" alt="Swarms Agent Container Status" style="width: 700px;">
</p>
3. Monitor your agent's output
<p align="center">
<img src="./imgs/05_agent_output.png" alt="Swarms Agent Logs" style="width: 700px;">
</p>
### 4. Verify TEE Attestation
Visit the [TEE Attestation Explorer](https://proof.t16z.com/) to check and verify your agent's TEE proof.
--- <p align="center">
<img src="./imgs/06_attestation.png" alt="TEE Attestation Verification" style="width: 700px;">
</p>
> **Note**: Make sure to replace `<your-dockerhub-username>` with your actual DockerHub username when building and pushing the image. ## 📚 Additional Resources
For more comprehensive documentation and examples, visit our [Official Documentation](https://docs.swarms.world/en/latest/).

@ -0,0 +1,90 @@
# Running Swarms Agent in Phala TEE
Welcome! This guide will walk you through running your Swarms Agent in a Trusted Execution Environment (TEE) using Phala Cloud. This setup ensures your agent runs in a secure, isolated environment.
## 📋 Prerequisites
- A Swarms Agent code repository (or docker image)
- A Phala Cloud account
- An OpenAI API key
## 📝 Step-by-Step Guide
Firstly, you need to register a [Phala Cloud](https://cloud.phala.network/) account before you can create a new Swarms agent application.
### 1. ⚙️ Configure Your Environment
First, prepare your `docker-compose.yaml` file. You can find an example in [docker-compose.yaml](./docker-compose.yaml). Make sure to have your OpenAI API key ready.
```yaml
services:
swarms-agent-server:
image: python:3.12-slim
volumes:
- swarms:/app
restart: always
environment:
- OPENAI_API_KEY=${OPENAI_API_KEY}
command: # Run swarms agent example
- /bin/sh
- -c
- |
# install dependencies
apt update && apt install -y git python3-pip
mkdir -p /app && cd /app
git clone --depth 1 https://github.com/The-Swarm-Corporation/swarms-examples
cd swarms-examples/
pip install -r requirements.txt && pip install langchain-community langchain-core
cd examples/agents/
python o1_preview.py
# keep container running
sleep infinity
volumes:
swarms:
```
### 2. 🚀 Deploy Your Agent
1. Navigate to the [Phala Cloud dashboard](https://cloud.phala.network/dashboard)
2. Click `Deploy` button on the Phala Cloud dashboard.
3. Choose `docker-compose.yaml` and then click `Advanced` tab to paste the content of your docker-compose.yaml file.
4. Importantly, make sure to add the `OPENAI_API_KEY` in the `Encrypted Secrets` section with your own OpenAI API key.
5. Click `Create` button to create a new Swarms agent application.
<p align="center">
<img src="../docs/swarms_cloud/imgs/01_create_agent_on_phala_cloud.png" alt="Creating a Swarms agent on Phala Cloud" style="width: 700px;">
</p>
### 3. 📊 Monitor Your Deployment
1. Check the initialization logs of your agent
<p align="center">
<img src="../docs/swarms_cloud/imgs/02_serial_logs.png" alt="Agent initialization logs" style="width: 700px;">
<img src="../docs/swarms_cloud/imgs/03_serial_logs.png" alt="Detailed initialization logs" style="width: 700px;">
</p>
2. Verify your container is running
<p align="center">
<img src="../docs/swarms_cloud/imgs/04_swarms_agent_containers.png" alt="Swarms Agent Container Status" style="width: 700px;">
</p>
3. Monitor your agent's output
<p align="center">
<img src="../docs/swarms_cloud/imgs/05_agent_output.png" alt="Swarms Agent Logs" style="width: 700px;">
</p>
### 4. ✅ Verify TEE Attestation
Ensure your agent is running in a secure TEE environment by checking the attestation proof on the [TEE Attestation Explorer](https://proof.t16z.com/).
<p align="center">
<img src="../docs/swarms_cloud/imgs/06_attestation.png" alt="TEE Attestation Verification" style="width: 700px;">
</p>
## 🎉 Success!
You've successfully deployed your Swarms Agent in a secure TEE environment using Phala Cloud. Your agent is now running in an isolated, trusted execution environment, ensuring enhanced security for your AI operations.
If you have any questions, please reach out to Phala on [Phala Cloud](https://cloud.phala.network/).

@ -0,0 +1,27 @@
services:
swarms-agent-server:
image: python:3.12-slim
volumes:
- swarms:/app
restart: always
environment:
- OPENAI_API_KEY=${OPENAI_API_KEY}
command: # Run swarms agent example
- /bin/sh
- -c
- |
# install dependencies
apt update && apt install -y git python3-pip
mkdir -p /app && cd /app
git clone --depth 1 https://github.com/The-Swarm-Corporation/swarms-examples
cd swarms-examples/
pip install -r requirements.txt && pip install langchain-community langchain-core
cd examples/agents/
python o1_preview.py
# keep container running
sleep infinity
volumes:
swarms:
Loading…
Cancel
Save