Minimal Setup

This sample demonstrates how to set up and run Binacle.Net with custom presets using Docker Compose. It is a minimal setup that showcases basic API functionality with customizable bin configurations.

🛠️ Prerequisites

Before you start, make sure you have the following installed on your machine.

Download the following files

Place these files in a directory of your choice. This directory will be your project root.

Customize (Optional)

Edit the Presets.json file to adjust the bin configurations as per your needs.

Create a .env file in the same directory with the content:

 COMPOSE_PROJECT_NAME=binacle-net-minimal-setup

This will set the project name for Docker Compose, allowing you to run multiple instances without conflicts.

🚀 Running the Application

In the project root, start the application by running:

docker compose up

This will launch the Binacle.Net API with:

🌐 Accessing the API

Once the containers are running, open your browser and go to:

http://localhost:8080/swagger/

Here, you can explore and test the API endpoints with an intuitive interface.

⚙️ Customizing Presets

To modify bin configurations:

  1. Open the Presets.json file in your preferred editor.
  2. Make your changes to the bin definitions.
  3. Restart the application to apply the updates: 
     docker compose down
 docker compose up

Your custom presets will now be active in the API.

📂 Logs Folder

When running the application, a ./data folder will be created to store application data, including logs for monitoring and debugging. It’s important to ensure that the ./data and ./data/logs directories have write permissions for proper functionality.

Setting Permissions

Run the following commands to create the directory and set the required permissions:

mkdir -p ./data/logs
sudo chmod -R 777 ./data

This will grant full access to ./data and its subdirectories.

777 gives full access to all users. Adjust permissions as needed for security.

📄 Additional Resources

Happy packing! 📦✨