shx/docs/installation-api.md

Installation (API)

📦 Prerequisites

• Docker
• Docker Compose

📥 Installation

1. Navigate to the packages/api directory:

cd packages/api

2. Copy the .env.example file to .env and fill in the required values:

cp .env.example .env

3. Snip up the server:

docker compose up -d

4. The server should now be running on port 4000 by default. You can verify this by running:

docker compose ps

📝 Configuration

Note: For R2 keys you must have an cloudflare account and a domain name.