Updated on 2026-01-21 GMT+08:00

Starting or Stopping Nginx

This action aims to start or stop Nginx in a specified path on the target host in an environment.

Configuring Deployment Actions

  1. Create an application by referring to Creating an Application.
  2. On the Deployment Actions page, add this deployment action based on the service scenario.
  3. Configure the action using the parameters described in the table below.

    Table 1 Parameters

    Parameter

    Description

    Action Name

    Custom action name. Enter 1 to 128 characters. Do not start or end with a space. Use letters, digits, spaces, and these special characters: -_,;:./()

    Environment

    Deployment object. Select an environment whose resource type is host cluster.

    Operation

    Start Nginx, Reload configuration file, Stop Nginx immediately, and Quit Nginx gracefully are available.

    Nginx Installation Path

    Enter the installation path of the Nginx service in the target environment.

    Modify configuration file before execution

    Enable or disable this function based on whether to modify the Nginx configuration file on the target host.

    Nginx Configuration File Path

    Path of the Nginx configuration file on the target host.

    Configuration File Backup Path

    Target path for backing up the original Nginx configuration file on the target host.

    Configuration File Content

    Content of the new configuration file.

    Action Control

    Whether to enable the settings.

    • Keep running on failure: Continue the task even if this action fails.
    • Execute this action with the sudo permission: Use the sudo permission to deploy this action.

Helpful Links

If you encounter any problem during deployment, see Starting or Stopping Nginx.