Getting Started

Get Ushadow up and running in minutes with our quickstart guide.

Quick install

Download InstallerDownload from GitHub Releases

1.Download the installer for your OS
2.Follow the installation prompts

Having trouble opening the app?

Prerequisites

Docker

Container runtime for services

Docker Compose

Multi-container orchestration

Git

Version control

Installation

Clone the Repository

Start by cloning the Ushadow repository from GitHub.

git clone https://github.com/Ushadow-io/Ushadow.git
cd Ushadow

Run Quickstart

The quickstart script handles all configuration and starts the services.

./go.sh

Access Dashboard

Open your browser and navigate to the Ushadow dashboard.

http://localhost:3000

Service URLs

Service	URL	Description
Ushadow Dashboard	`http://localhost:3000`	Main web interface
Ushadow API	`http://localhost:8080`	Backend REST API
API Documentation	`http://localhost:8080/docs`	Swagger/OpenAPI docs
Chronicle API	`http://localhost:8000`	Chronicle backend

Configuration

Ushadow can be configured using environment variables. Copy .env.template to .env and customize as needed.

Environment Variables

Configure your deployment with environment variables.

Variable	Description	Default
`ADMIN_EMAIL`	Admin user email address	admin@ushadow.local
`ADMIN_PASSWORD`	Admin user password	Generated on first run
`MONGODB_URL`	MongoDB connection string	mongodb://localhost:27017
`REDIS_URL`	Redis connection string	redis://localhost:6379
`CHRONICLE_URL`	Chronicle API endpoint	http://localhost:8000

API Keys

Optional API keys for enhanced functionality.

Variable	Description	Default
`OPENAI_API_KEY`	OpenAI API for memory extraction and chat	Optional
`DEEPGRAM_API_KEY`	Deepgram for audio transcription	Optional
`ANTHROPIC_API_KEY`	Anthropic for Claude models	Optional

Common Commands

Start Services

./go.sh

Stop Services

docker compose down

View Logs

docker compose logs -f

Rebuild After Changes

docker compose up -d --build