🚀Quick Start Guide

Dive into seamless conversational data interaction with our Quick Start guide. Here, we outline the installation process and basic configurations needed to swiftly get ChatGPTFirewall operational. Let’s dive in.

Installation Steps

  1. Clone the Repository Begin by cloning the project repository to your local machine. Open your terminal and run the following command:

    git clone https://gitlab.hs-flensburg.de/forschungsprojekt/confidential-cloud-computing.git

  2. Navigate to the Project Directory Change your directory to the cloned project using:

    cd confidential-cloud-computing

  3. Configure Auth0 Settings: Create a single page application, a custom API, and a machine-to-machine application in your Auth0 tenant. You will need the domain and audience from these settings for the next steps.

  4. Configure Environment Variables Copy the example environment file and rename it to .env:

    cp .env.example .env

    Open the .env file in your editor and adjust the variables as necessary. Particularly, ensure the OPEN_AI_KEY is set correctly to activate ChatGPT responses. Define the VITE_* environment variables according to your setup. For Auth0 configuration, set JWT_AUDIENCE to the identifier of your Auth0 API and JWT_ISSUER to your Auth0 domain, both of which can be found in your Auth0 dashboard.

  5. Build and Start the Application Utilize Docker to build and start the application by running:

    docker compose up --build

    The --build flag is crucial for building Docker images before the containers are started, especially after modifications to the .env file or updates in Pipfile.

Your ChatGPTFirewall application should now be accessible at http://localhost:5173/.

Further Configuration and Commands

After the initial installation, you might want to configure the database or create demo users. Follow these additional steps for further configuration:

  1. Move to the Application Directory Navigate to the chat_with_your_data directory within the project:

    cd chat_with_your_data

    Note: The following commands should be executed within this directory.

  2. Database Migrations

    • Autogenerate Migrations: Run the following command to create new database migrations automatically:

      python manage.py makemigrations

    • Apply Migrations: Apply these migrations to your database to update its schema:

      python manage.py migrate

  3. Managing Demo Users

    • Create Demo Users: To create demo users along with demo files, execute:

      python manage.py create_demo_users

    • Delete Demo Users: If you wish to clean up demo data, you can delete demo users by running:

      python manage.py delete_demo_users

You're all set! You’ve successfully installed ChatGPTFirewall and are ready to explore its features. Enjoy your journey into conversational data interaction!

PreviousIntroductionNextFeatures

Last updated