Installation

This is a step-by-step tutorial how to correctly deploy the balloon server and the balloon web based user interface. This tutorial includes the web interface, of course you may also just install the server components only. The web ui acts as a balloon client and is completely optional.

There are multiple supported ways to deploy balloon:

  • Docker (docker-compose)
  • Kubernetes using helm
  • Manually from tar archive
  • Compile manually from scratch

Note The distribution of deb packages has been discontinued starting with balloon v2.7 in favor of docker-composer.

Docker (docker-compose)

The easiest and fastest way to deploy a balloon environment is to spin it up using docker and docker-compose. Since the installation is not the same for different host os and docker can be started on Linux, Windows and Mac please visit the docker documentation on how to install docker and docker-compose.

Requirements:

  • docker
  • docker-compose
  • curl
mkdir balloon; cd balloon
curl https://raw.githubusercontent.com/gyselroth/balloon/master/packaging/docker-compose/docker-compose.yaml > docker-compose.yaml
docker-compose up

Note All balloon containers provide a version tag besides latest. It is best practice to use an exact version of a service instead the latest tag in production environment. The containers provide a latest-unstable tag for the balloon-jobs, balloon and balloon-web container. It is in no way reccomened to use pre-releases in production environments! If you want to install beta and alpha versions replace latest with latest-unstable or specify an exact version tag. Pre-releases are only ment for testing purposes and are in no way recommended in production environements!

The balloon web interface is now available at http://localhost.

Username: admin
Password: admin

Deploy on kubernetes (helm)

You find more information here on how to deploy balloon to k8s using helm.

Manually install from source

This topic is only for advanced users who know what the do or developers and describes how to deploy balloon by installing it directlly from source. If you are a developer please also continue reading this article.

Requirements:

  • posix based operating system (Basically every linux/unix)
  • make
  • comoser
  • git
  • php >= 7.3
  • php ext-mongodb
  • php ext-curl
  • php ext-mbstring
  • php ext-intl
  • php ext-zip
  • php ext-posix
  • php ext-pnctl
  • php ext-smd5
  • php-fpm

  • nginx

  • MongoDB Server >= 3.4

Optional requirements:

  • php ext-apc (Used in \Micro\Auth to cache discovery metadata)
  • php ext-imagick (Used in Balloon.App.Preview)
  • php ext-ldap (Used for LDAP authentication adapter in Micro\Auth)
  • php ext-smb (Used for SMB external storage)

  • smbclient (Used for SMB external storage)

  • Elasticsearch >= 6.0 (Used by Balloon.App.Elasticsearch)

  • Libreoffice online >= 4.0.9 (Used by Balloon.App.Office and Balloon.App.Wopi)
  • ClamAV (Used by Balloon.App.Clamav)

Install balloon server

git clone https://github.com/gyselroth/balloon.git
cd balloon
make install