Cobrowse.io Docs
  • Getting started
  • SDK Installation
    • Web
    • iOS
    • Android
    • React Native
    • Flutter
    • .NET Mobile
    • macOS
    • Windows
  • SDK Features
    • Account config
    • Identify your devices
    • Use 6-digit codes
    • Redact sensitive data
    • Viewing PDFs
    • Universal Cobrowse
    • Customize the interface
      • Active session controls
      • 6-digit code screen
      • User consent dialog
      • Remote control consent dialog
      • Full device consent dialog
      • Localization / translation
    • Initiate sessions with push
    • Listening for events
    • Full device capabilities
      • Full device screen sharing
      • Full device remote control
      • Managing full device mode
    • Advanced configuration
      • Starting and stopping the SDK
      • Declaring capabilities
      • Intercepting mobile SDK network requests
      • Web
        • IFrames support
        • IE 11 polyfills
        • Cross-domain session support
        • Ignore Views
      • iOS
        • Alternate render method
        • Custom touch handling
      • Android
        • Backporting TLS to older Android versions
  • Agent-side integrations
    • Agent-side overview
    • Platform integrations
      • Zendesk
      • Salesforce
        • Migrating from legacy to v2
        • Salesforce (Legacy)
      • Genesys
        • Genesys Cloud
        • Engage Workspace Web Edition (WWE)
        • Engage Workspace Desktop Edition (WDE)
      • Intercom
      • Freshworks
      • Talkdesk
      • NICE
    • Custom integrations
    • Agent SDK
      • API Reference
      • Sample code snippets
    • Authentication (JWTs)
      • JWT Policies
    • Authentication (SAML 2.0)
    • IFrame embeds
  • Enterprise self-hosting
    • Self-hosting overview
    • Docker Compose
    • Helm chart
      • Image Pull Secret
      • Environment Variables
      • Optional recording components
      • Pod Annotations
    • AWS terraform
      • AWS metrics configuration
    • Azure terraform
      • Azure metrics configuration
    • GCP terraform
      • GCP metrics configuration
    • Sizing guidelines
    • Running your instance
      • Adding a superuser
      • Limiting account creation
      • Limiting magic link recipients
      • Configuring SMTP
      • Managing your deployment
    • Monitoring your instance
      • Available metrics
      • Self-Hosted Prometheus
    • Advanced configuration
      • Air gap configuration
      • Pin web SDK version
      • L7 firewall configuration
      • Docker proxy configuration
    • Troubleshooting
Powered by GitBook
On this page
  • Register an account
  • Setting API location in the SDKs
  • Useful resources

Was this helpful?

  1. Enterprise self-hosting

Running your instance

Getting started with Cobrowse. Follow these simple steps to bootstrap your account and configure the SDK to use your private instance.

PreviousSizing guidelinesNextAdding a superuser

Last updated 11 months ago

Was this helpful?

Once your self-hosted instance is up and running, there are a few steps to bootstrap the account and configure our SDKs to use your private instance.

Register an account

Once your instance is up and running, you will need to register yourself an account. Head to to setup your account.

You may register multiple accounts in your instance if you would like. Some customers register accounts for dev, test, staging, etc.

If you are using the Email "magic link" sign-in flow, but do not have a mail server set up and have disabled our default mail provider, then please retrieve the "magic link" from the application logs of the cobrowe-api container by temporarily setting the environment variable:

DEBUG=cbio.email

This should be reverted to avoid the risk of credential leaks through the application logs.

Setting API location in the SDKs

You will need to set the API location when integrating the SDKs in order to point them at your private instance.

When specifying the API, please do not use a trailing slash.

CobrowseIO.api = "https://cobrowse.example.com";

Insert this line into your Cobrowse initialisation logic. It must be inserted before CobrowseIO.start() is called.

If using our provided snippet, you can put this before or after the CobrowseIO.license = "..." line.

CobrowseIO.instance.api = @"https://cobrowse.example.com";
CobrowseIO.instance().api("https://cobrowse.example.com");

Useful resources

Now your instance is up an running, you should review the documentation below to fine tune your deployment.

https://<your instance domain>/register
Adding a superuser
Limiting account creation
Configuring SMTP
Managing your deployment