Kite is a self-hosted file-sharing application built with SvelteKit and PostgreSQL (Drizzle ORM).

TypeScript 63.7%
Svelte 32%
JavaScript 3.8%
Dockerfile 0.4%

Find a file

Mitchell dba504f84e All checks were successful Tests / unit-tests (push) Successful in 1m49s Details docs: license		2026-02-20 04:44:03 +00:00
.cursor	initial commit	2026-02-20 01:59:15 +00:00
.forgejo/workflows	initial commit	2026-02-20 01:59:15 +00:00
.vscode	initial commit	2026-02-20 01:59:15 +00:00
drizzle	initial commit	2026-02-20 01:59:15 +00:00
messages	initial commit	2026-02-20 01:59:15 +00:00
project.inlang	initial commit	2026-02-20 01:59:15 +00:00
scripts	refactor: readme and docker configs	2026-02-20 02:24:52 +00:00
src	initial commit	2026-02-20 01:59:15 +00:00
static	initial commit	2026-02-20 01:59:15 +00:00
.dockerignore	initial commit	2026-02-20 01:59:15 +00:00
.env.example	initial commit	2026-02-20 01:59:15 +00:00
.gitignore	initial commit	2026-02-20 01:59:15 +00:00
.npmrc	initial commit	2026-02-20 01:59:15 +00:00
.prettierignore	initial commit	2026-02-20 01:59:15 +00:00
.prettierrc	initial commit	2026-02-20 01:59:15 +00:00
AGENTS.md	initial commit	2026-02-20 01:59:15 +00:00
CONTRIBUTING.md	docs: add documentation for contributing and security	2026-02-20 02:33:59 +00:00
docker-compose.prod.yml	refactor: readme and docker configs	2026-02-20 02:24:52 +00:00
docker-compose.yml	refactor: readme and docker configs	2026-02-20 02:24:52 +00:00
Dockerfile	initial commit	2026-02-20 01:59:15 +00:00
drizzle.config.ts	initial commit	2026-02-20 01:59:15 +00:00
eslint.config.js	initial commit	2026-02-20 01:59:15 +00:00
LICENSE	docs: license	2026-02-20 04:44:03 +00:00
package.json	docs: license	2026-02-20 04:44:03 +00:00
playwright.config.ts	initial commit	2026-02-20 01:59:15 +00:00
pnpm-lock.yaml	initial commit	2026-02-20 01:59:15 +00:00
pnpm-workspace.yaml	initial commit	2026-02-20 01:59:15 +00:00
README.md	refactor: readme and docker configs	2026-02-20 02:24:52 +00:00
SECURITY.md	docs: add contact info to security	2026-02-20 03:07:48 +00:00
svelte.config.js	initial commit	2026-02-20 01:59:15 +00:00
tsconfig.json	initial commit	2026-02-20 01:59:15 +00:00
vite.config.ts	initial commit	2026-02-20 01:59:15 +00:00

README.md

🪁 Kite

Kite is a self-hosted file-sharing application built with SvelteKit and PostgreSQL (Drizzle ORM). It provides secure, link-based shares, share requests, admin controls, and an API for integrations.

Quick Overview

Create password-protected, expiring share links with download limits.
Upload files and folders (per-file progress, deduplication, ZIP download).
Create and manage share requests where third parties can upload files.
Authentication: email/password, optional passkeys, and anonymous flows.
Admin UI: user management, branding, impersonation, and app settings.
REST API with OpenAPI generation for external integrations.

Tech Stack

SvelteKit (frontend & server routes)
TailwindCSS + DaisyUI
PostgreSQL + Drizzle ORM
BullMQ + Redis (background jobs)
OpenAPI (auto-generated)
Vitest + Playwright for tests

Requirements

Node.js (recommended v18+ or compatible with the repo tooling)
pnpm (or npm/yarn) for installing dependencies
Docker & Docker Compose (recommended for local DB/Redis in development)

Local Development (fast start)

Install dependencies:
```
pnpm install
```

Copy environment sample and set values (create .env):

cp .env.example .env
# edit .env for DB, REDIS, DRIZZLE_GATEWAY, etc.

Start local DB services with Docker (recommended):

./scripts/start-local-db.sh   # optional helper script

Run the app in dev mode:
```
pnpm dev
```

The site will be available at http://localhost:5173 (or the port vite reports).

Database & Migrations

Migrations are managed with drizzle-kit. Migration files live in the drizzle/ folder.
Common commands (see package.json scripts):
- pnpm run db:migrate — run migrations
- pnpm run db:generate — generate migration from schema
- pnpm run db:push — push schema changes

The app runs scripts/migrate.mjs during container startup when applicable.

Running in Docker

Development infra only (Postgres + Redis):
```
docker compose up -d
```

Production env setup:

cp .env.prod.example .env
# edit .env and replace all CHANGE_ME_* values before first start

Production stack (app + db + redis):

docker compose -f docker-compose.prod.yml up --build -d

Production stack with worker:

docker compose -f docker-compose.prod.yml --profile worker up --build -d

Notes:

docker-compose.yml is now development-only (DB + Redis).
docker-compose.prod.yml is the production stack.
Drizzle Gateway in production compose is opt-in via --profile ops and requires DRIZZLE_GATEWAY_MASTERPASS.
Gateway defaults to http://localhost:4983 (override with DRIZZLE_GATEWAY_PORT).
Required prod vars include: DATABASE_URL, ORIGIN, and POSTGRES_PASSWORD.

Scripts

Key scripts are exposed in package.json:

pnpm dev — start dev server (Vite + SvelteKit)
pnpm build — build for production
pnpm start — run built app
pnpm test — run unit & e2e tests (vitest + playwright)
pnpm run openapi:generate — regenerate OpenAPI spec
pnpm run worker — start the background worker process
pnpm run prod:up — start production compose stack
pnpm run prod:up:worker — start production compose stack with worker profile

Testing

Unit tests: pnpm run test:unit
End-to-end: pnpm run test:e2e (requires Playwright and browsers installed)

OpenAPI

The project generates an OpenAPI spec (see scripts/generate-openapi.mjs). The generated spec is available under static/openapi.json and build/client/openapi.json after build.

Contributing

Follow the existing code style (Prettier + ESLint + Tailwind order plugin).
Run pnpm format and pnpm lint before submitting PRs.

Troubleshooting

If migrations fail, inspect drizzle/ and the migration logs from scripts/migrate.mjs.
Use docker compose logs to inspect services (db, redis, worker).