5.2 Installation and Configuration of Desktop in Browser

Follow these steps to install and run the Desktop:

  1. Start the psc, service context (sc) and zookeeper (zk) if you have not done so.
  2. You are required to add the Desktop to an SC to be able to access it in your browser. To do this, use the following mzsh topo command to add the service to custom.conf:

    $ mzsh topo set topo://services:custom/obj:webdesktop.webdesktop1 '
    config : { http-port : <port>,
    http-host: <host>,
    allowed-clients: <no. of clients>,
    total-memory: <total memory>,
    memory-selection: <true or false>,
    memory-options: [<memory options for selection>],
    space-selection: <true or false>,
    sc-list : [<SC name>] },
    template : 1/standard/basic'

    When installing the Desktop, you can configure the following settings by including them in the mzsh topo command above:

    SettingDescription
    http-portDefault value: 9999

    The port where you want to access the Desktop in your browser.

    http-hostDefault value: 0.0.0.0

    The host where you want to access the Desktop in your browser.

    allowed-clientsDefault value: 4

    The number of clients that are permitted.

    total-memory

    Default value: 1024

    The total amount of memory permitted in MB for all of the connected clients. You allocate the amount of memory per client in the memory-options setting.

    memory-selectionDefault value: true

    This setting determines if a Memory dropdown is provided in the Desktop login dialog where you can select the amount of memory permitted for the current client. If you set the value to false, the Memory field is not visible and a default value of 256 MB is used for each connected client. If you want to set another value, you can configure a single value in the memory-options setting and this value will be used.
    memory-options

    Default value: 256, 512, 1024

    The memory options are available for selection for the current client in MB.

    This setting works with the total-memory setting.

    If you want to set the memory to the same value for each client, enter a single value. If you then set the value for memory selection to true, only this value is displayed in the Memory dropdown. If it is set to false, the Memory field is not visible.

    Note!

    Bear in mind that the number of clients permitted and the amount of memory permitted per client must be within the total memory that you set. For example, the default value of 1024 MB would allow 4 clients using 256 MB to be connected simultaneously, or 1 client with 512 MB and 2 clients with 256 MB.

    space-selectionDefault value: false

    This setting determines if a Configuration Space dropdown is provided in the Desktop login dialog where you can select to log in to a configuration space.

    If you want to configure the service to accept all of the default values of the options listed and you use sc1, use the topo command:

    $ mzsh topo set topo://services:custom/obj:webdesktop.webdesktop1 "config : { sc-list : [sc1] }, template : 1/standard/basic"

    If you accept all of the default values, the login dialog appears as shown in the image below in step 4.

    Example - Adding the Desktop service to custom.conf

    In this example the service is named webdesktop1, the number of clients permitted is set to 2, the host is localhost, the port is 9999 and the SC is sc1. The default values will be used for the rest of the settings.

    $ mzsh topo set topo://services:custom/obj:webdesktop.webdesktop1 "config : { http-port : 9999, http-host: localhost, allowed-clients: 2, sc-list : [sc1] }, template : 1/standard/basic"
    webdesktop {
        webdesktop1 {
            config {
                allowed-clients=2
                http-host=localhost
                http-port=9999
                sc-list=[
                    sc1
                ]
            }
            template="1/standard/basic"
        }
    }
  3. Start the Desktop service by entering the following:

    $ mzsh service start
  4. Start the web browser, entering the corresponding host and port: http://<http host>:<http port>/auth.

  5. In the login dialog, enter your username and password. If the memory selection is set to true in the custom.conf for the service, you can also set the amount of memory allocated to the client from the Memory dropbox.


    Desktop Login dialog


For further information on accessing the Desktop in your browser, see 1.1.2 Desktop in Browser in the Desktop User's Guide.