Docker Deployment

Quick start

# Clone the repository
git clone https://github.com/Project-N-E-K-O/N.E.K.O.git
cd N.E.K.O/docker

# Configure environment
cp env.template .env
# Edit .env with your API keys

# Start
docker-compose up -d

Access the Web UI at http://localhost:48911.

docker-compose.yml

version: '3.8'

services:
  neko-main:
    # Image version is selectable via env vars (latest = newest release)
    image: ${NEKO_IMAGE:-docker.gh-proxy.org/ghcr.io/project-n-e-k-o/n.e.k.o:${NEKO_IMAGE_VERSION:-latest}}
    container_name: neko
    restart: unless-stopped
    ports:
      - "48911:80"    # HTTP
      - "48912:443"   # HTTPS
    volumes:
      - ./N.E.K.O:/home/neko/.local/share/N.E.K.O
      - ./logs:/app/logs
      - ./ssl:/home/neko/ssl
    networks:
      - neko-network

networks:
  neko-network:
    driver: bridge

Configuration is supplied through the .env file you created above (cp env.template .env); entrypoint.sh reads the NEKO_* variables at startup. See Environment variables for the full list.

Environment variables

Create a .env file from the template:

# Required
NEKO_CORE_API_KEY=sk-your-key-here
NEKO_CORE_API=qwen

# Optional
NEKO_ASSIST_API=qwen
NEKO_ASSIST_API_KEY_QWEN=sk-your-assist-key

See Environment Variables for the full reference.

Nginx proxy

The Docker container includes Nginx as a reverse proxy:

• Proxies to the main server on the internal port
• WebSocket support for real-time chat
• Static file caching (30-day expiry)
• Health check at /health

Data persistence

Mount	Container path	Purpose
./N.E.K.O	/home/neko/.local/share/N.E.K.O	Config, characters, memories
./logs	/app/logs	Application logs
./ssl	/home/neko/ssl	SSL certificates

Provider quick start

Qwen (recommended):

NEKO_CORE_API_KEY=sk-xxxxx
NEKO_CORE_API=qwen

Free (no key needed):

NEKO_CORE_API_KEY=free-access
NEKO_CORE_API=free

OpenAI:

NEKO_CORE_API_KEY=sk-xxxxx
NEKO_CORE_API=openai

Troubleshooting

# View logs
docker logs neko

# Enter container
docker exec -it neko bash

# Check config
docker exec neko cat /home/neko/.local/share/N.E.K.O/core_config.json

# Check environment
docker exec neko env | grep NEKO_