# Install GivEnergy Insight 1.4.0 on Synology DSM

GivEnergy Insight for Synology is a free public beta. It runs continuously on
the NAS, reads compatible GivEnergy inverter data across the local network and
serves the dashboard through DSM.

## Before installation

Confirm the requirements in `COMPATIBILITY.md`:

- DSM 7.1 (`7.1-42661`) or newer
- Intel/AMD 64-bit (`x86_64`) Synology NAS
- Node.js v18 installed from Synology Package Center
- NAS and inverter on the same routed private network
- An administrator account for manual package installation

Web Station is not required.

Stop another direct Modbus monitor if it exclusively owns inverter port `8899`.
This can include GivTCP or some Home Assistant integrations.

## Verify the download

The website download has a matching `.sha256` file. After extracting the release
ZIP, compare the SPK with `CHECKSUMS-SHA256.txt`.

On macOS or Linux:

```sh
shasum -a 256 GivEnergy-Insight-1.4.0-Synology-x86_64.spk
```

On Windows PowerShell:

```powershell
Get-FileHash .\GivEnergy-Insight-1.4.0-Synology-x86_64.spk -Algorithm SHA256
```

## Manual installation

1. Sign in to DSM as an administrator.
2. Open **Package Center**.
3. Install **Node.js v18** if it is not already installed.
4. Choose **Manual Install**.
5. Select `GivEnergy-Insight-1.4.0-Synology-x86_64.spk`.
6. DSM warns that this is an unsigned third-party beta. Continue only if the
   checksum matches the supplied file and the download came from
   `givenergyinsight.com`.
7. Complete the wizard and start the package.
8. Open **GivEnergy Insight** from the DSM application menu.

## Open the application

From the local network:

```text
http://NAS-IP:5000/webman/3rdparty/GivEnergyInsight/index.cgi?runtime=dsm
```

Example:

```text
http://192.168.0.179:5000/webman/3rdparty/GivEnergyInsight/index.cgi?runtime=dsm
```

For DSM HTTPS:

```text
https://NAS-HOSTNAME:5001/webman/3rdparty/GivEnergyInsight/index.cgi?runtime=dsm
```

The DSM application-menu icon opens this address automatically. Version
1.4.0 uses an explicit `GivEnergyInsight:ui` DSM link and compatibility
CGI launcher under Synology's long-supported third-party application path. It
does not use the `web-config` package resource reserved by DSM 7.1.1 for
Synology packages. Keep the complete URL when troubleshooting or sharing setup
instructions.

## First-run test

1. Sign in through the GivEnergy Insight DSM portal if requested.
2. Open **Settings**.
3. Add a **Dummy inverter**.
4. Confirm dashboard values change and open Statistics and Smart View.
5. Return to Settings and save any Smart feature changes.
6. Restart the package from Package Center and confirm the dummy connection and
   preferences return.
7. Disconnect the dummy and add the real inverter using **Local → Scan this
   network** or enter its private IP manually.
8. Open **Remote Access** in the sidebar, enter a DDNS hostname and external DSM
   HTTPS port, then save and test the generated address.

## Updating

1. Download and verify the new release ZIP.
2. Open **Package Center → Manual Install**.
3. Select the newer SPK and approve the upgrade.
4. Saved settings and history are retained during a normal upgrade.
5. Open the app and confirm the version shown in the footer.

Do not uninstall the old version before a normal upgrade unless instructed,
because a full uninstall can remove package-private settings and history.

## Uninstalling

Stop and uninstall the package from Package Center. Export or copy any history
you want to retain first. DSM normally removes the package-private data directory
during a complete uninstall.

Continue with `USER-GUIDE.md`, and read `REMOTE-ACCESS.md` before exposing DSM
outside the home network.
