Get Started

This page covers everything you need to get the FluxChat Python client running.

Dependencies

Quick Start

For a detailed installation process see below, 'Installation'.

git clone https://github.com/FluxChat/fluxchat-py.git
cd fluxchat-py
./bin/setup.sh

Installation

The setup process for FluxChat involves installing the required Python dependencies and generating the necessary configuration files.

To start the setup process, run

./bin/setup.sh

The script utilizes virtualenv to create a virtual environment and install the required Python dependencies. The environment variables used during the setup process are optional. See a list of available environment variables in page 'Environment Variables' below.

If the private key file is not found, the src/gen_rsa.py script will be executed to generate the private key, public key, and a self-signed certificate. This can be also done by openssl.

Towards the end of the setup process, the script runs envsubst to substitute variables in the config-example.json template file with environment variables, generating the final configuration file.

For the setup we assume that FluxChat is running on a personal Computer in a Local Area Network (LAN), which is connected to the public Internet via a default gateway. By default FluxChat will listen on all network interfaces (0.0.0.0).

To setup another node, you can use environment variables.

export FLUXCHAT_CONFIG=var/config2.json
export FLUXCHAT_PORT=25002
export FLUXCHAT_DATA_DIR=var/data2
export FLUXCHAT_IPC_PORT=26002
./bin/setup.sh