CS Agent
About CS Agent
CS Agent is an EL agent that extracts and loads data from databases behind a firewall for the ConverSight.ai platform.
Currently Supported Databases.
- mySQL
Steps to run CS Agent
- Click the green dropdown in the upper right corner to clone or download the repository, or click this link to download the repository directly.(https://github.com/ConverSight/csAgent/archive/refs/tags/v0.1.1.zip)
- Change the configurations on the yaml file, it will be on the csAgent/config/config.yaml
- For example, to change the token, look for the key STATIC_TOKEN and replace the value with your token.
ChangeSTATIC_TOKEN: <TOKEN>
toSTATIC_TOKEN: 'JWT%20ajkshdjkfhaskjdhakshdfkahsdkjfhakdshf'
- To get the token, please contact the ConverSight.ai team or login as an administrator and click to the Configure Dataset page.
- To add database credentials on the yaml file, look for the database key and replace the values with yours
For example,
mySQL:
host: "192.168.155.268"
port: "1433"
username: "test_user"
password: "test_password"
database: "test_db"
timeout: 5
- Run CS Agent with the following command once the setup is complete.
- python app.py
- If you do not already have Python installed on your machine, please see the links below for instructions on how to do so.
- Windows (https://www.python.org/downloads/windows/)
- Linux - Ubuntu (
sudo apt install python3.8
) - Mac (https://www.python.org/downloads/macos/)
- Install the packages needed by CS Agent from the requirements.txt file after Python is installed. To install all of the packages, follow the steps below.
pip install -r /path/to/requirements.txt
- make sure pip is installed on your system