Skip to content

Quick Start

Chris Mavrommatis edited this page Feb 11, 2025 · 9 revisions

Getting started with Binacle.Net is simple. You can quickly run it locally using a Docker image, complete with a pre-configured Swagger UI with to interact with all available API calls.

🖥️ Run Locally with Docker

This option is the fastest if you want to just try it out.

Step 1: Install Docker

Ensure Docker is installed on your system. If not, follow the instructions on the Docker website.

Step 2: Run Binacle.Net

Open your terminal and run:

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

This command will:

  • Pull the latest Binacle.Net image.
  • Start the container with the Swagger UI and UI Module enabled.
  • Expose the API on port 8080.

Step 3: Access Binacle.Net

📦 Run with Docker Compose

For more advanced setups, you can use Docker Compose with the provided Samples

Clone this wiki locally