Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion content/nim/disconnected/offline-install-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,28 @@ Run the installation script in `offline` mode to download NGINX Instance Manager

After you’ve packaged the installation files on a connected system, copy the tarball, script, and SSL files to your disconnected system. Then, run the script again to install NGINX Instance Manager using the tarball.

## Dependencies needed for install script to run offline

There are OS dependencies we have for NGINX, NIM and Clickhouse. In offline mode we package only NGINX, NIM and Clickhouse packages, customers should first install OS dependencies also. Below are the dependencies list for Linux distributions with `.deb` (Debian/Ubuntu) and `.rpm` (Red Hat) packages. In online mode, these dependencies are auto resolved and installed.

### Debian/Ubuntu and similar operating systems

- NGINX : libc6, libcrypt1, libpcre2-8-0, libssl3, zlib1g,lsb-base
- NIM : openssl, rsyslog, systemd, tar, lsb-release, openssl, gawk
- ClickHouse: libcap2-bin

### Red Hat-based operating systems

- NGINX : bash, glibc, libxcrypt, openssl-libs, glibc, pcre2, openssl-libs, zlib, procps-ng, glibc , shadow-utils, systemd
- NIM : glibc, openssl, rsyslog,systemd, tar, which,zlib, yum-utils
- ClickHouse: None

You can find the latest dependencies with one of the following commands:

- Ubuntu/Debian: apt-cache depends <package_name>=<version>
- Red Hat : yum deplist <packagename-version>


### Required flags for installing in offline mode

- `-m offline`: Required to run the script in offline mode. When used with `-i`, the script installs NGINX Instance Manager and its dependencies from the specified tarball.
Expand Down Expand Up @@ -210,4 +232,4 @@ sudo systemctl restart nms-dpm

## Next steps

- [Add NGINX Open Source and NGINX Plus instances to NGINX Instance Manager]({{< ref "nim/nginx-instances/add-instance.md" >}})
- [Add NGINX Open Source and NGINX Plus instances to NGINX Instance Manager]({{< ref "nim/nginx-instances/add-instance.md" >}})
30 changes: 30 additions & 0 deletions content/nim/fundamentals/tech-specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,37 @@ The table below shows the estimated storage requirements for **NGINX OSS**, base
| | 250 | 14 | 4 GiB |
{{</bootstrap-table>}}

## Directory Requirements for NGINX Instance Manager

Below are the directory requirements and storage recommendations for fresh, minimal, and moderate usage (<100 instances) of NGINX Instance Manager (NIM).

{{< call-out "important" >}}
These recommendations apply if you are using NGINX Agent to connect NGINX instances to NIM for full management capabilities, including:

- Managing configurations
- Viewing metrics
- Applying WAF policies
- Managing certificates

If you're concerned solely on usage reporting, you do not need NGINX Agent. Required resources needed are significantly reduced. For usage reporting-only deployments, NIM receives and stores usage data sent directly from the instances.
{{< /call-out >}}

{{<bootstrap-table "table table-striped table-bordered">}}
| Directory path | Content | Recommendation |
|-----------------------|-----------------|----------------------------------|
| /usr/bin | Stores NIM binaries | 500MB |
| /var/lib/nms/dqlite | Stores DQLite database data| 2GiB without NGINX App Protect; 5GiB with NGINX App Protect enabled and large compiled bundles |
| /var/lib/nms/streaming | Stores NATS streaming messages | 500MiB |
| /var/lib/nms/secrets | Stores secrets for LLM license handshakes | 10MiB |
| /var/lib/nms/modules | Stores static content like manager.json | 100KiB (12KiB minimum) |
| /var/lib/clickhouse | Stores ClickHouse metrics data | recommend 2.5GB per instance (25GB for 10 instances, 250GB for 100 instances). This is only required if ClickHouse metrics are enabled |
| /var/log/nms | Stores logs for NIM with rotation enabled | recommended 50MiB per week if archived once a month |
| /etc/nms/ | Stores NIM configuration files | 50MiB |
| /etc/nginx | Stores NGINX configuration files | typical size is 10MiB-50MiB |
{{</bootstrap-table>}}

## ClickHouse tuning {#clickhouse-tuning}

The default ClickHouse configuration works efficiently with NGINX Instance Manager. If you change the configuration and ClickHouse runs out of memory, see the [ClickHouse configuration guide]({{< ref "/nim/system-configuration/configure-clickhouse.md#clickhouse-tuning" >}}) to adjust the settings.

## Firewall ports {#firewall}
Expand Down
Loading