Docker Minimal

The smallest setup that answers: the API, your presets, and somewhere to write logs. Nothing else is switched on.

🛠️ Prerequisites

📥 Download the following files

Place both in a directory of your choice. That directory is your project root.

✏️ Change this first

Edit Presets.json and replace the example bins with your own. Until you do, the answers describe someone else’s packaging.

🚀 Running the Application

In the project root, start the application:

docker compose up

This launches the Binacle.Net API with:

🌐 Accessing the API

Once the container is running, the API answers on:

http://localhost:8080/

There is no browsable documentation in this setup. Use the API pages, or the Quickstart sample if you want Swagger UI.

⚙️ Customizing Presets

To change bin configurations:

  1. Open Presets.json in your editor.
  2. Edit the bin definitions.
  3. Restart to apply:
     docker compose down
 docker compose up

📂 Logs Folder

A ./data folder is created for application data, including logs. The ./data and ./data/logs directories need write permissions.

Setting Permissions

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

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

📄 Additional Resources

Happy packing! 📦✨