Local computer install

Make sure you have completed the minimum installation procedures before proceeding.

You will be able to run Superchat on your local computer, but you will need some kind of secure tunnel between a valid public https URL and your computer. This is necessary to integrate with some communication channels such as Whatsapp and to provide webhooks for software such as Rocketchat, Tiledesk and others.

The secure tunnel you will need can be created using Ngrok and similar software, or one offered by Superchat with a free usage plan.

If you want to use our secure tunnel offer just send an email to admin@superchat.com.br and we will provide one for you with instructions for use.

Change the minimum required settings

Edit the .env file and setup it. It is strongly recommended to change at least:

Field	Description	Example
BUCKET_PUBLIC_DOMAIN	The public address of your bucket. Necessary for sending messages with media such as images and others.	you.lt.superchat.com.br/localstack

Start the docker-compose stack

docker-compose -f docker-compose.dev.yml up -d

Test your setup

Open a new window in your browser and access the tunnel URL that points to your local computer. If you are using a Superchat the URL looks like this:

https://you.lt.superchat.com.br/docs

For Ngrok:

https://NGROKURL/docs