Installation parameters

Installation parameters for AWS Marketplace and CloudFormation

When setting up Browsolate using AWS Marketplace or AWS CloudFormation, several parameters can be configured to customize the solution to fit your organization’s requirements. These parameters affect security, performance, session handling, and the overall behavior of the service. Below are detailed explanations of each parameter group and the associated options.

Parameter Groups

Administration

Management Password

This parameter sets the password used to access management APIs. If left blank, management pages such as KeyManager and Launcher will not be enabled.

  • MGMTPasswd
    • Type: String
    • Default: '' (blank)

Enable Launcher UI

Determines whether the launcher page, which is the interface users interact with to initiate isolated sessions, is enabled. Disabling the launcher UI may be useful if you’re directly controlling session creation through APIs.

  • LauncherUI
    • Type: Boolean
    • Default: true
    • Allowed Values: true, false

Enable Encryption Keys Management UI

This parameter determines whether the encryption key management page is enabled.

  • UrlEncryptionKeysManagerUI
    • Type: Boolean
    • Default: true
    • Allowed Values: true, false

Custom Theme CSS ARN

Specifies the Amazon Resource Name (ARN) of a custom CSS file that contains themes to modify the look and feel of the Browsolate user interface. This allows you to brand the user interface with your company’s identity or create a custom experience for your users.

  • ThemeCSS
    • Type: String
    • Default: ''

Public API Access

Controls whether the API ports (default 5443) are publicly accessible. Setting this to true allows external users to access the APIs, which might be useful for testing or other use cases. For production environments, you may want to restrict access by setting it to false.

  • PublicAPIAccess
    • Type: Boolean
    • Default: false
    • Allowed Values: true, false

Session Configuration

Session Maximum Duration

This parameter defines the maximum allowed duration for a single user session, in seconds. After the specified duration, the session will automatically end, helping to prevent long, inactive sessions and optimize resource usage.

  • Duration
    • Type: Number
    • Default: 600 (10 minutes)

Session Dead Time

Sets the maximum period (in seconds) during which a session can remain inactive before being terminated. This is useful in cases where a user leaves a session open but inactive, allowing resources to be reclaimed after the dead time has passed.

  • Deadtime
    • Type: Number
    • Default: 90 (seconds)

System Configuration

Proxy Server URL

URL for the proxy server that will be used to route user traffic. This can include authentication credentials within the URL if required (e.g., https://user:password@proxy.example.com). Setting a proxy server allows you to route traffic through a secure or anonymized network.

  • Proxy
    • Type: String
    • Default: ''

EC2 Instance Type

Determines the type of EC2 instance used to host Browsolate. The instance type you choose affects the computational power and memory available, which can impact the performance of the service. You need to ensure that the instance type you specify is available in your AWS region. Choose a larger instance for higher performance and scalability.

  • InstanceType
    • Type: String
    • Default: m5.large

Maximum number of EC2 instances

Determines the maximum number of EC2 instances which can be deployed into the ECS cluster. Choose more instances for higher scalability.

  • EC2MaxInstances
    • Type: Number
    • Default: 1

HTTPS Certificates Configuration

Specifies the value stored in AWS Secrets Manager that contains your HTTPS certificates. This allows Browsolate to serve HTTPS traffic securely using your own certificates.

  • HttpsConfig
    • Type: String
    • Default: ''

Domain Name

Allows you to specify a custom domain name for your organization. If left blank, Browsolate will register your service with the default domain browsolate.com. Using your own domain requires additional setup to configure DNS and certificates.

  • Domain
    • Type: String
    • Default: ''

Availability Zone Index

Specifies the index of the AWS Availability Zone (AZ) where the service will be deployed. Choose 0 for the first AZ, 1 for the second, and so on. Ensure that the selected instance type is available in the chosen Availability Zone.

  • AvailabilityZoneIndex
    • Type: Number
    • Default: 0
    • Min Value: 0
    • Max Value: 2

UI Configuration

Region for Custom Theme CSS

Defines the AWS region where your custom theme CSS file is stored. This is useful when hosting theme files in regions other than the default region of your deployment. Providing this value ensures that the correct region is used to retrieve the CSS file.

  • ThemeCSSRegion
    • Type: String
    • Default: ''

STUN/TURN Server

STUN/TURN Server EC2 Instance Type

This parameter defines the EC2 instance type for the STUN/TURN servers. STUN/TURN servers are responsible for relaying WebRTC traffic when direct peer-to-peer connections are not possible (such as when users are behind firewalls). A more powerful instance type can handle a higher volume of traffic.

  • WebRTCInstanceType
    • Type: String
    • Default: t3.large

STUN/TURN Server Shared Secret

The shared secret used by the STUN/TURN server for authenticating clients. This secret is used to secure WebRTC connections between clients.

  • WebRTCSecret
    • Type: String
    • Default: ''

Existing STUN Server URLs

If using existing STUN/TURN servers, specify a comma-separated list of stun: URLs here. This parameter allows you to connect to external STUN servers instead of creating new instances.

  • STUNUrls

    • Type: String
    • Default: ''

Existing TURN Server URLs

If using existing STUN/TURN servers, specify a comma-separated list of turn: URLs here. This parameter allows you to connect to external TURN servers instead of creating new instances.

  • TURNUrls

    • Type: String
    • Default: ''

Number of STUN/TURN Server Instances

Specifies the number of STUN/TURN server instances to deploy.

More instances can improve redundancy and performance, particularly for users behind firewalls or on mobile networks.

You can scale the number of instances depending on the expected traffic.

This field is ignored if STUNUrls or TURNUrls are provided.

  • WebRTCInstances

    • Type: Number
    • Default: 1
    • Min Value: 1
    • Max Value: 20

These parameters allow you to customize various aspects of Browsolate during installation, from session management and EC2 instance types to the configuration of STUN/TURN servers and UI themes. Adjust these settings based on your organization’s requirements for performance, security, and scalability.