diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f729f94022..2731ad6297 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,4 +2,4 @@ Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. To ensure the best possible outcome for everyone, please read this guide carefully before starting work. -Our contributions guide can be found here: [engineering.unkey.com/contributing](https://engineering.unkey.com/contributing) +Our contributions guide can be found here: [engineering.unkey.com/contributing](https://engineering.unkey.com/docs/contributing) diff --git a/QUICKSTART-DEPLOY.md b/QUICKSTART-DEPLOY.md index ad09a2e3bd..568a900c7d 100644 --- a/QUICKSTART-DEPLOY.md +++ b/QUICKSTART-DEPLOY.md @@ -10,13 +10,38 @@ This guide will help you get the Unkey deployment platform up and running locall ## Step 1: Start the Platform -1. Start all services using Docker Compose: +1. Change to the deployment directory: ```bash -docker-compose up metald-aio dashboard ctrl -d +cd deployment ``` -2. Wait for all services to be healthy +2. Create an `.env` file in `apps/dashboard` (use .env.example as a template): + +```bash +cp apps/dashboard/.env.example apps/dashboard/.env +``` + +Follow the instructions in .env.example to fill the values. + + +3. Start services using Docker Compose: + +```bash +docker compose up -d metald-aio dashboard ctrl +``` + + +If the dashboard build fails in Docker, run it locally: + +```bash +docker compose up planetscale agent +cd apps/dashboard +pnpm i +pnpm dev +``` + +4. Wait for all services to be healthy The platform now uses a Docker backend that creates containers instead of VMs, making it much faster and easier to run locally. diff --git a/apps/dashboard/.env.example b/apps/dashboard/.env.example index 7f0678b42b..c56527e92c 100644 --- a/apps/dashboard/.env.example +++ b/apps/dashboard/.env.example @@ -8,17 +8,37 @@ NEXT_PUBLIC_CLERK_SIGN_UP_URL=/auth/sign-up # Planetscale -DATABASE_HOST="aws.connect.psdb.cloud" -DATABASE_USERNAME= +# Docker sets this automatically. For local dashboard, use localhost:3900 +# DATABASE_HOST example for PlanetScale Cloud: aws.connect.psdb.cloud +DATABASE_HOST= +# For local: +# DATABASE_USERNAME=unkey +# DATABASE_PASSWORD=password DATABASE_PASSWORD= +DATABASE_USERNAME= # Unkey -UNKEY_WORKSPACE_ID= +# "api_local_root_keys" for local UNKEY_API_ID= +# "ws_local_root" for local +UNKEY_WORKSPACE_ID= -# ClickHouse -CLICKHOUSE_URL= +# 'workos' or 'local' +AUTH_PROVIDER= +# Set by Docker. Use "agent-auth-secret" for local +AGENT_TOKEN= +# Set by Docker. Use http://localhost:8080 for local +AGENT_URL= +# For fully local runs, you typically need: +# AUTH_PROVIDER=local +# AGENT_URL=http://localhost:8080 +# AGENT_TOKEN=agent-auth-secret + +# Clickhouse + +# Automatically set by Docker. For local-only development: +# CLICKHOUSE_URL=http://default:password@localhost:8123 # Optional