Skip to content
Tiptree Systems Tiptree Systems Tiptree Systems Docs

Installation Guide

This guide covers installing and configuring the Tiptree Platform API for both local development and production deployment.

Prerequisites

Section titled “Prerequisites”
  • Python 3.11 or higher
  • Docker and Docker Compose (for local development)
  • PostgreSQL 15+ (for production)

Local Development Setup

Section titled “Local Development Setup”

1. Clone the Repository

Section titled “1. Clone the Repository”
Terminal window
git clone https://github.com/tiptreesystems/platform-api.git
cd platform-api

2. Install Dependencies

Section titled “2. Install Dependencies”

We use Poetry for dependency management:

Terminal window
# Install Poetry if you haven't already
curl -sSL https://install.python-poetry.org | python3 -


# Install dependencies
poetry install

3. Configure Environment

Section titled “3. Configure Environment”

Copy the example environment file:

Terminal window
cp .env.example .env

Edit .env with your configuration:

DATABASE_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/platform
API_KEY_SALT=your-secret-salt
DEBUG=true

4. Start Development Services

Section titled “4. Start Development Services”

Using Docker Compose:

Terminal window
docker-compose up -d

This will start:

  • PostgreSQL database
  • Development API server
  • Development tools

5. Run Migrations

Section titled “5. Run Migrations”
Terminal window
poetry run alembic upgrade head

6. Start the Development Server

Section titled “6. Start the Development Server”
Terminal window
poetry run uvicorn platform_api.main:app --reload

The API will be available at http://localhost:8000

Production Deployment

Section titled “Production Deployment”

1. System Requirements

Section titled “1. System Requirements”
  • Linux server with Python 3.11+
  • PostgreSQL 15+
  • Nginx (recommended)

2. Installation

Section titled “2. Installation”
Terminal window
# Install system dependencies
apt-get update && apt-get install -y python3-pip postgresql-client


# Install the package
pip install platform-api

3. Configure Environment

Section titled “3. Configure Environment”

Set up the following environment variables:

Terminal window
export DATABASE_URL=postgresql+asyncpg://user:password@host:5432/platform
export API_KEY_SALT=your-production-salt
export DEBUG=false

4. Database Setup

Section titled “4. Database Setup”
Terminal window
# Run migrations
platform-api db upgrade

5. Running in Production

Section titled “5. Running in Production”

We recommend using Gunicorn with Uvicorn workers:

Terminal window
gunicorn platform_api.main:app -w 4 -k uvicorn.workers.UvicornWorker -b 0.0.0.0:8000

Docker Deployment

Section titled “Docker Deployment”

We provide an official Docker image:

Terminal window
docker pull tiptreesystems/platform-api:latest


docker run -d \
  --name platform-api \
  -p 8000:8000 \
  -e DATABASE_URL=postgresql+asyncpg://user:password@host:5432/platform \
  -e API_KEY_SALT=your-production-salt \
  tiptreesystems/platform-api:latest

Next Steps

Section titled “Next Steps”