Epic: Streamline Jan Installation Process

[dan-homebrew]

Problems

• Jan docker-compose takes ~3 min to seed DB and start up Seed Hasura db in a separate step #126
• Hasura DB seeding scripts are run automagically (vs. separately) Seed Hasura db in a separate step #126
• User can cannot choose username/password Installation should allow "admin user" creation (consolidated across Jan, Keycloak and Hasura) #125
• Logs are extremely cluttered, difficult to tell when things go wrong perf: jan-data-connector-agent SEVERE log #44 Clean up logs for data-connector-agent and graphql-engine #127
• Difficult to debug what is going wrong Clean up logs for data-connector-agent and graphql-engine #127
• Difficult to understand what each service is used for Document and streamline Jan Containers  #128
• We should have a CLI script that checks for pre-requisites, but installation still requires discrete commands Refactor installation script to only handle dependency and installation #30
• Llama2 download should be separate from run.sh Refactor installation script to only handle dependency and installation #30

Longer-term Story

• Jan should have an installation UI or CLI script

[0xSage]

High Level Spec

Quickstart (~10 min)

Install everything using a single command.

Note: Out of the box, Jan is production-ready and has an opinionated stack. If you wish to ship a lighter application for personal/local use only, please opt for a manual installation.

./run.sh

Manual Installation (Recommended)

1. Install dependencies

• Docker
• Docker compose
• (Optional) GPU drivers

  # If gpu_mode:
  echo "Running Nitro on GPUs, checking dependencies"
  # install nvidia-smi
  echo "nvidia-smi not detected, install?"
  # install cuda drivers
  echo "cuda drivers not detected, install?"
  # install nvidia-driver
  echo "nvidia-driver not detected, install?"

1. Clone this repo

   git clone https://github.com/janhq/jan.git
   
   cd jan
   
   # Pull latest submodules
   git submodule update --init --recursive

2. Configure .env

   # Your architecture
   DOCKER_DEFAULT_PLATFORM=linux/$(uname -m)
   
   # App frontend
   WEB_PORT=3000
   ROOT_USERNAME=username
   ROOT_PASSWORD=password
   
   # App Backend
   HASURA_PORT=8080
   HASURA_ADMIN_USERNAME=admin
   HASURA_ADMIN_PASSWORD=admin
   
   # User management
   KEYCLOAK_PORT=8088
   KEYCLOAK_ADMIN=admin
   KEYCLOAK_ADMIN_PASSWORD=admin

3. Install model(s)

   wget https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGML/resolve/main/llama-2-7b-chat.ggmlv3.q4_1.bin -P jan-inference/llm/models

4. Run Jan

   docker compose up

5. In a new tab, run seed migration

   docker sh hasura container
   ./seed.sh