Getting Started
Installation
Install LoomDeploy on your VPS with a single command.
One-command install
Run this on your VPS as root (or with sudo):
Terminal
curl -fsSL \
https://raw.githubusercontent.com/youssef509/loomdeploy/main/deploy.sh \
| sudo bash
The installer will:
- Install Docker and Docker Compose if not already present
- Set up Traefik as a reverse proxy (handles SSL automatically)
- Pull and start the LoomDeploy backend and frontend containers
- Ask you for your domain name and email (used for Let's Encrypt)
The installer takes 2–5 minutes depending on your VPS speed and internet connection.
After installation
Once complete, visit https://dashboard.yourdomain.com in your browser. You will be prompted to create your admin account.
Registration is automatically locked after the first admin account is created. Share the dashboard URL with team members only after you have secured your account.
Manual installation
If you prefer to set things up yourself:
1. Install Docker
Terminal
curl -fsSL https://get.docker.com | sh
2. Clone the repository
Terminal
git clone https://github.com/youssef509/loomdeploy.git
cd loomdeploy
3. Configure environment
Terminal
cp .env.example .env
# Edit .env with your domain, email, and a strong JWT_SECRET
4. Start the stack
Terminal
docker compose -f docker-compose.traefik.yml up -d
docker compose up -d
Environment variables
| Variable | Description | Required |
|---|---|---|
DOMAIN | Your root domain (e.g. example.com) | ✅ |
ACME_EMAIL | Email for Let's Encrypt notifications | ✅ |
JWT_SECRET | Secret key for signing JWT tokens | ✅ |
DATA_DIR | Path to SQLite database (default: /var/lib/loomdeploy) | Optional |
Updating LoomDeploy
Terminal
cd loomdeploy
git pull
docker compose pull
docker compose up -d