Skip to content

back

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

back

README.md

ChatFAQ's back-end

This is ChatFAQ's core component, the orchestrator of ChatGPT. It manages client-to-messaging platform connections, session storage, datasets and models registration, FSM registration, FSM executions (intended only for simple FSMs), etc...

Prerequisites

Make sure the next list of packages are installed on your system:

  • Python 3.10
  • python3.10-dev
  • python3.10-distutils
  • PostgreSQL
  • gdal-bin
  • poetry

Installation

Local build

Set Up:

Install project dependencies:

poetry install

Create a "chatfaq" database in PostgreSQL

sudo -u postgres psql -c "CREATE DATABASE chatfaq"

Create a "chatfaq" user in PostgreSQL

sudo -u postgres psql -c "CREATE user chatfaq WITH encrypted password 'chatfaq';"

Give the newly created user the necessary privileges

sudo -u postgres psql -c "grant all privileges on database chatfaq to chatfaq;"

Apply django migrations

poetry run ./manage.py migrate

Apply fixtures

make apply_fixtures

Create a superuser

./manage.py createsuperuser --rpc_group 1

When creating the superuser notice that we are passing the --rpc_group 1 flag. This is critical to be able to create an RPC Server with this same user later on.

Run

First of all, create a .env file with the needed variables set. You can see an example of those on .env_example file. Next you can see the explanation of each variable:

DEBUG: Set to "yes" to enable debug mode

SECRET_KEY: Server secret key. This is used to provide cryptographic signing, and should be set to a unique, unpredictable value.

DATABASE_URL: Database connection URL. This is the URL that will be used to connect to the database. It should be in the following format: postgres://USER:PASSWORD@HOST:PORT/NAME

BASE_URL: Base URL of the server. This is the URL that will be used to connect to the server. It should be in the following format: http://HOST:PORT

STORAGES_MODE: The values can be "local", "s3" or "do", if "local" mode is set, the files will be stored under the MEDIA_ROOT directory (./back/local_storage by default) and if "s3" or "do" mode is set you will need to set the variables specified below.

AWS_ACCESS_KEY_ID + AWS_SECRET_ACCESS_KEY + AWS_STORAGE_BUCKET_NAME + DO_REGION + STORAGE_MAKE_FILES_PUBLIC: These variables are used to configure the storage backend. If you want to use AWS S3, you should set STORAGES_MODE to "s3" and set the other variables accordingly. If you want to use Digital Ocean Spaces, you should set STORAGES_MODE to "do" and set the other variables accordingly. If you want to use the local filesystem, you should set STORAGES_MODE to "local".

TG_TOKEN, WHATSAPP_TOKEN, SIGNAL_TOKEN, FB_TOKEN: These variables are used to configure the messaging platforms. You should set the token of the platforms you want to use. If you don't want to use a platform (ie: you are using our Widget solution), you can leave its token empty.

Run the server

make run

Docker

Alternatively you can simply run the server using docker.

Build

docker build -t chatfaq-back .

Run

docker run -p 8000:8000 chatfaq-back

Usage

Useful Endpoints

Admin: http://localhost:8000/back/admin/

Auth Token Generation: http://localhost:8000/back/api/login/

Swagger Docs: http://localhost:8000/back/api/schema/swagger-ui/

Redoc Docs: http://localhost:8000/back/api/schema/redoc/

Other useful info

Build the docs

go inside the doc directory and run:

poetry run make html