INSTALL.txt

### IMPORTANT!

* After initial installation please reboot your system and then run
  the `barracuda up-head` upgrade to complete all tasks and prepare
  the system for production use -- it is very important especially on
  newer systems like Debian Stretch. Once the barracuda upgrade is complete,
  please reboot the server *again* to make the systemd cleanup complete.

* BOA requires minimal, supported OS, with no services installed.
  The only acceptable exceptions are: sshd and mail servers.

* Don't run any installer via sudo.
  You must be logged in as root directly.

* Don't run any system updates before running Barracuda installer.
  You should use vanilla system.


### Installing BOA system on a public server/VPS

1. Configure your domain DNS to point its wildcard enabled A record to your
   server IP address, and make sure it propagated on the Internet by trying
   `host server.mydomain.org` or `getent hosts server.mydomain.org` command
   on any other server/system.

   See our DNS wildcard configuration example for reference: http://bit.ly/UM2nRb

   NOTE! You shouldn't use anything like "mydomain.org" as your hostname.
         It should be some **subdomain**, like "server.mydomain.org".

   You **don't** need to configure your hostname (on the server) before
   running BOA installer, since BOA will do that for you, automatically.

2. Please read docs/NOTES.txt for other related details.

3. Download and run BOA Meta Installer.

   $ cd;wget -q -U iCab http://files.aegir.cc/BOA.sh.txt;bash BOA.sh.txt

4. Install Barracuda and Octopus.

   You must specify the kind of install with {in-head|in-dev} or for
   legacy versions with {in-3.2|in-2.4}, location with {local|public},
   your hostname and email address, as shown further below.

   Specifying Octopus username is optional. It will use "o1" if empty.

   The one before last part {ask|mini|max|none} is optional, if you wish
   to control Octopus platforms install mode, as explained below.
   Note that "none" is a special option you can use to not install any
   built-in platform, while "ask" is a default mode if you don't specify
   this option at all.

   The last {newrelickey|php-7.4|php-8.0|php-8.1|php-all|nodns} part is
   optional and can be used either to install New Relic Apps Monitor (you should
   replace the "newrelickey" keyword with a valid license key), or to define
   single PHP version to install and use both for Master and Satellite instances.
   When "php-all" is defined, then all available versions will be installed,
   but 7.4 will be used by default. You can later install or modify PHP version
   used via _PHP_MULTI_INSTALL, _PHP_CLI_VERSION and _PHP_FPM_VERSION, but
   the _PHP_SINGLE_INSTALL variable must be set empty to not override other
   related variables. The "nodns" option allows to skip DNS and SMTP checks.

   # Latest on public server - prompt for every platform install
   $ boa in-head public server.mydomain.org my@email o1

   # Latest on public server - no prompt with 3xD6 + 3xD7 only
   $ boa in-head public server.mydomain.org my@email o1 mini

   # Latest on public server - no prompt with all platforms and New Relic
   $ boa in-head public server.mydomain.org my@email o1 max newrelickey

   To install Legacy version instead of Latest, use the same commands, but
   replace "in-head" with "in-3.2" or "in-2.4".

   Note that once you will install current Latest or DEV, you can't
   downgrade back to Legacy version!


### Installing BOA system on localhost

1. Please read docs/NOTES.txt

2. Download and run BOA Meta Installer.

   $ cd;wget -q -U iCab http://files.aegir.cc/BOA.sh.txt;bash BOA.sh.txt

3. Install Barracuda and Octopus.

   You must specify the kind of install with {in-head|in-dev},
   location with {local|public}, and your email address,
   as shown below. For local installs you don't need to specify
   hostname and Octopus username, as it is fully automated.

   The last {ask|mini|max|none} part is optional, if you wish to control
   Octopus platforms install mode, as explained below.

   You can also specify PHP version to install, as shown in examples below.
   The {php-7.4|php-7.3|php-all} argument can be either added
   after {ask|mini|max|none} or specified instead of {ask|mini|max|none}

   # Latest on localhost - prompt for every platform install
   $ boa in-head local my@email

   # Latest on localhost - prompt for every platform + install all PHP versions
   $ boa in-head local my@email php-all

   # Latest on localhost - no prompt with 3xD6 + 3xD7 only + single PHP version
   $ boa in-head local my@email mini php-7.3

   # Latest on localhost - no prompt with all platforms installed
   $ boa in-head local my@email max

   To install DEV instead of Latest, use the same commands, but
   replace "in-head" with "in-dev" (DEV should be used only for development)

   To install Legacy version instead of Latest, use the same commands, but
   replace "in-head" with "in-3.2" or "in-2.4".

   The oldest Legacy version (in-2.2) is the last Edition in the 2.2.x series
   which still supported Drupal 5 and used Drush 4 along with old Aegir version.
   Note that once you have current Latest or DEV installed, you can't
   go back to any legacy version.


### Installing more Octopus instances

It is now possible to add stable, head or legacy 2.4 Octopus instances w/o
forcing Barracuda upgrade, plus optionally with no platforms added by default:

   $ boa {in-octopus} {email} {o2} {mini|max|none} {head|dev|2.4}

If {head|dev|2.4} is not specified, it will use the Latest (head).