Step 0 — Request Access

Every installation starts here · reviewed by a human · usually within one business day

1

Submit the request form

The form at seavesselmanager.com/request-access asks for:

Field	Why we ask
Full name	Who the licence is issued to
Company	Owner / manager / yard the installation belongs to
Work email	Where the personal download link is sent — use a company address, not a free webmail one
Fleet size	Number of vessels, so we can tell you whether Community Edition (up to 4 vessels) is enough
Intended use	Evaluation, on-board vessel install, office/shore install, or cloud deployment

2

We review your request

A person reviews every submission — usually within one business day (longer over weekends and public holidays). Community Edition licence keys are only issued after this review.

💬

Nothing is automated here on purpose. If we need to clarify your fleet size or deployment mode, we simply reply to your email before issuing the link.

3

Your personal download link arrives by email

On approval you receive an email containing a download link that is unique to you, of the form:

https://seavesselmanager.com/access/download.php?t=<TOKEN>

Property	Value
Validity	7 days from the moment it is issued
Downloads allowed	Up to 3 times
Shareable?	No — the token is tied to your request. Do not forward it.
Expired or used up?	Email support@seavesselmanager.com and we reissue it

⏱️

Download the ZIP and keep a copy on your own storage. Once the link expires or the 3 downloads are used, it stops working — you do not need it again for updates, only for a fresh install.

📧

No email after a business day? Check your spam/quarantine folder for mail from seavesselmanager.com, then contact support@seavesselmanager.com.

4

Download and extract the package

Open your personal link in a browser (or fetch it with curl on a headless server) and save svm-server-package-<version>.zip. Extract it to the folder you want the server to live in.

Platform	Recommended location
Windows	C:\SVM\Server
macOS / Linux	/opt/seavesselmanager

5

Run the bundled setup wizard

The ZIP contains the setup wizard — there is nothing else to download.

Windows (PowerShell, from inside the extracted folder):

Copypowershell -ExecutionPolicy Bypass -File setup.ps1

macOS / Linux (from inside the extracted folder):

Copychmod +x setup.sh && ./setup.sh

Continue to the platform guide for the full walkthrough: Windows · macOS · Linux / VPS.

What the wizard asks you

The wizard then generates all secrets, writes the .env file, and starts the Docker containers for you.

Licensing at a glance

See Activate the Community Edition licence for the activation steps.

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

CopyNew-Item -ItemType Directory -Force -Path C:\SVM\Server | Out-Null
Set-Location C:\SVM\Server

# Paste the token from your personal email link
Invoke-WebRequest -Uri "https://seavesselmanager.com/access/download.php?t=YOUR_TOKEN" -OutFile pkg.zip

Expand-Archive -Path pkg.zip -DestinationPath . -Force
Move-Item .\svm-server-package\* . -Force
Remove-Item .\svm-server-package, .\pkg.zip -Recurse -Force

Copycd C:\SVM\Server
powershell -ExecutionPolicy Bypass -File setup.ps1

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

Copysudo mkdir -p /opt/seavesselmanager && sudo chown $(whoami) /opt/seavesselmanager
cd /opt/seavesselmanager

curl -fsSL -o pkg.zip "https://seavesselmanager.com/access/download.php?t=YOUR_TOKEN"
unzip pkg.zip && mv svm-server-package/* . && rm -rf svm-server-package pkg.zip

Copycd /opt/seavesselmanager
chmod +x setup.sh && ./setup.sh

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

Copymkdir -p /opt/seavesselmanager && cd /opt/seavesselmanager
curl -fsSL -o pkg.zip "https://seavesselmanager.com/access/download.php?t=YOUR_TOKEN"
unzip pkg.zip && mv svm-server-package/* . && rm -rf svm-server-package pkg.zip
chmod +x setup.sh && ./setup.sh

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 Login & Admin Password

Do these in the first five minutes — before anyone else touches the system

1. Open the app and sign in

After signing in you land on the fleet dashboard:

2. Change the admin password — now

First-login checklist

Activate the Community Edition Licence

30-day grace period · free Community Edition key · up to 4 vessels · never expires

What Community Edition includes

Activation steps

Copycurl http://localhost:4001/api/v1/license/status

First-Run Configuration Tour

Vessels → assets → spare parts → PM schedules — in that order

SeaVesselManager is a planned maintenance system, so the data has a natural order. Build it top-down: a vessel owns assets (equipment), assets consume spare parts, and PM schedules generate work orders against those assets.

1. Create your vessels

Go to Fleet → Add Vessel. Name, IMO number, flag state and type are the fields that matter for reporting and certificates.

2. Import your assets (equipment register)

Open Assets and either add items manually or use Import with the Excel template. Assets are hierarchical — Main Engine → Turbocharger → Bearing — so import parents before children, or let the template's parent-code column do it for you.

Open any asset to see its detail view: technical data, documents, linked spare parts, maintenance history and running hours.

3. Load spare parts and stock

Go to Spare Parts to create the catalogue, then Stock to set on-board quantities, minimum levels and locations. Link parts to assets so a work order can reserve exactly what it consumes.

• Set a minimum stock level on critical parts — below it, the part appears in alerts and can be pulled straight into a purchase order.
• Record the storage location (store, rack, bin) so crew can actually find the part.
• Link parts to their asset — deleting an asset never deletes spare parts, it only unlinks them.

4. Build your PM schedules

Under Maintenance, create planned maintenance schedules per asset. Each schedule can be calendar-based (every 6 months), running-hours-based (every 500 h), or both — whichever falls due first. Work orders are generated automatically as due dates approach.

5. Meet AIVA, the built-in assistant

AIVA is the SeaVesselManager assistant. Ask it about overdue jobs, stock levels, or a specific asset's history in plain language instead of hunting through screens — useful while your team is still learning the module layout.

6. Then fill in the rest

Updating SeaVesselManager

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

The short version

Copydocker compose pull
docker compose up -d --force-recreate backend frontend

Take a backup before every update — see Backup & Restore. If your docker-compose.yml pins an explicit version tag, bump it first as shown below.

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

All your data lives in one Postgres volume — back that up and you can rebuild anything

What to back up

Quick backup (bundled script)

The package ships helper scripts next to docker-compose.yml:

Copycd /opt/seavesselmanager
./backup.sh          # writes a timestamped .sql.gz into ./backups

Manual backup with pg_dump

macOS / Linux:

Copycd /opt/seavesselmanager
mkdir -p backups

# Logical dump of the whole database, gzipped
docker exec -t svm-server-postgres pg_dump -U svm -d seavesselmanager \
  | gzip > backups/svm-backup-$(date +%Y%m%d-%H%M).sql.gz

# Keep the config alongside it
cp .env docker-compose.yml backups/

ls -lh backups

Windows (PowerShell):

Copycd C:\SVM\Server
New-Item -ItemType Directory -Force -Path .\backups | Out-Null

$stamp = Get-Date -Format 'yyyyMMdd-HHmm'
docker exec -t svm-server-postgres pg_dump -U svm -d seavesselmanager |
  Set-Content -Encoding UTF8 ".\backups\svm-backup-$stamp.sql"

Copy-Item .env, docker-compose.yml .\backups\

Volume-level snapshot (alternative)

If you prefer a raw copy of the data directory instead of a logical dump, stop the stack first so the files are consistent:

Copycd /opt/seavesselmanager
docker compose stop

docker run --rm \
  -v svm-server_postgres_data:/data \
  -v "$(pwd)/backups":/backup \
  alpine tar czf /backup/pg-volume-$(date +%Y%m%d).tar.gz -C /data .

docker compose start
docker volume ls   # confirm the exact volume name if the command above fails

Restore

Bundled script:

Copycd /opt/seavesselmanager
./restore.sh backups/svm-backup-20260501-0730.sql.gz

Manual restore from a gzipped dump:

Copycd /opt/seavesselmanager

# 1. Stop the app containers so nothing writes during the restore
docker compose stop backend frontend

# 2. Recreate an empty database
docker exec -i svm-server-postgres psql -U svm -d postgres \
  -c "DROP DATABASE IF EXISTS seavesselmanager;" -c "CREATE DATABASE seavesselmanager;"

# 3. Load the dump
gunzip -c backups/svm-backup-20260501-0730.sql.gz \
  | docker exec -i svm-server-postgres psql -U svm -d seavesselmanager

# 4. Bring the app back up (migrations run automatically on boot)
docker compose up -d backend frontend
docker compose logs -f backend

Suggested routine

Troubleshooting

Start with the table, then open the matching section below

Symptom → cause → fix

Reading the logs

Nine out of ten problems are answered by the first error in the backend log. Run these from the folder that contains docker-compose.yml:

Copydocker compose ps                        # state of every container (look for Restarting / Exited)
docker compose logs --tail 100 backend   # last 100 lines from the API
docker compose logs -f backend           # follow live, Ctrl+C to stop
docker compose logs --tail 50 postgres   # database startup problems
docker compose logs --tail 50 frontend   # web app build/runtime problems
docker compose logs --since 10m          # everything from the last 10 minutes
docker stats --no-stream                 # CPU / RAM per container

Free a busy port

Windows (PowerShell):

CopyGet-NetTCPConnection -LocalPort 3000 -State Listen |
  Select-Object LocalPort, OwningProcess, @{n='Process';e={(Get-Process -Id $_.OwningProcess).ProcessName}}

macOS / Linux:

Copysudo lsof -i :3000 -sTCP:LISTEN
# or
sudo ss -ltnp | grep -E ':(3000|4001|5432|8080)'

Then either stop that process, or change the port in .env and recreate:

Copy# .env
FRONTEND_PORT=3001
API_PORT=4002
ADMIN_PORT=8081

Copydocker compose up -d --force-recreate

Detailed walkthroughs

docker restart svm-server-backend

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

docker compose down -v
docker compose up -d

Copydocker --version
docker compose version
docker info | head -20

Copydocker system df            # what Docker is using
docker image prune -f       # remove dangling images (safe)
docker system prune -f      # remove stopped containers + unused networks

Copydocker compose ps
docker compose logs --tail 100 backend
docker compose up -d --force-recreate backend

Copydocker --version
docker compose version
docker compose ps
docker compose logs --tail 200 backend
curl -s http://localhost:4001/api/v1/health

FAQ & Contact

Common questions about access, licensing, data and updates

Getting access

Licensing

Running it

Contact

When you write in, include your version (from Settings or /api/v1/health), your platform, and the log output listed in Troubleshooting. Never include secrets from .env or your download token.

📧 Request access → Email support

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

Getting the package

Licence