Installation Complete Guide

Installation Complete Guide

This page documents the supported installation and run workflow for Nutify:

• Docker deployment

1) Runtime Model (Supported)

Nutify runtime is supported only in Docker.

Use the Docker workflow for installation, startup, upgrades, and troubleshooting.

2) Docker Deployment (Recommended for Stable Runtime)

Use the compose profile documented in:

• Docker Compose Guide

Quick start:

cd github
docker compose up -d

Open UI:

• http://127.0.0.1:5050

3) First Run Checklist

1. start Nutify with Docker
2. open web UI
3. complete setup wizard
4. log in with admin account
5. verify topbar target appears
6. verify System -> Advanced -> NUT Manager target inventory

4) Common Ports

• 3493: NUT service
• 5050: Nutify web UI
• 443: HTTPS endpoint (if enabled)

5) Folder Persistence Expectations (Docker)

Common persistent folders:

• ./Nutify/logs
• ./Nutify/instance
• ./Nutify/ssl
• ./Nutify/etc/nut

Do not remove these casually, they contain runtime state/config.

6) Upgrade Workflow

1. backup instance, etc/nut, logs
2. update image tag
3. pull and restart services
4. validate login, target list, and dashboards

7) Quick Validation Commands

Docker status:

docker compose ps

Docker logs:

docker compose logs -f

8) Troubleshooting Entry Points

If installation looks healthy but UI behavior is wrong:

1. check System -> Log
2. check NUT Manager target states
3. verify active target in TopBar
4. use Troubleshooting Guide (By Symptom)

9) Beginner Installation Path (Recommended)

1. deploy with Docker compose profile
2. complete wizard once with real target data
3. verify one stable target on dashboard
4. configure providers in System -> Provider
5. configure per-target Notify/Reporter