diff --git a/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md b/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md index 0e4c0696dca..d10937d29ed 100644 --- a/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md +++ b/docs-2.0/9.about-license/2.license-management-suite/3.license-manager.md @@ -12,6 +12,7 @@ This article introduces how to deploy and use an LM service, as well as how to c !!! note LM installation packages are sent to you by email after you purchase a license. +- LM uses 9119 as the default port, make sure that port is not occupied. ## Notes @@ -36,7 +37,7 @@ An LM can be installed on Linux amd64 or arm64 systems or installed through Dash 1. Create the LM service file `/etc/systemd/system/yueshu-license-manager.service` with the following contents: - ``` + ```bash [Unit] Description=License Manager [Service] @@ -52,7 +53,7 @@ An LM can be installed on Linux amd64 or arm64 systems or installed through Dash 2. Start the LM service: - ``` + ```bash sudo systemctl start yueshu-license-manager ``` @@ -81,7 +82,7 @@ An LM can be installed on Linux amd64 or arm64 systems or installed through Dash 3. Set up LM to start automatically on boot. - ``` + ```bash sudo systemctl enable yueshu-license-manager ``` @@ -104,7 +105,7 @@ An LM can be installed on Linux amd64 or arm64 systems or installed through Dash 3. Set up LM to start automatically on boot. - ``` + ```bash sudo systemctl enable yueshu-license-manager ``` @@ -112,6 +113,36 @@ An LM can be installed on Linux amd64 or arm64 systems or installed through Dash LM can be installed and started through Dashboard. For more information, see [Connect to Dashboard](../../nebula-dashboard-ent/3.connect-dashboard.md). +## View LM configuration file + +The configuration file name for LM is `nebula-license-manager.yaml`. + +- For RPM and DEB packages, the default path is `/usr/local/yueshu-license-manager/etc/nebula-license-manager.yaml`. + +- For the TAR package, the path is `yueshu-license-manager/etc/nebula-license-manager.yaml` under the LM installation directory. + +The contents of the LM configuration file are as follows: + +```yaml +Name: nebula-license-manager +Host: 0.0.0.0 # The host address LM binds to. +Port: 9119 # The port number LM listens on. The default is 9119. +Timeout: 3000 # The timeout period for LM waiting for client requests, in milliseconds. The default is 3000 milliseconds. +DataPath: data # The path for storing LM status data. +Notify: # LM notification related configuration. + Mail: # Mail notification related configuration. + Host: "" # SMTP server address. + Port: 465 # SMTP server port number. + User: "" # SMTP email. + Password: "" # SMTP email password. + To: [] # The list of emails to receive notifications. +Log: # Logging related configuration. + Mode: file # The logging mode. It can be file (output to file) or console (output to console). The default is file. + Path: logs # The path for storing log files. + Level: info # The log level. It can be debug, info, error, or severe. The default is info. + KeepDays: 30 # The longest number of days to keep logs. The default is 30 days. +``` + ## Use LM After your LM starts, in the LM installation path you can use the LM CLI to view license information.