Drupal 7.27.1 and Pressflow 6.31.1
[project/barracuda.git] / docs / INSTALL.txt
1
2 ### IMPORTANT!
3
4 * Don't run any installer via sudo.
5   You must be logged in as root or `sudo -i` first.
6
7 * Don't run any system updates before running Barracuda installer.
8   You should use vanilla system.
9
10 * Please never use HEAD version on any production server. Always use Stable.
11   The HEAD can be occasionally broken and should be used **only** for testing!
12
13
14 ### Installing BOA system on a public server/VPS
15
16 1. Configure your domain DNS to point its wildcard enabled A record to your
17    server IP address, and make sure it propagated on the Internet by trying
18    `host server.mydomain.org` or `getent hosts server.mydomain.org` command
19    on any other server/system.
20
21    See our DNS wildcard configuration example for reference: http://bit.ly/UM2nRb
22
23    NOTE! You shouldn't use anything like "mydomain.org" as your hostname.
24          It should be some **subdomain**, like "server.mydomain.org".
25
26    You **don't** need to configure your hostname (on the server) before
27    running BOA installer, since BOA will do that for you, automatically.
28
29 2. Please read docs/NOTES.txt for other related details.
30
31 3. Download and run BOA Meta Installer.
32
33    $ cd;wget -q -U iCab http://files.aegir.cc/BOA.sh.txt;bash BOA.sh.txt
34
35 4. Install Barracuda and Octopus.
36
37    You must specify the kind of install with {in-stable|in-head|in-legacy},
38    location with {local|public}, your hostname and e-mail address,
39    as shown below.
40
41    Specifying Octopus username is optional. It will use "o1" if empty.
42
43    The one before last part {ask|mini|max|stock} is optional, if you wish
44    to control Octopus platforms install mode, as explained below.
45    Note that none === "ask" which is default.
46
47    The special "stock" option allows you to install non-BOA, vanilla
48    Aegir 2.x version, useful **only** for testing/debugging, but it will
49    automatically force in-head install. If not sure, don't even try this,
50    because most of the time it will be (probably) broken.
51
52    The last {newrelickey} part is optional, if you wish to install
53    and auto-magically enable both New Relic Apps and Server Monitor.
54    It must be a valid New Relic license key - even if it is their
55    free Lite option.
56
57    # Stable on public server - prompt for every platform install
58    $ boa in-stable public server.mydomain.org my@email o1
59
60    # Stable on public server - no prompt with 3xD6 + 3xD7 + Atrium only
61    $ boa in-stable public server.mydomain.org my@email o1 mini
62
63    # Stable on public server - no prompt with all platforms and New Relic
64    $ boa in-stable public server.mydomain.org my@email o1 max newrelickey
65
66    To install HEAD instead of Stable, use the same commands, but
67    replace "in-stable" with "in-head"
68
69    To install Legacy version instead of Stable, use the same commands, but
70    replace "in-stable" with "in-legacy"
71
72    The Legacy version is currently the last Edition in the 2.1.x series, and
73    will move gradually to 2.2.x series when 2.3.x will be released. It still
74    supports Drupal 5 and uses Drush 4 along with older Aegir version.
75
76    Note that once you will install current Stable or HEAD, you can't
77    downgrade back to Legacy version!
78
79
80 ### Installing BOA system on localhost
81
82 1. Please read docs/NOTES.txt
83
84 2. Download and run BOA Meta Installer.
85
86    $ wget -q -U iCab http://files.aegir.cc/BOA.sh.txt
87    $ bash BOA.sh.txt
88
89 3. Install Barracuda and Octopus.
90
91    You must specify the kind of install with {in-stable|in-head},
92    location with {local|public}, and your e-mail address,
93    as shown below. For local installs you don't need to specify
94    hostname and Octopus username, as it is fully automated.
95
96    The last {ask|mini|max} part is optional, if you wish to control
97    Octopus platforms install mode, as explained below - none is
98    the same as "ask".
99
100    # Stable on localhost - prompt for every platform install
101    $ boa in-stable local my@email
102
103    # Stable on localhost - no prompt with 3xD6 + 3xD7 + Atrium only
104    $ boa in-stable local my@email mini
105
106    # Stable on localhost - no prompt with all platforms installed
107    $ boa in-stable local my@email max
108
109    To install HEAD instead of Stable, use the same commands, but
110    replace "in-stable" with "in-head"
111
112    To install Legacy version instead of Stable, use the same commands, but
113    replace "in-stable" with "in-legacy"
114
115    The Legacy version is the last Edition in the 2.2.x series which still
116    supported Drupal 5 and used Drush 4 along with older Aegir version.
117    Note that once you have current stable or head installed, you can't
118    go back to legacy version.
119
120
121 ### Installing more Octopus instances
122
123 You can either run OCTOPUS.sh.txt directly or just run the same boa command
124 again with new usernames - it will run Barracuda upgrade first and then
125 new Octopus instance install - automatically.
126
127 Example:
128
129    $ boa in-stable public server.mydomain.org my@email o2 mini
130    $ boa in-stable public server.mydomain.org my@email o3
131    $ boa in-stable public server.mydomain.org my@email o4 max