From 43cb959dc2c1e43cdf4d8f39fed7773634cc2e60 Mon Sep 17 00:00:00 2001 From: Mario Fetka Date: Wed, 22 Apr 2026 13:47:46 +0200 Subject: [PATCH] Update Readme.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aeceb7a..c61749f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This repository is intended to be embedded into the main `mars_nwe` Git reposito - Submodule role: provides the SMArT web UI and helper tools - Release model: shipped as part of the integrated **MARS_NWE** release, not as a separate end-user release artifact -The build and install rules show that the web UI binaries, Perl helpers, configuration, static assets, and PAM file are installed as part of the overall build and installation flow. fileciteturn0file1L1-L53 +The build and install rules show that the web UI binaries, Perl helpers, configuration, static assets, and PAM file are installed as part of the overall build and installation flow. ## Architecture overview @@ -24,7 +24,7 @@ The current implementation adds a dedicated `nwwebui` service that can serve the - **HTTP on port 9080** - **HTTPS on port 9443** -The service supports TLS via OpenSSL and can run both listeners in parallel. HTTPS is the preferred mode because authentication happens more securely over an encrypted connection, while plain HTTP may still be useful for testing or trusted internal environments. The code defaults confirm support for HTTP on `9080`, HTTPS on `9443`, and TLS enabled by default in the service layer. fileciteturn0file1L31-L53 fileciteturn0file2L1-L26 +The service supports TLS via OpenSSL and can run both listeners in parallel. HTTPS is the preferred mode because authentication happens more securely over an encrypted connection, while plain HTTP may still be useful for testing or trusted internal environments. The code defaults confirm support for HTTP on `9080`, HTTPS on `9443`, and TLS enabled by default in the service layer. ## Security model @@ -32,7 +32,7 @@ SMArT uses PAM-based authentication through the `check_login` helper. The suppli - `/etc/pam.d/smart` -That means no manual PAM file deployment is normally required when SMArT is installed through the integrated `mars_nwe` package or release. fileciteturn0file1L42-L53 fileciteturn0file3L1-L4 +That means no manual PAM file deployment is normally required when SMArT is installed through the integrated `mars_nwe` package or release. ## Installed components @@ -58,7 +58,7 @@ The install rules include the following relevant components: - optional `mars-nwe-webui.service` systemd unit - PAM file installed as `/etc/pam.d/smart` -These components are all installed by the build system as part of the same integrated installation target. fileciteturn0file1L31-L53 +These components are all installed by the build system as part of the same integrated installation target. ## Typical runtime paths @@ -79,7 +79,7 @@ These values are sensible standard defaults for documentation. Packaging may sti ## The `smart.conf` file -The `smart.conf` file controls both the SMArT frontend behavior and the `nwwebui` listener settings. The shipped template documents the available keys in detail. fileciteturn0file2L1-L118 +The `smart.conf` file controls both the SMArT frontend behavior and the `nwwebui` listener settings. The shipped template documents the available keys in detail. A documented example with normal installation paths is shown below. @@ -112,7 +112,7 @@ $smart_nwclient_path = '/etc/mars_nwe/.nwclient'; $smart_static_dir = '/usr/libexec/mars_nwe/static'; $smart_log_path = '/var/log/mars_nwe/smart.log'; $smart_check_login = '/usr/libexec/mars_nwe/check_login'; -# $smart_perl_path = '/usr/libexec/mars_nwe/smart'; +$smart_perl_path = '/usr/libexec/mars_nwe/smart'; # ------------------------------------------------------------ # nwwebui listener settings @@ -180,11 +180,11 @@ The code defaults and the template together show that the intended standard depl - HTTPS on `9443` - TLS enabled -That makes HTTPS the recommended way to access the interface, especially when passwords are used. fileciteturn0file2L73-L118 fileciteturn0file2L17-L26 +That makes HTTPS the recommended way to access the interface, especially when passwords are used. ## Starting the service -Depending on the installation method, `nwwebui` can be started either via **systemd** or directly from the **command line**. The build system installs a `mars-nwe-webui.service` unit when systemd support is enabled. fileciteturn1file0L48-L50 +Depending on the installation method, `nwwebui` can be started either via **systemd** or directly from the **command line**. The build system installs a `mars-nwe-webui.service` unit when systemd support is enabled. ### Starting with systemd @@ -254,8 +254,8 @@ This repository is built as part of the main `mars_nwe` build. The build system: - builds `check_login` - installs the PAM file and static UI assets -Because this repository is integrated as a Git submodule in `mars_nwe`, end users normally consume it through the main `mars_nwe` source tree and release packages rather than using it as a standalone project. fileciteturn0file1L1-L53 +Because this repository is integrated as a Git submodule in `mars_nwe`, end users normally consume it through the main `mars_nwe` source tree and release packages rather than using it as a standalone project. ## Summary -SMArT is now an integrated part of the `mars_nwe` release and includes a dedicated `nwwebui` service that can expose the interface over both HTTP and HTTPS. The current standard ports are **9080** for HTTP and **9443** for HTTPS. Authentication is handled through PAM, and the required `/etc/pam.d/smart` file is installed automatically together with the integrated MARS_NWE installation. fileciteturn0file1L31-L53 fileciteturn0file2L73-L118 fileciteturn0file3L1-L4 +SMArT is now an integrated part of the `mars_nwe` release and includes a dedicated `nwwebui` service that can expose the interface over both HTTP and HTTPS. The current standard ports are **9080** for HTTP and **9443** for HTTPS. Authentication is handled through PAM, and the required `/etc/pam.d/smart` file is installed automatically together with the integrated MARS_NWE installation.