Installation

Running on your computer in a few minutes

Start with the demo: one Docker command, sample partners and leads. When you are ready, the same tools create a production instance with its own database, HTTPS and encrypted backups.

1. Try the demo

All you need is Docker with Compose v2 (Docker Desktop on Windows or macOS, Docker Engine on Linux).

  1. 1

    Download the code

    git clone https://github.com/VibeCoderJK9/PartnerType.git
    cd PartnerType
  2. 2

    Start the demo

    The first start builds the image, which takes a few minutes.

    docker compose -f compose.demo.yaml up --build
  3. 3

    Sign in

    Open http://localhost:8000 and sign in as the vendor: vendor@demo.partnertype.test, password Demo2026! Partner accounts are printed in the log.

The demo uses public passwords and listens only on your computer. Never put real data in it. The demo runs without the AI agent, which needs Ollama (docs/AGENT-LOCAL-SETUP.md).

2. Set up a production instance

One command creates an instance with its own database, secrets and network.

  1. 1

    Build the image

    docker build --target release -t partnertype:local .
    docker image inspect partnertype:local --format '{{.Id}}'
  2. 2

    Create the instance

    Use the image id from the step above.

    python3 -m tools.instance --env production --id vendor-a create \
      --name 'Vendor A' --email owner@example.com \
      --base-url https://partners.example.com --port 8443 \
      --image sha256:<IMAGE_ID>
  3. 3

    Check that it runs

    HTTP 200 means the process answers and the database has the right schema.

    curl --fail https://partners.example.com/health

3. Keep it safe every day

  1. 1

    Maintenance

    Cleans expired sessions and used links.

    python3 -m tools.instance --env production --id vendor-a maintenance
  2. 2

    Encrypted backup

    Run it on a schedule and keep it off the server.

    python3 -m tools.instance --env production --id vendor-a backup \
      <BACKUP_DIR>/backup.age --recipient <AGE_PUBLIC_KEY>
  3. 3

    Restore drill

    Restores the backup into a separate copy and compares it.

    python3 -m tools.restore_drill --env production --id vendor-a

Before real data goes in

  • Off-server backups on a schedule
  • Monitoring with alerts
  • Disk encryption on the host
  • A data processing agreement and a record of processing (GDPR)
Full guide on GitHub

Questions

Short answers before you start

What server do I need?

A Linux server with Docker. If you run the local AI model on the same server, plan for 16 GB of RAM (8 GB works with little headroom). Set-up: docs/AGENT-LOCAL-SETUP.md.

How do I update?

Build the new image and run the upgrade command from docs/operations/INSTANCES.md. Migrations run in a controlled step.

Can you install it for us?

Yes. We roll PartnerType out, import your data and fit it to your process.

Ready to start? Run it yourself, or let us roll it out

  • Use it for free

    Download the code from GitHub and run it on your own server. The licence is free for any number of partners.

  • Get help with the roll-out

    We install PartnerType, import your data and fit the system to your sales process.