Quick Start Guide
The purpose of this quick start guide is to provide you with a fast and easy way of getting Harbourmaster set up and running on your local environment. For an advanced production setup, please refer to the more detailed documentation further below.
What is in this Guide
This guide will help you set up a set of Docker containers which will run the following applications:
- MongoDB (used as main database)
- Redis (used for caching)
- Ngnix (used as reverse proxy)
- Control Center
Create a docker runtime environment
This guide uses the software containerization platform Docker in order to make the installation process as easy as possible. The first step is to install a docker runtime environment on your system. We recommend using the lastest version of the native Docker client. If you're running an older version of your operating system which doesn't meet Docker's requirements, you can alternatively install Docker Toolbox.
For further instructions on how to get Docker or Docker Toolbox running on your system, please refer to the official starting guide: Get Started with Docker
Clone the harbourmaster-docs repo and switch to the quickstart folder
Get the lastest version of the Harbourmaster Quick Start Guide from our GitHub repository over at https://github.com/valiton/harbourmaster-docs.git. This repository contains all the necessary files to get you set up and running. After you've downloaded the files, switch to the quickstart directory to get started:
git clone https://github.com/valiton/harbourmaster-docs.git cd harbourmaster-docs/quickstart/
Accept Harbourmaster license
In order to run Harbourmaster, its license has to be accepted via configuration. This quick start guide uses the
shared_config.envconfiguration file, which already contains the necessary line
For more information on how to view and accept the license for your production setup, please refer to the chapter Harbourmaster.
Start containers with Docker Compose
Docker Compose is a tool which can automatically start up multiple Docker containers in a way which is defined in a
docker-compose.ymlfile (included in this quick start guide). While inside the quickstart directory, simply run:
The latest version of Harbourmaster will automatically be downloaded and started up using a pre-defined configuration.
If Docker Compose didn't come with your Docker installation, please refer to the official Docker instructions on how to install this tool.
Seed Harbourmaster tenants
This guide comes with a shell script which seeds the database with a few test-users as well as the admin user. During its run, the seed-harbourmaster.sh script will prompt you to input an initial password for the admin user. In the quickstart directory, run:
Add /etc/hosts entries
Create the following entry in your /etc/hosts file. If your Docker containers are running non-locally, replace the IP address in this entry accordingly.
All Harbourmaster applications are running on static TCP ports (Harbourmaster and Usermanager on port 80, Control Center on port 18040). As previously mentioned, the
docker-compose.yml also starts up an Nginx container, which listens on port 80 and maps our subdomains (e.g.
harbourmaster.thunder) to the individual application containers.
127.0.0.1 usermanager.thunder.dev harbourmaster.thunder.dev controlcenter.thunder.dev
Accessing the applications
To access the applications, simply point your web browser to the following URLs:
(username: "admin", password: <YOUR_INPUT_DURING_SEED> )
As described in the Usermanager chapter, you can configure an SMTP server to handle user registrations. It is, however, still possible to create users using the usermanager for testing purposes, even without any SMTP configurations.
Configuring the Drupal Module
For the installation and configuration of the Drupal Module, please refer to the chapter Drupal Module. Once installed, users will be able to register and log in using
General outline for your production setup
In this Quick Start Guide, we have provided you with pre-configured docker-compose and *.env files in order to provide you with a working setup easily and quickly.
When setting up Harbourmaster in a production environment, you should consider starting up each Harbourmaster application container (Harbourmaster, Usermanager and Control Center) individually and providing your own configurations. Please refer to the configuration section of each application to get an overview of how they can be customized and consider using your pre-configured local setup as a reference point.
When working with Docker, the Harbourmaster applications will accept configuration options passed to them in environment variables. Each chapter provides you with the relevant variables and gives you example Docker run commands. For more information on how to start up applications using Docker, you can refer to the official documentation at https://docs.docker.com/engine/reference/run/.
The Harbourmaster applications are all running on static ports which cannot be changed. You can, however, use Docker's EXPOSE feature (see link above) to determine which host port should be mapped to the application. As demonstrated in this Quick Start Guide, you can then set up a reverse proxy using applications such as Nginx or HAProxy. If you would like to set up an Nginx server similar to the one in this guide (and enable additional features such as SSL termination), you can check out our example nginx.conf file and refer to the official documentation (specifically the Beginner's Guide) for setup instructions.