guides/getting-started.md

Getting Started

Use this sequence for the least friction:

  1. Access Modes
  2. Portainer Stack Deployment
  3. Linking and Auth Flow
  4. Troubleshooting
  5. Setup Response Reference

Deployment Checklist

  • Docker is installed
  • You can access http://<SERVER_IP>:3000
  • You chose a connection mode:
    • relay (default)
    • open-port

First Endpoint to Check

GET /api/v1/system/setup

This endpoint is public and drives first-run onboarding.

Auth Header for Protected APIs

Use:

X-Mino-Key: <api_key>

Example:

curl http://<SERVER_IP>:3000/api/v1/system/capabilities \
  -H "X-Mino-Key: <API_KEY>"

Local Build Path

If you are developing from source, use Local Build.