Smartify

Chat21 channel configuration

Tiledesk uses Chat21 as messaging platform. Refer to Architecture overview to understand the product's modules. The tiledesk-server component uses the Chat21 channel for sending chat messages, creating groups, etc.

To correctly configure your Tiledesk installation you MUST configure the following environment variables:

  • FIREBASE_PRIVATE_KEY

    • You can get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-sdk-firebase-admin-account

    • Format example:

      -----BEGIN PRIVATE KEY-----\ABCD78261TGV...HGAGBA82727\n-----END PRIVATE KEY-----\n

    • More info: https://firebase.google.com/docs/admin/setup#initialize_the_sdk

  • FIREBASE_CLIENT_EMAIL

    • You can get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-sdk-firebase-admin-account

    • Format example: firebase-adminsdk-******@************.iam.gserviceaccount.com

  • FIREBASE_PROJECT_ID

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-app

  • FIREBASE_APIKEY

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-app

  • FIREBASE_AUTHDOMAIN

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-app

    • Format example: CHANGEIT.firebaseapp.com

  • FIREBASE_DATABASEURL

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-app

    • Format example: https://CHANGEIT.firebaseio.com

  • FIREBASE_STORAGEBUCKET

    • You can find it here: https://github.com/Tiledesk/tiledesk-docs/tree/7ed1cde88582e9a174199b20bd6ad610f0153fcb/configuration/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-a-storage

    • Format example: CHANGEIT.appspot.com

  • FIREBASE_MESSAGINGSENDERID

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-app

    • A unique numerical value created when you create your Firebase project, available in the Cloud Messaging tab of the Firebase console Settings pane.

  • CHAT21_ENABLED

    • Enable Chat21 channel by setting this to true.

  • FIREBASE_APP_ID

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#create-an-app

  • CHAT21_URL

    • Get it from: https://github.com/Tiledesk/tiledesk-docs/blob/master/installation/chat21-installation/chat21-firebase-installation/create-a-firebase-project.md#get-the-cloud-function-url

    • Format example: https://mytiledeskinstallation87.cloudfunctions.net

  • CHAT21_ENGINE

    • Default value: firebase

  • CHAT21_APPID

    • Default value: tilechat

  • CHAT21_ADMIN_TOKEN

    • The Chat21 admin token. Default value: chat21-secret-orgAa,

    • See setup options: https://github.com/chat21/chat21-cloud-functions/blob/master/docs/setup_options.md#admin-token

Additional reference:

  • Sample env file: https://github.com/Tiledesk/tiledesk-server/blob/master/.env.sample

(last updated 2 years ago)

PreviousconfigurationNextTutorials