Unearth Docs

HOW-TO / LOCAL INSTALL

Run the current self-hosted foundation

Use Docker and a POSIX shell. The setup script generates an ignored .env with per-installation credentials. This currently starts the foundation and onboarding flow, while research screens are still migrating.

  1. Get the application source

    git clone https://github.com/Property-Data-Labs/unearth-chat-app.git
cd unearth-chat-app

    The repository README tracks the current prerequisites and available services.

  2. Generate development configuration

    ./scripts/setup.sh development

    Setup does not overwrite an existing .env. Edit that file to change service choices later.

  3. Start the base services

    docker compose up -d --build
docker compose ps --all

    The one-shot migration container should exit successfully. The API and worker should become healthy.

  4. Start the optional platform app

    docker compose --profile platform up -d --build platform
curl http://127.0.0.1:4000/ready
curl http://127.0.0.1:3000/health

    Both health requests should return HTTP 200. Open http://127.0.0.1:3000 to try email-code sign-in; development email is delivered to Mailpit at http://127.0.0.1:8025.

Managed services

PostgreSQL and Redis can be external independently. See Configuration for the setup flags and connection requirements.