Skip to main content
Classic

Optidash

Learn how to use the Optidash module.

Deploy

Submit a support request to have the Optidash module deployed.

Manage

Manage the Optidash module through the advanced config.

tip

Check out the related Optidash reference to get started with customizing your Optidash module.

note

Submit a support request if you need help managing this module.

Clear cache

Follow the steps below to clear the Optidash module for an environment in your application:

Console

  1. Go to the clear cache of the environment you want to clear the Optidash module for.
  2. Clear cached images through a particular URL.

API

  1. Go to the API documentation.

  2. In the API list, click on Proxy.

  3. In the Proxy list, click on the following API endpoint:

    POST /account/{accountId}/application/{applicationId}/environment/{environmentName}/proxy/{proxyName}/state
  4. Build your API call by filling out the required parameters.

    tip

    The accountId, applicationId, and environmentName parameters can be obtained from the browser address bar when logged in to your Section account. The proxyName is the directory name of the module that is in the associated advanced config (typically optidash).

Delete

Follow the steps below to delete the Optidash module from your environment:

  1. Go to the advanced config of the environment you want to delete the Optidash module from.

  2. In the top of the page, copy the URL next to Clone with HTTPS.

  3. Open a terminal and change the current working directory to the location where you want the cloned environment repository.

  4. Clone the environment repository to your local computer. Type git clone followed by the copied URL and then press Enter:

    git clone <copied_url>
  5. In the root directory of the environment repository, delete the Optidash module directory (typically named optidash).

    note

    Skip this step to disable the module instead of deleting it.

  6. In the environment's section.config.json file, delete the module object from the proxychain array, which will look like the following:

    section.config.json
    ...
    "proxychain": [
    ...
    {
    "name": "<module_directory_name>",
    "image": "<module_image>"
    },
    ...
    ],
    ...
    section.config.json
    ...
    "proxychain": [
    ...
    {
    "name": "optidash",
    "image": "optidash:latest"
    },
    ...
    ],
    ...
  7. Stage, commit, and push the changes to the environment's remote repository:

    git add .
    git commit -m "Delete the Optidash module"
    git push