Web Portal Configuration#

The VOSS Automate provides two administrator graphical interfaces:

  • admin:

  • classic:

The base address URL to access an interface can be updated using the web portal commands. For details on the base address URLs, see the Log In to the Admin Portal topic in the Core Feature Guide.

Important

  • If the web service is disabled on a node, a warning is shown that the web portal commands cannot be run on the node. See Web Services.

  • When running the web portal <enable|disable|default> commands, the web server is restarted. A prompt to continue is shown when when the commands are run.

The following commands are available:

Note

  • The commands can only be run from application nodes.

  • On a cluster, prefix the commands with cluster run application, for example run: cluster run application web portal disable classic.

  • web portal list

    List default, enabled, and disabled portals.

    The default setup upon system startup is:

    $ web portal list
        webportal:
            admin: enabled
            classic: enabled
            default: classic
    
  • web portal default set <admin|classic>

    Set the selected portal type to default. If it is not enabled, enable it.

  • web portal disable classic

    Only the classic portal can be disabled. The admin portal cannot be disabled.

    Output if command is run on default startup setup:

    $ web portal disable classic
    Updating will restart Nginx.
    Do you wish to continue? (y/N) y
    INFO: classic was disabled
    WARN: web portal admin was automatically set as default
    Don't do web role if also middleware
    
    Application services: firewall processes stopped.
    Application nginx processes stopped.
    Reconfiguring applications...
    Application nginx process started.
        webportal:
            admin: enabled
            classic: enabled
            default: classic
    
  • web portal enable classic

    Only the classic portal can be enabled, since it is the only portal that can be disabled.

Note

If the commands: web portal default set admin and web portal disable classic are run on release 21.4 and the release is upgraded to release 21.4-PB1, these commands need to be re-run. If the release is upgraded to release 21.4-PB2, the settings will be retained.