Easy server setup with docker.

agi · agi · commit 165805bf9fce · 2025-10-28T18:33:12.000Z
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,31 @@
+# Git
+.git
+.gitignore
+
+# Documentation
+README.md
+LICENSE
+
+# Docker files
+Dockerfile
+.dockerignore
+
+# IDE files
+.vscode
+.idea
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Temporary files
+*.tmp
+*.log
+
+# Test files
+*_test.go
+test/
+tests/
+
+# Assets that are already copied during build
+assets/demos/
diff --git a/DOCKER_README.md b/DOCKER_README.md
@@ -0,0 +1,170 @@
+# Docker Setup for Useless-Agent
+
+This document explains how to build and run the useless-agent application using Docker.
+
+## Prerequisites
+
+- Docker installed on your system
+- Docker Compose (optional, but recommended)
+- An API key for your preferred LLM provider (DeepSeek or Z.AI)
+
+## Building the Docker Image
+
+### Option 1: Using Docker Compose (Recommended)
+
+1. Update the `docker-compose.yml` file with your API key:
+   ```yaml
+   environment:
+     - API_KEY=your_actual_api_key_here
+   ```
+
+2. Build and run the container:
+   ```bash
+   docker compose up --build
+   ```
+
+### Option 2: Using Docker directly
+
+1. Build the image:
+   ```bash
+   docker build -t useless-agent .
+   ```
+
+2. Run the container:
+   ```bash
+   docker run -d \
+     --name useless-agent-server \
+     -p 8080:8080 \
+     -e PROVIDER=deepseek \
+     -e BASE_URL=https://api.deepseek.com/v1 \
+     -e API_KEY=your_actual_api_key_here \
+     -e MODEL=deepseek-chat \
+     -e IP=0.0.0.0 \
+     -e PORT=8080 \
+     -e DISPLAY=:1 \
+     useless-agent
+   ```
+
+## Configuration
+
+The container can be configured using the following environment variables:
+
+### LLM Provider Configuration
+
+- `PROVIDER`: The LLM provider to use (`deepseek` or `zai`)
+- `BASE_URL`: The API base URL for your provider
+- `API_KEY`: Your API key for the provider
+- `MODEL`: The model to use (e.g., `deepseek-chat`, `glm-4.5-air`)
+
+### Server Configuration
+
+- `IP`: The IP address to bind to (default: `0.0.0.0`)
+- `PORT`: The port to listen on (default: `8080`)
+- `DISPLAY`: The X11 display (default: `:1`)
+
+## Accessing the Application
+
+### Finding the Container IP
+
+To get the IP address of the running container:
+
+```bash
+# Method 1: Using docker inspect
+docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' useless-agent-server
+
+# Method 2: Using docker exec
+docker exec useless-agent-server hostname -I
+
+# Method 3: If running on Docker Desktop (Mac/Windows), use localhost
+# The container is accessible via localhost:8080
+```
+
+### Connecting to the Application
+
+1. Once the container is running, open `main.html` in your web browser
+2. Enter the IP address obtained from the commands above
+   - If running Docker on Linux: Use the container IP from the commands above
+   - If running Docker Desktop on Mac/Windows: Use `localhost` or `127.0.0.1`
+3. Click "Connect" to establish a connection
+4. Start giving tasks to the agent through the LLM Chat interface
+
+## Example Usage
+
+### Using DeepSeek
+
+```bash
+docker run -d \
+  --name useless-agent-server \
+  -p 8080:8080 \
+  -e PROVIDER=deepseek \
+  -e BASE_URL=https://api.deepseek.com/v1 \
+  -e API_KEY=your_deepseek_api_key \
+  -e MODEL=deepseek-chat \
+  useless-agent
+```
+
+### Using Z.AI
+
+```bash
+docker run -d \
+  --name useless-agent-server \
+  -p 8080:8080 \
+  -e PROVIDER=zai \
+  -e BASE_URL=https://api.z.ai/api/paas/v4 \
+  -e API_KEY=your_zai_api_key \
+  -e MODEL=glm-4.5-air \
+  useless-agent
+```
+
+## Troubleshooting
+
+### Viewing Logs
+
+To view the logs of the running container:
+
+```bash
+docker logs useless-agent-server
+```
+
+Or with Docker Compose:
+
+```bash
+docker compose logs -f
+```
+
+### Stopping the Container
+
+To stop the container:
+
+```bash
+docker stop useless-agent-server
+```
+
+Or with Docker Compose:
+
+```bash
+docker compose down
+```
+
+### Rebuilding the Image
+
+If you make changes to the source code, you'll need to rebuild the image:
+
+```bash
+docker compose build --no-cache
+```
+
+Or with Docker:
+
+```bash
+docker build --no-cache -t useless-agent .
+```
+
+## Notes
+
+- The container includes Xvfb (X Virtual Framebuffer) and XFCE4 desktop environment
+- Tesseract OCR is installed for text recognition capabilities
+- The application runs on port 8080 inside the container
+- The Go binary is compiled during the build process and installed to `/app/useless-agent`
+- The container uses a simple startup script to manage Xvfb and XFCE processes
+- No special privileges are required to run this container
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,99 @@
+FROM ubuntu:22.04
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV DISPLAY=:1
+
+RUN apt-get update && apt-get install -y \
+    curl \
+    wget \
+    gnupg \
+    software-properties-common \
+    ca-certificates \
+    build-essential \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Go 1.25.2 (matching the go.mod requirement)
+RUN wget -O go.tar.gz https://go.dev/dl/go1.25.2.linux-amd64.tar.gz \
+    && tar -C /usr/local -xzf go.tar.gz \
+    && rm go.tar.gz
+
+# Set Go environment variables
+ENV PATH=$PATH:/usr/local/go/bin
+ENV GOPATH=/go
+ENV PATH=$PATH:$GOPATH/bin
+
+# Add PPA for tesseract-ocr5 and install X11, XFCE, and other dependencies
+RUN apt-get update && apt-get install -y \
+    software-properties-common \
+    && add-apt-repository -y ppa:alex-p/tesseract-ocr5 \
+    && apt-get update \
+    && apt-get install -y \
+    xvfb \
+    x11-utils \
+    x11-xserver-utils \
+    xfce4 \
+    xfce4-terminal \
+    tesseract-ocr \
+    tesseract-ocr-eng \
+    libtesseract5 \
+    libleptonica-dev \
+    libtesseract-dev \
+    libx11-dev \
+    libxrandr-dev \
+    libxtst-dev \
+    libxi-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Remove xfce4-screensaver
+RUN apt-get remove -y xfce4-screensaver && apt-get autoremove -y
+
+# Create application directory
+WORKDIR /app
+
+# Copy the Go module files
+COPY go.mod go.sum ./
+
+# Copy the entire source code
+COPY . .
+
+# Build the Go application
+RUN go mod download
+RUN go build -o useless-agent .
+
+# Create a startup script
+RUN echo '#!/bin/bash\n\
+# Start Xvfb in background\n\
+Xvfb :1 -screen 0 1920x1080x24 &\n\
+XVFB_PID=$!\n\
+\n\
+# Wait for Xvfb to start\n\
+sleep 3\n\
+\n\
+# Start XFCE in background\n\
+DISPLAY=:1 startxfce4 &\n\
+XFCE_PID=$!\n\
+\n\
+# Wait for XFCE to start\n\
+sleep 5\n\
+\n\
+# Function to cleanup background processes\n\
+cleanup() {\n\
+    echo "Cleaning up..."\n\
+    kill $XVFB_PID 2>/dev/null\n\
+    kill $XFCE_PID 2>/dev/null\n\
+    exit 0\n\
+}\n\
+\n\
+# Set trap to cleanup on exit\n\
+trap cleanup SIGTERM SIGINT\n\
+\n\
+# Start the useless-agent application\n\
+./useless-agent --provider=${PROVIDER:-deepseek} --base-url="${BASE_URL:-https://api.deepseek.com/v1}" --key="${API_KEY}" --model="${MODEL:-deepseek-chat}" --display=:1 --ip=${IP:-0.0.0.0} --port=${PORT:-8080}' > /app/start.sh && \
+chmod +x /app/start.sh
+
+# Expose the application port
+EXPOSE 8080
+
+# Set the entrypoint
+ENTRYPOINT ["/app/start.sh"]
diff --git a/README.md b/README.md
@@ -95,19 +95,36 @@ https://github.com/user-attachments/assets/370bdd7e-0955-4b1e-8e81-8ee3eb913e90
 
 
 ### How to build:
+
+**The easiest way:**
+```bash
+docker compose up --build
+```
+
+For more information, see [DOCKER_README.md](DOCKER_README.md).
+
+> [!WARNING]
+> Docker is not a sufficient level of isolation and it is risky.
+
+**or manually:**
 * `git clone`
 * `cd useless-agent`
 * `go build`
 
 ### How to prepare headless vm:
 Scripts - "assets/scripts"
 ```bash
-sudo apt update && sudo apt install -y \
+sudo apt update && sudo add-apt-repository ppa:alex-p/tesseract-ocr5 && sudo apt install -y \
   xfce4 xvfb tesseract-ocr-eng tesseract-ocr libtesseract5 libleptonica-dev libtesseract-dev
 sudo apt remove -y xfce4-screensaver
 sudo systemctl enable --now xvfb.service xfce4.service
 ```
 
+### How to establish a secure tunnel between client and remote server:
+```bash
+ssh -p 22 -fN -o IPQoS=ef USERNAME@REMOTE-HOST-PUBLIC-IP -L 127.0.0.1:8080:127.0.0.1:8080
+```
+
 ### How to use:
 `copy executable to the target machine`
 
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,18 @@
+services:
+  useless-agent:
+    build: .
+    container_name: useless-agent-server
+    ports:
+      - "8080:8080"
+    environment:
+      # LLM Provider Configuration
+      - PROVIDER=deepseek  # or zai
+      - BASE_URL=https://api.deepseek.com/v1  # or https://api.z.ai/api/paas/v4
+      - API_KEY=YOUR_API_KEY_HERE  # Replace with your actual API key
+      - MODEL=deepseek-chat  # or glm-4.5-air, etc.
+      
+      # Server Configuration
+      - IP=0.0.0.0  # Listen on all interfaces
+      - PORT=8080
+      - DISPLAY=:1  # X11 display
+    restart: unless-stopped
