Unearth DocsUnearth Docs

About Unearth

Architecture

Understand the boundary between the public website, documentation, and application runtime.

Unearth separates its public website and documentation from the application runtime. The core application accepts provider-neutral configuration and can run on Docker hosts or Node.js infrastructure with PostgreSQL and Redis.

Repositories

RepositoryOwns
Website and docs repositoryThe marketing website at unearth.chat and documentation for docs.unearth.chat
unearth-chat-appAuthenticated Next.js web app, Fastify API, workers, shared server packages, schema migrations, and deployment configuration

Runtime services

ServiceResponsibility
WebAuthenticated research workspace and account interface
APIAuthentication, organization access, research requests, and queue producers
WorkerBackground jobs, ingestion, and recurring work
PostgreSQLApplication records, research state, and published dataset metadata
RedisQueues and shared runtime coordination
Artifact storeSource artifacts shared by the API and worker
Migration jobPending database schema changes before application startup

Deployment choices

Docker Compose provides a complete starting point. Services can also run separately on infrastructure that provides their runtime, storage, and network requirements. Railway is an optional deployment adapter; it is not required by the core application.

Marketing and documentation have their own deployment lifecycles. Updating either does not deploy the application, change its database, or activate ingestion.

Unearth DocsUnearth Docs

Search documentation

8 pages to explore

Guide / Get startedResearch with the source in viewFind properties, research owners, and compare markets with Unearth. Start with the product or run your own installation.Guide / Get startedResearch with UnearthAsk focused questions, inspect the evidence, and build on results in your workspace.Self-hosting / InstallationInstall with Docker ComposeBuild and run the web app, API, worker, PostgreSQL, Redis, and database migrations on your own host.Self-hosting / InstallationConfigurationConfigure origins, storage, authentication, AI, email, and optional research providers for your installation.Self-hosting / OperationsDatabase migrationsApply pending schema changes before starting a new application release.Self-hosting / OperationsData ingestionEnable automated acquisition and publication for the datasets and geographic coverage your installation needs.Project / About UnearthArchitectureUnderstand the boundary between the public website, documentation, and application runtime.Project / About UnearthProject statusCurrent implementation boundaries, public-release preparation, and planned integrations.