Skip to content

Automate browser based workflows with AI

update README and docker compose (#1044)

LawyZhenga0348e03c42b
diff --git a/README.md b/README.md
index 69b836e85..223fb3a62 100644
--- a/README.md
+++ b/README.md
@@ -90,7 +90,7 @@ This quickstart guide will walk you through getting Skyvern up and running on yo
1. Make sure you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed and running on your machine
1. Make sure you don't have postgres running locally (Run `docker ps` to check)
1. Clone the repository and navigate to the root directory
-1. Fill in the LLM provider key on the [docker-compose.yml](./docker-compose.yml)
+1. Fill in the LLM provider key on the [docker-compose.yml](./docker-compose.yml). *If you want to run skyvern on a remote server, make sure you set the correct server ip for the UI container in [docker-compose.yml](./docker-compose.yml).*
2. Run the following command via the commandline:
```bash
docker compose up -d
@@ -101,6 +101,7 @@ This quickstart guide will walk you through getting Skyvern up and running on yo
## Full Setup (Contributors) - Prerequisites
### :warning: :warning: MAKE SURE YOU ARE USING PYTHON 3.11 :warning: :warning:
+:warning: :warning: only well-tested on MacOS :warning: :warning:
Before you begin, make sure you have the following installed:
- [Brew (if you're on a Mac)](https://brew.sh/)
diff --git a/docker-compose.yml b/docker-compose.yml
index 3d1a16eed..f33031846 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -67,8 +67,10 @@ services:
- ./har:/data/har
- ./.streamlit:/app/.streamlit
environment:
+ # if you want to run skyvern on a remote server,
+ # you need to change the host in VITE_WSS_BASE_URL and VITE_API_BASE_URL to match your server ip
- VITE_WSS_BASE_URL=ws://localhost:8000/api/v1
- # - VITE_API_BASE_URL=
+ # - VITE_API_BASE_URL=http://localhost:8000/api/v1
# - VITE_SKYVERN_API_KEY=
depends_on:
skyvern: