Stable BOA-2.2.3 Release - Full Edition
[project/barracuda.git] / README.txt
1
2 ### README
3
4 All-in-one bash scripts (see docs/INSTALL.txt for details)
5 to install and/or upgrade high performance Aegir Hosting Systems
6 for Drupal, with Nginx, PHP-FPM, Zend OPcache, MariaDB and Redis,
7 now available with simple command line tools: http://bit.ly/JHpFSh
8
9
10 ###--------------------------------------------------------------###
11 ###
12 ### For BOA installation instructions see docs/INSTALL.txt
13 ### See also related information in docs/NOTES.txt
14 ### For BOA upgrade instructions see docs/UPGRADE.txt
15 ### For how-to on using MultiCore Solr Jetty see docs/SOLR.txt
16 ### For custom Nginx rewrites how-to see docs/HINTS.txt
17 ### For SSL and extra IPs how-to see docs/SSL.txt
18 ### For sites migration between instances see docs/REMOTE.txt
19 ###
20 ### Please read all comments for configuration options in both
21 ### BARRACUDA.sh.txt and OCTOPUS.sh.txt, since there is information
22 ### not included in the README or INSTALL and can be modified or
23 ### updated with every new Edition.
24 ###
25 ###--------------------------------------------------------------###
26
27
28 You can install one Aegir Master Instance on your server using
29 Barracuda and any number of Aegir Satellite Instances using
30 Octopus installer.
31
32 Note: the 'Master' and 'Satellite' names in the Barracuda/Octopus
33 context are not related to the multi-server Aegir features.
34 It is related to the multi-Aegir-instances environment, with
35 virtual chroot/jail for every Aegir instance.
36
37 Barracuda is the main script for the Aegir Master Instance system
38 install and upgrades, including OS env and main Aegir instance,
39 but no platforms will be added there to keep it compatible
40 with all existing and future installs, when you don't need
41 any ready to use platforms and instead you are using the system
42 for managing your own imported platforms/sites.
43
44 Octopus is an Aegir + Platforms installer (you can interactively
45 choose the platforms you wish to install on the instance)
46 and updater only. It allows to install new versions of platforms
47 with clean directory structure, with code shared between all created
48 instances, so one vanilla Octopus instance is using only ~18 MB,
49 while most of the code, which is over 1700 MB total, is shared.
50
51 Sharing the code between instances is of critical importance,
52 because it allows you to dramatically lower RAM and CPU usage,
53 because most of the actively used code is opcode cached.
54
55 With multi-install system you have to remember that all of them
56 will use the same Nginx server, so you could break the system
57 trying to install site with the same domain on two or more instances.
58 The instances will not be aware of other running instances,
59 so it is your responsibility to use such system wisely.
60
61 There is also Tuner script available (see aegir/tools/BOND.sh.txt)
62 for easy system tuning for development and switching it back easily
63 to the standard production settings.
64
65
66 ### SUPPORTED PARENT SYSTEMS
67
68 * Xen, VServer, Linux KVM or VMware based VPS or a dedicated box.
69 * VirtualBox VM for localhost install - check the how-to for:
70   Ubuntu Precise desktop image install: http://bit.ly/boa-precise
71   Debian Squeeze desktop image install: http://bit.ly/boa-squeeze
72
73
74 ### SUPPORTED LTS OS 32/64bit - Minimal on server or Desktop on localhost
75
76 * Debian 7 Wheezy (recommended)
77 * Debian 6 Squeeze (fully supported) (automatic upgrade to Wheezy supported)
78 * Ubuntu Trusty 14.04 (very limited support)
79 * Ubuntu Precise 12.04 (very limited support)
80 * Ubuntu Lucid 10.04 (very limited support)
81
82 NOTE: BOA maintainers currently use Debian 6 Squeeze, but for new installs
83       we recommend Debian 7 Wheezy. We don't use and rarely test Ubuntu,
84       so if you have any good reason to use Ubuntu, don't blame us
85       if it will not survive next upgrade. We are trying to include it as
86       (barely) supported OS only for those who can't use Debian because of
87       company or organization policy etc. But we strongly suggest to avoid
88       Ubuntu and instead use Debian, wherever possible, for best results.
89
90
91 ### PREVIOUSLY SUPPORTED OS (deprecated)
92
93 * Debian 5.0 Lenny (automatic upgrade to Squeeze supported)
94 * Ubuntu Oneiric 11.10
95 * Ubuntu Natty 11.04
96 * Ubuntu Maverick 10.10
97 * Ubuntu Karmic 9.10
98 * Jolicloud Robby
99
100
101 ### OTHER REQUIREMENTS
102
103 * Wget must be installed.
104 * The Git standard port 9418 must be open.
105 * SMTP standard port 25 (or SMTP relay) must be open for outgoing connections.
106 * Minimum 512 MB of RAM (1 GB for heavy distros, like Atrium 2, Commerce etc.)
107 * Locales with UTF-8 support, otherwise en_US.UTF-8 (default) is forced.
108 * Basic sysadmin skills and experience.
109
110
111 ### PROVIDES
112
113 === Included by default - see docs/NOTES.txt for details
114
115 * All libraries & tools required to install and run Nginx based Aegir system.
116 * Latest release of MariaDB 5.5 database server with Chive manager.
117 * Latest version of Nginx web server.
118 * PHP-FPM 5.5, 5.4, 5.3 - multi-install mode, configurable per Octopus instance.
119 * PHP extensions: Zend OPcache, PHPRedis, UploadProgress, MailParse and ionCube.
120 * Fast Redis Cache with DB auto-failover for all 6.x and 7.x platforms.
121 * Fast Redis Lock support with DB auto-failover for all 6.x and 7.x platforms.
122 * Fast proxy DNS server (pdnsd) with permanent caching.
123 * Limited Shell, SFTP and FTPS separate accounts per Octopus instance.
124 * Limited Shell, SFTP and FTPS accounts per Aegir Client with per site access.
125 * Drush access on command line in all shell accounts.
126 * Drush Make access on command line for main shell account only.
127 * HTTPS access with self-signed certificate for all hosted sites.
128 * Magic Speed Booster cache, working like a Boost + AuthCache, but per user.
129 * Entry level XSS built-in protection on the Nginx level.
130 * Firewall csf/lfd integrated with Nginx abuse guard.
131 * PHP errors debugging, including WSOD, enabled on the fly on dev. aliases.
132 * Boost, AdvAgg, Domain Access and Drupal for Facebook built-in support.
133 * Built-in collection of useful modules available in all platforms.
134 * Autonomous Maintenance & Auto-Healing scripts in /var/xdrago.
135 * Every 10 seconds uptime/self-healing local monitoring.
136 * Automated, rotated daily backups for all databases in /data/disk/arch/sql.
137
138 === Optional add-ons - see docs/NOTES.txt for details
139
140 * MultiCore Apache Solr 1.4.1 with Jetty 7 - see docs/SOLR.txt for details.
141 * MultiCore Apache Solr 3.6.2 with Jetty 8 - see docs/SOLR.txt for details.
142 * MultiCore Apache Solr 4.2.0 with Jetty 8 or Jetty 9 on Precise and Wheezy.
143 * New Relic Server and Apps Monitor with per Site/Instance/Server reporting.
144 * LDAP Nginx support via third-party module.
145 * SPDY Nginx support.
146 * PFS (Perfect Forward Secrecy) support in Nginx.
147 * MongoDB driver for PHP 5.3
148 * GEOS extension for PHP 5.3 (experimental).
149 * FFmpeg support.
150 * Bind9 DNS server.
151 * Webmin Control Panel.
152 * SQL Buddy database manager.
153 * Collectd server monitor.
154 * Compass Tools.
155
156
157 ### OCTOPUS PLATFORMS
158
159 Octopus can install the platforms listed below:
160
161 ### Drupal 7.27.1
162
163  Commerce 1.24 ---------------- https://drupal.org/project/commerce_kickstart
164  Commerce 2.13 ---------------- https://drupal.org/project/commerce_kickstart
165  Commons 3.9.1 ---------------- https://drupal.org/project/commons
166  Drupal 7.27.1 ---------------- https://drupal.org/drupal-7.27
167  Guardr 1.3 ------------------- https://drupal.org/project/guardr
168  Open Academy 1.0 ------------- https://drupal.org/project/openacademy
169  Open Atrium 2.17 ------------- https://drupal.org/project/openatrium
170  Open Deals 1.32 -------------- https://drupal.org/project/opendeals
171  Open Outreach 1.5 ------------ https://drupal.org/project/openoutreach
172  OpenBlog 1.0-a3 -------------- https://drupal.org/project/openblog
173  OpenChurch 1.12 -------------- https://drupal.org/project/openchurch
174  OpenScholar 3.12.1 ----------- http://theopenscholar.org
175  Panopoly 1.2 ----------------- https://drupal.org/project/panopoly
176  Recruiter 1.2 ---------------- https://drupal.org/project/recruiter
177  Spark 1.0-b1 ----------------- https://drupal.org/project/spark
178  Totem 1.1.2 ------------------ https://drupal.org/project/totem
179  Ubercart 3.6 ----------------- https://drupal.org/project/ubercart
180
181 ### Pressflow 6.31.1
182
183  Commons 2.16 ----------------- https://drupal.org/project/commons
184  Feature Server 1.2 ----------- http://bit.ly/fserver
185  Managing News 1.2.4 ---------- https://drupal.org/project/managingnews
186  Open Atrium 1.7.2 ------------ https://drupal.org/project/openatrium
187  Pressflow 6.31.1 ------------- http://pressflow.org
188  Ubercart 2.13 ---------------- https://drupal.org/project/ubercart
189
190 All D7 platforms have been enhanced using Drupal 7.27.1 +Extra core:
191 https://github.com/omega8cc/7x/tree/7.x-om8
192
193 All D6 platforms have been enhanced using Pressflow 6.31.1 +Extra core:
194 https://github.com/omega8cc/pressflow6/tree/pressflow-plus
195
196
197 ### BUG SUBMISSION
198
199 * Please follow bug submission guidelines:
200
201   Before you submit a bug, make sure you have diagnosed your
202   configuration as documented in this guide:
203   http://groups.drupal.org/node/21890. It is Aegir specific,
204   but the good rules are the same: always search for similar
205   bug report before submitting your own, and include as much
206   information about your context as possible, especially
207   please include, using http://gist.github.com, the contents
208   (anonymized for security and privacy) of files:
209
210     /root/.barracuda.cnf
211     /var/log/barracuda_log.txt
212     /root/.USER.octopus.cnf
213     /data/disk/USER/log/octopus_log.txt
214
215 * Issue queues:
216   https://drupal.org/project/issues/barracuda (active)
217   https://drupal.org/project/issues/octopus (active)
218   https://github.com/omega8cc/boa/issues (active)
219
220   Please don't post your server logs here. Instead use
221   http://gist.github.com and post the link in your submission.
222
223 * Patches:
224   https://github.com/omega8cc/boa/ (main repository)
225
226
227 ### REPOSITORIES
228
229 * https://github.com/omega8cc/boa/ (main)
230 * https://drupal.org/project/barracuda (mirror)
231 * https://drupal.org/project/octopus (mirror)
232 * https://code.aegir.cc/aegir (mirror)
233
234
235 ### MAINTAINERS
236
237 * https://omega8.cc
238
239
240 ### HELP
241
242 * Join us at: https://groups.drupal.org/boa
243               http://community.aegirproject.org
244               http://groups.drupal.org/nginx
245
246
247 ### CREDITS
248
249 * Brian Mercer - https://drupal.org/user/103565
250   Initial work: https://drupal.org/node/244072#comment-1747170
251
252 * Nice people who are submitting bugs and problems in the
253   Barracuda/Octopus issue queues.
254