Quick Start

Getting started with Binacle.Net is simple.

The setup below turns on Swagger UI, Scalar UI and the UI Module so you can try it out from a browser. All three are off by default.

🖥️ Run Locally with Docker

1️⃣ Install Docker

Download and install Docker from docker.com.

2️⃣ Launch Binacle.Net

Run this command in your terminal:

docker run -d --name binacle-net \
  -p 8080:8080 \
  -e SWAGGER_UI=True \
  -e SCALAR_UI=True \
  -e UI_MODULE=True \
  binacle/binacle-net:3.0

This starts Binacle.Net with Swagger UI, Scalar UI and the UI Module enabled on port 8080.

The tag 3.0 is the minor tag: it follows the newest patch in this line and never a breaking change.

3️⃣ Access Locally

• Swagger UI: http://localhost:8080/swagger/
• Scalar UI: http://localhost:8080/scalar/
• UI Module: http://localhost:8080/

➡️ Where to go next

• API - the endpoints, for V3 and experimental V4.
• Presets - replace the example bins with your own.
• Samples - Docker Compose and Kubernetes setups to copy, including one for running behind your own backend.