DeepLink Server Documentation

Overview

DeepLink Server generates intelligent short links that adapt to the user's platform: they open the app directly if installed, redirect to the store otherwise, and remember the intent to restore it at the first launch.

Recently shipped

The platform layer added 30+ new features across waves 2-5 — see the full Platform API reference.

Quickstart

Get a short link running in under 5 minutes using Docker Compose.

1. Clone the repository

   git clone https://github.com/your-org/deeplink-server.git
   cd deeplink-server

2. Copy and edit the environment file

   cp .env.example .env
   # Edit BASE_URL, API_SECRET, ADMIN_EMAIL, ADMIN_PASSWORD

3. Start with Docker Compose

   docker compose up -d

4. Open the dashboard

   open http://localhost:3000/dashboard.html

   Login with ADMIN_EMAIL / ADMIN_PASSWORD from your .env.

5. Create your first link via API

   curl -X POST http://localhost:3000/api/v1/links \
     -H "X-Api-Key: your-api-secret" \
     -H "Content-Type: application/json" \
     -d '{
       "title": "My First Link",
       "ios_uri_scheme": "myapp://product/42",
       "ios_store_url": "https://apps.apple.com/app/id123",
       "android_uri_scheme": "myapp://product/42",
       "android_store_url": "https://play.google.com/store/apps/details?id=com.ex",
       "web_url": "https://example.com/product/42"
     }'

6. Use the short URL
   

   The API returns a short_url like https://links.yourapp.com/abc123. Share it — it works on iOS, Android, and desktop.

7. Integrate the SDK
   

   Add the SDK to your mobile app. See SDK Integration for all platforms.

Installation

Three deployment modes are available depending on your needs.

cp .env.example .env
# Edit BASE_URL, API_SECRET…
docker compose up -d

# Install dependencies
npm install

# Configure environment
cp .env.example .env
# Edit .env — set BASE_URL, API_SECRET, etc.

# Start the server
npm start

# Development mode (auto-restart on changes)
npm run dev

Configuration — Environment Variables

Database Configuration

# .env
DB_PATH=./data/deeplink.db

npm start

# Create the database
psql -U user -c "CREATE DATABASE deeplink;"
psql -U user -d deeplink -f schema.sql

# .env
DATABASE_URL=postgres://user:pass@host:5433/deeplink

npm start