Before You Start

One requirement — Docker Desktop

System requirements

Copycurl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
newgrp docker

Install on Windows

Windows 10 / 11 · PowerShell · Installs to C:\SVM\Server

Copyirm https://seavesselmanager.com/install.ps1 | iex

Managing the server

cd C:\SVM\Server

docker ps                                    # check all 5 containers are running
docker compose up -d                         # start
docker compose down                          # stop
docker logs svm-server-backend --tail 50     # view backend logs

Updating to a new version

SeaVesselManager ships new versions through Docker Hub. The customer package pins a specific version in docker-compose.yml, so docker compose pull on its own keeps re-pulling that same version. Bump the pinned tag first:

Copycd C:\SVM\Server

# 1. Back up, then bump the pinned image tags (PowerShell)
Copy-Item docker-compose.yml docker-compose.yml.bak
(Get-Content docker-compose.yml) -replace ':v4\.84',':v4.85' -replace 'APP_VERSION=v?4\.84','APP_VERSION=4.85' | Set-Content docker-compose.yml

# 2. Confirm the new tags
Select-String -Path docker-compose.yml -Pattern 'image:|APP_VERSION'

# 3. Pull the new images and recreate
docker compose pull
docker compose up -d --force-recreate backend frontend
docker compose logs -f backend
# Watch for: "Nest application successfully started", then Ctrl+C

Install on macOS

Intel · Apple Silicon (M1/M2/M3/M4) · Installs to /opt/seavesselmanager

Copycurl -fsSL https://seavesselmanager.com/install.sh | bash

Managing the server

cd /opt/seavesselmanager
docker ps
docker compose up -d
docker compose down
docker logs svm-server-backend --tail 50

Updating to a new version

SeaVesselManager ships new versions through Docker Hub. To update an existing install:

Copycd /opt/seavesselmanager   # or wherever docker-compose.yml lives

# 1. Back up, then bump the pinned image tags to the new version
cp docker-compose.yml docker-compose.yml.bak
sed -i 's/:v4\.84/:v4.85/g; s/APP_VERSION=v\?4\.84/APP_VERSION=4.85/g' docker-compose.yml

# 2. Confirm the new tags
grep -nE 'image:|APP_VERSION' docker-compose.yml

# 3. Pull the new images and recreate
docker compose pull
docker compose up -d --force-recreate backend frontend
docker compose logs -f backend
# Watch for: "Nest application successfully started", then Ctrl+C

Tip: swap v4.84/v4.85 for your current and target versions. To always track the newest build, set the tags to :latest and just run docker compose pull && docker compose up -d.

Install on Linux / VPS

Ubuntu 22.04 / 24.04 · Debian 12 · Any VPS or cloud server

Copycurl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
newgrp docker

Copycurl -fsSL https://seavesselmanager.com/install.sh | bash

sudo ufw allow 3000/tcp
sudo ufw allow 4001/tcp
sudo ufw allow 8080/tcp

http://<YOUR_SERVER_IP>:3000

Managing the server

cd /opt/seavesselmanager
docker ps
docker compose up -d
docker compose down
docker logs svm-server-backend --tail 50

Updating to a new version

SeaVesselManager ships new versions through Docker Hub. To update an existing install:

Copycd /opt/seavesselmanager   # or wherever docker-compose.yml lives

# 1. Back up, then bump the pinned image tags to the new version
cp docker-compose.yml docker-compose.yml.bak
sed -i 's/:v4\.84/:v4.85/g; s/APP_VERSION=v\?4\.84/APP_VERSION=4.85/g' docker-compose.yml

# 2. Confirm the new tags
grep -nE 'image:|APP_VERSION' docker-compose.yml

# 3. Pull the new images and recreate
docker compose pull
docker compose up -d --force-recreate backend frontend
docker compose logs -f backend
# Watch for: "Nest application successfully started", then Ctrl+C

Tip: swap v4.84/v4.85 for your current and target versions. To always track the newest build, set the tags to :latest and just run docker compose pull && docker compose up -d.

Connect a Domain & Enable HTTPS

Serve SeaVesselManager on your own domain with automatic SSL

By default the app runs over plain HTTP on port 3000. To serve it on your own domain with a valid certificate (e.g. https://fleet.yourcompany.com), SeaVesselManager ships a built-in Caddy reverse proxy that obtains and auto-renews a free Let's Encrypt certificate — no NGINX or Certbot needed.

Copycd /opt/seavesselmanager/reverse-proxy    # Linux
#   C:\SVM\Server\reverse-proxy           # Windows PowerShell

Copy# Linux / macOS
echo "SITE_ADDRESS=yourdomain.com" > .env

# Windows PowerShell
"SITE_ADDRESS=yourdomain.com" | Set-Content -Path .env -Encoding UTF8

Copydocker compose -f docker-compose.caddy.yml up -d
docker logs -f svm-server-caddy

Copycd /opt/seavesselmanager

python3 << 'PYEOF'
import yaml
with open("docker-compose.yml") as f:
    data = yaml.safe_load(f)

data["services"]["frontend"]["ports"] = ["127.0.0.1:${FRONTEND_PORT:-3000}:3000"]
data["services"]["backend"]["ports"] = ["127.0.0.1:${API_PORT:-4001}:4001"]

with open("docker-compose.yml", "w") as f:
    yaml.dump(data, f, default_flow_style=False, sort_keys=False)

print("Done. Ports bound to localhost only.")
PYEOF

# Apply (postgres/redis untouched, data stays intact)
docker compose up -d

# Verify - backend/frontend should now show 127.0.0.1:... not 0.0.0.0:
docker ps --format "table {{.Names}}\t{{.Ports}}"

Copycd C:\SVM\Server

# 1. Open docker-compose.yml in Notepad
notepad docker-compose.yml

# 2. Find these two lines and add 127.0.0.1: in front:
#    Before:  - "${API_PORT:-4001}:4001"
#    After:   - "127.0.0.1:${API_PORT:-4001}:4001"
#
#    Before:  - "${FRONTEND_PORT:-3000}:3000"
#    After:   - "127.0.0.1:${FRONTEND_PORT:-3000}:3000"

# 3. Save and restart
docker compose up -d

# 4. Verify
docker ps --format "table {{.Names}}\t{{.Ports}}"

Common mistakes

Troubleshooting

• Cert request hangs or fails — DNS not propagated yet, or port 80 blocked. Check nslookup and the firewall, then docker compose -f docker-compose.caddy.yml restart.
• Browser still shows insecure / old page — hard-refresh (Ctrl/Cmd+Shift+R) to clear the cached service worker.
• SITE_ADDRESS is missing a value — You forgot SITE_ADDRESS= in the .env file. Delete and recreate it exactly as shown in Step 3.

sudo apt-get install -y nginx certbot python3-certbot-nginx

server {
    listen 80;
    server_name yourdomain.com;
    location /api/       { proxy_pass http://127.0.0.1:4001; client_max_body_size 50M; }
    location /socket.io/ { proxy_pass http://127.0.0.1:4001; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection 'upgrade'; }
    location /license/   { proxy_pass http://127.0.0.1:4001/api/v1/license/; }
    location /           { proxy_pass http://127.0.0.1:3000; proxy_set_header Host $host; }
}

sudo ln -s /etc/nginx/sites-available/seavesselmanager /etc/nginx/sites-enabled/
sudo nginx -t && sudo systemctl reload nginx
sudo certbot --nginx -d yourdomain.com

Desktop Client

Native app for Windows & macOS — coming soon

What is the Desktop Client?

The SeaVesselManager Desktop Client is a native Tauri 2 application that wraps the full web interface in a native window. It connects to any running SeaVesselManager server on your LAN or internet — no browser, no Docker, no installation of any server components on the client machine.

How it will work

First Steps After Install

Do these right after your first login

Updating SeaVesselManager

Your data is safe — only the backend and frontend container images are replaced

Windows

Copycd C:\SVM\Server

# 1. Back up, then bump the pinned image tags (PowerShell)
Copy-Item docker-compose.yml docker-compose.yml.bak
(Get-Content docker-compose.yml) -replace ':v4\.84',':v4.85' -replace 'APP_VERSION=v?4\.84','APP_VERSION=4.85' | Set-Content docker-compose.yml

# 2. Confirm the new tags
Select-String -Path docker-compose.yml -Pattern 'image:|APP_VERSION'

# 3. Pull the new images and recreate
docker compose pull
docker compose up -d --force-recreate backend frontend
docker compose logs -f backend
# Watch for: "Nest application successfully started", then Ctrl+C

macOS / Linux

Copycd /opt/seavesselmanager   # or wherever docker-compose.yml lives

# 1. Back up, then bump the pinned image tags to the new version
cp docker-compose.yml docker-compose.yml.bak
sed -i 's/:v4\.84/:v4.85/g; s/APP_VERSION=v\?4\.84/APP_VERSION=4.85/g' docker-compose.yml

# 2. Confirm the new tags
grep -nE 'image:|APP_VERSION' docker-compose.yml

# 3. Pull the new images and recreate
docker compose pull
docker compose up -d --force-recreate backend frontend
docker compose logs -f backend
# Watch for: "Nest application successfully started", then Ctrl+C

Tip: swap v4.84/v4.85 for your current and target versions. To always track the newest build, set the tags to :latest and just run docker compose pull && docker compose up -d.

What each step does

Verify the new version

curl http://localhost:4001/api/v1/health

The response includes the running version number.

Backup & Restore

Windows

docker exec svm-server-postgres pg_dump -U svm seavesselmanager > C:\SVM\Server\backups\backup.sql

macOS / Linux

cd /opt/seavesselmanager
./backup.sh

Restore

./restore.sh backups/svm-backup-20260501.sql.gz

Troubleshooting

docker restart svm-server-backend

wsl --install
wsl --set-default-version 2

docker compose down -v
docker compose up -d

Quick Reference

Default login

URLs

Essential commands

docker ps                                     # check 5 containers running
docker logs svm-server-backend --tail 50      # backend logs
docker restart svm-server-backend             # restart backend only
docker compose down                           # stop all
docker compose up -d                          # start all
docker compose pull; docker compose up -d     # update (Windows PS)
docker compose pull && docker compose up -d   # update (macOS/Linux)

Install paths