Installation

Starting and Stopping Sidecar CX

If you are self-hosting Sidecar CX, you may need to manually start or stop Sidecar CX periodically.

Please note, unless you are self-hosting Sidecar CX these instructions do not apply to you. Sidecar CX Cloud manages and monitors instances hosted in our private cloud and will restart Sidecar CX if necessary.

The following examples will make the assumption that all the services are running on the same server. Based upon how you have installed Sidecar CX, you may or may not have all the services running on the same server.

The instructions assume an installation directory of ${HOME}. Please adjust to your specific installation directory.

Starting Sidecar CX

Due to the number of services to launch and data to provision, it may take a few minutes until the command completes.

Starting Sidecar CX
Click to copy
cd ""${HOME}/sidecarcx-self-hosted"
docker compose up -d

Accessing the Web App

Once the Docker startup command completes, navigate your web browser to the web app domain you configured during the installation script and login with the Admin username and password. You can identify these settings by running the following commands:

Finding the web app URL
Click to copy
grep SIDECARCX_SELF_HOSTED_APP_DOMAIN "${HOME}/sidecarcx-self-hosted/.env"

Finding the Admin Username
Click to copy
grep SIDECARCX_SELF_HOSTED_ADMIN_EMAIL "${HOME}/sidecarcx-self-hosted/.env"

Finding the Admin Password
Click to copy
grep SIDECARCX_SELF_HOSTED_ADMIN_PASSWORD "${HOME}/sidecarcx-self-hosted/.env"

Stopping Sidecar CX

Stopping the server is just as easy as starting. When stopping the application, all services strive to provide ample time for all requests to complete.

Starting Sidecar CX
Click to copy
cd ""${HOME}/sidecarcx-self-hosted"
docker compose down