Install and first setup: from package to first video

This set of documents moves the process from "the program can start" to "the user can use it stably." The result of deployment is not just the creation of a process, but a closed loop encompassing the database, MediaServer, storage, network, host daemon, and security boundaries.

flowchart LR
    A[Plan hosts, network, storage] --> B[Choose install method]
    B --> C[Complete initial setup]
    C --> D[Onboard one real video]
    D --> E[Harden and accept production]

Reading Sequence by Stage

1. Prepare the deployment: choose all-in-one or multiple nodes, database, recording disk, and network.
2. Choose the package and use the layout guide to check OS and CPU architecture.
3. Install on Linux, Windows, macOS, or Docker.
4. Follow the real first-setup screenshots for database, media, ports, storage, and administrator.
5. Check terminal reachability with network and HTTPS, then connect your first video.
6. Before production, complete security and go-live checks. Use management commands, logs, and online upgrade later.

Shortest Path for First-time Installation

If you only need to get it running on a test server first, please complete the following in order: Verify the release package → Extract to a fixed directory → Run the install for the corresponding platform → Run status → Open port 5800 in a browser → Complete initial configuration → Connect one video stream. Each step has an observable completion marker; you do not need to read all the O&M documentation first.

Install from a complete package or image matching the OS and CPU. If runtime files, deployment scripts, or version manifests are missing, obtain a complete delivery rather than assembling files from different versions.

Most Common Error Sequences

• Installing the program first, only to discover later that the recording disk, database, or UDP ports do not meet requirements.
• Treating the API port 5800 and the MediaServer media ports as the same entry point.
• Only verifying localhost on the local machine, without verifying from the camera network segment and the user browser network segment.
• Running binaries directly without installing systemd, Windows SCM, or launchd daemons.
• Using an ARM64 package on an x64 server, or copying only the main service while omitting the NodeAgent, WebUI static files, and version files.
• Only checking the page login after completing the setup wizard, without verifying the MediaServer, recording writes, and failover.

Minimum Production Composition

A typical single-machine deployment includes AKStream.Next, NodeAgent, MediaServer, MySQL, and recording storage. On Linux the independent NodeAgent recovers the main service from local desired state while the main unit remains Restart=no; other platforms follow the single recovery owner declared by the current release.

The MediaServer or database can be located remotely, but network latency, failure domains, backup responsibilities, and external media addresses must be clearly defined. For multi-node setups, each node should be assigned a stable ID, reachable address, persistent directory, and monitoring tags from the design phase.

Completion Standard

Deployment is only considered complete once all Production Go-Live Acceptance tests pass. If acceptance fails, do not repeatedly reinstall; first use the Problem Locator to determine if the failure lies within the host, control plane, protocol, media, storage, or browser.