Quick Start

Getting started with Binacle.Net is simple. Run it locally using Docker or deploy it to the cloud with minimal setup.

The default setup includes Swagger UI and the UI Module for easy testing and interaction.

For version-specific details, see the Quick Start Guide for v3.0.x, or pick your version from the Versions page.

🖥️ 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 UI_MODULE=True binacle/binacle-net:latest

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

⚠️ latest always follows the newest release, and releases can bring breaking changes.

It is fine for a quick look. For anything you keep, pin a version instead - the Quick Start Guide for your version gives the exact tag to use.

3️⃣ Access Locally

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

☁️ Recommended Cloud Deployment Platforms

Binacle.Net works on all major cloud platforms. Choose based on your needs:

• 🔷 Azure App Service: Tight Microsoft ecosystem integration; scalable web apps.
• 🟠 AWS ECS / Fargate: Powerful container orchestration; flexible microservice scaling.
• 🟢 Google Cloud Run: Serverless container runtime; automatic scaling.
• 🟣 Koyeb: Simple deployment with affordable pricing, ideal for smaller workloads.
• 🌊 Digital Ocean App Platform: User-friendly with straightforward app management, good for small to medium deployments.

🗂️ Deployment Options Comparison

Choose the platform that aligns best with your workload, scalability needs, and budget to deploy Binacle.Net smoothly in the cloud. 🚀