Skip to content

Commit 517c47e

Browse files
committed
Add supported OSes, and a short re-requisites list at the bottom.
1 parent a7340d8 commit 517c47e

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

MyApp/_pages/ai-server/index.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ To get started with AI Server, we need can use the following steps:
88
- **Clone the Repository**: Clone the AI Server repository from GitHub.
99
- **Run the Installer**: Run the `install.sh` to set up the AI Server and ComfyUI Agent.
1010

11+
### Supported OS
12+
13+
The AI Server installer is supported on Linux, macOS, and Windows with WSL2, and all require Docker and Docker Compose to be installed at a minimum.
14+
1115
### Quick Start Commands
1216

1317
```sh
@@ -54,7 +58,47 @@ Providing your AI Server URL and Auth Secret when prompted will automatically re
5458

5559
:::info
5660
You will be prompted to provide the AI Server URL and ComfyUI Agent URL during the installation.
57-
These should be the accessible URLs for your AI Server and ComfyUI Agent. When running locally, the ComfyUI Agent will be populated with a docker accessible path as localhost won't be accessible from the AI Server container.
61+
These should be the accessible URLs for your AI Server and ComfyUI Agent. When running locally, the ComfyUI Agent will be populated with a docker accessible path as `localhost` won't be accessible from the AI Server container.
5862
If you want to reset the ComfyUI Agent settings, remember to remove the provider from the AI Server Admin Portal.
5963
:::
6064

65+
### Prerequisites AI Server - Windows with WSL2
66+
67+
Windows with WSL2 requires the following prerequisites:
68+
69+
- Docker Engine accessible from WSL2 like [Docker Desktop](https://www.docker.com/products/docker-desktop)
70+
- WSL2 with Ubuntu 20.04 LTS or later
71+
72+
### Prerequisites ComfyUI Agent - Windows with WSL2
73+
74+
To run the ComfyUI Agent locally, you will also need:
75+
76+
- Nvidia GPU with [WSL2 CUDA support](https://docs.nvidia.com/cuda/wsl-user-guide/index.html)
77+
78+
### Prerequisites AI Server - macOS
79+
80+
macOS requires the following prerequisites:
81+
82+
- Docker Engine
83+
- Docker Compose
84+
85+
:::info
86+
ComfyUI Agent will likely not run on macOS as it requires Nvidia GPU with CUDA support.
87+
:::
88+
89+
### Prerequisites AI Server - Linux
90+
91+
Linux requires the following prerequisites:
92+
93+
- Docker Engine
94+
- Docker Compose
95+
- Git
96+
97+
### Prerequisites ComfyUI Agent - Linux
98+
99+
To run the ComfyUI Agent locally, you will also need:
100+
101+
- Nvidia GPU with CUDA support
102+
- Nvidia Container Toolkit for [Docker](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html)
103+
104+

0 commit comments

Comments
 (0)