How to run SimpleTool Server on your machine in minutes
There are three main ways to run SimpleTool Server:
The Docker Compose setup provides a fully configured container with:
All 3 elements are initialized and run in a single container using supervisord
.
You can check status of each element by running:
Clone the repository ๐ฅ
Configure environment variables (optional) โ๏ธ
The default configuration in docker-compose.yaml
works out of the box, but you can modify any of these settings:
use allready build image from ghcr.io if you dont whant to use Dockerfile
:
Start the server ๐
Access the server ๐
vncpassword
)ssh -p 2222 appuser@localhost
(password: appuser
)If you need more control over your Docker container or donโt want to use Docker Compose, you can use the Docker CLI directly.
Pull the image from GHCR ๐ฅ
Run the container ๐
Clone the repository ๐ฅ
Build the Docker image ๐จ
Run the container ๐
vncpassword
)ssh -p 2222 appuser@localhost
(password: appuser
)Running directly with Python is ideal for development, debugging, or when you donโt need the full container with desktop environment.
Clone the repository ๐ฅ
Set up Python environment ๐ ๏ธ
Configure environment variables (optional) โ๏ธ
Create a .env
file in the src/server
directory:
Run the server ๐
Or use the convenience script:
Access the server ๐
To verify that the server is running correctly, check these endpoints:
Health check ๐ฉบ
Ping test ๐
View available tools ๐ง
Probably will be empty, because we dont have any tools yet.
Once your server is running:
/docs
to explore API endpoints/tools/openapi.json
(and this path you can use as tools
for OpenWebUI
)/sse
for real-time communication