Haddock Logo
HADDOCK

Ship faster, easier.

Deploy your container applications without any hassle.

Get startedView on GitHub

Repository

Docker Analysis

Network Setup

Deployment

Introduction

Getting started

Learn how to get Haddock in your infrastructure in under ten minutes.

Installation

Step-by-step guides to setting up your system and installing Haddock.

Quick start

Installing Haddock is as easy as launching one command on your system !

You should know!

Before looking at the next steps, please note Haddock is only supported on these platforms:

PlatformSupported
Ubuntu18.04, 20.04, 22.04
Debian10, 11, 12

This might change in the future, but for now, we only support these platforms.

Launch the script

We provide a script that will install Haddock on your system. You can run it by executing the following command:

curl -sSL https://raw.githubusercontent.com/haddockapp/haddockapp/refs/heads/main/install.sh | sudo bash

The script will install Haddock's dependencies and Haddock itself. You can then start using Haddock in your infrastructure.

Consider Vagrant license limitations !

The project uses Vagrant, which is under the BSL license to provide your containers environment. Please note that Vagrant is free for personal use, but requires a license for commercial use. You can find more information on the Vagrant repository.

The major limitations are, but not limited to:

  • The BSL allows free use of Vagrant for individual developers, non-commercial purposes, and small-scale commercial projects.
  • For larger-scale commercial use (defined by HashiCorp as generating more than $1 million in annual revenue or having more than 1 million in funding), you need to purchase a commercial license.
  • You can not use Vagrant to make a commercial product or service that competes with HashiCorp's product without an appropriate license.

During the installation, you will be asked to provide some configuration for Haddock. At least, you will need to provide the following information:

  • Public IP address of your server.
  • If you want to install Vagrant or not.

After the installation, you can start using Haddock by accessing the web interface at http://<your-server-ip>:80.

Uninstall Haddock

We do not yet provide an uninstall script. However, you can remove Haddock by running the following commands:

sudo pm2 delete api
sudo pm2 save
sudo rm -rf /opt/haddock

You should know!

This will not remove the dependencies installed by the script for running Haddock. We highly recommend you to reinstall your system if you want to remove Haddock completely.

Basic usage

To be continued...

Next
Installation