(PLEASE NOTE: This is a wiki page so you can edit it if you are logged into and part of the group.)
Aegir is a powerful system that sits on a LAMP server to create, deploy and manage Drupal sites. Once installed you can setup a drupal site in a few clicks - with Aegir setting up the apache config files and the MySQL database.
Aegir is in development, but is stable enough that many are already using the Release Candidates in production environments.
This documentation will tell you what you need to know to get Aegir setup and running.
Installing Aegir
The documentation is meant to work "everywhere". INSTALL.txt features examples for Debian but should be comprehensible to any administrator with minimal experience. HINTS files are also now provided as quicker install instructions for other platforms than Debian.
If you encounter problems during the install, see if the issue already has been reported and if not, report the issue. We are committed to keeping the install instructions as clean and platform-independent as possible, but for this we need wide testing and proper bug reports.
0.3 stable release
* Debian-based instructions (the canonical INSTALL.txt instructions, that should work everywhere)
There's also an unsupported shell script to automate the install on Debian.
0.4-alpha14 development release
This release is targeted at the more adventurous users or basically people that want to play with the latest features. It's not considered production ready.
platform agnostic script
As part of the install process, you will require the use of install.sh near the end of the install to deploy the required modules and packages. The install.sh is platform-agnostic.
Debian-based instructions
Visit Generic, the canonical INSTALL.txt instructions
CentOS and alikes
These instructions should also work on RHEL or Fedora CentOS instructions
- CentOS HINTS recommends using Jason Litka's Utter Ramblings repository to install php 5.2.x.
-
Bwood recommends the IUS Community repository over jasonlitka for these reasons:
- jasonlitka is at 5.2.11 which has security issues
- the dom extension is not installed in litka's php, but is present in the IUS php
- Jason Litka appears to be one (very nice) guy, but IUS is a organized group associated with Rackspace Hosting. For more info: How to set up the IUS Community repository
Solaris
Visit Solaris instructions
Other OSs
If you have a platform not featured above, follow INSTALL.txt and submit a HINTS file similar to the CentOS one above.
The bleeding edge: the git master branch
The git master branch is where all development work gets worked on, or merged in from other development branches in git. It's generally considered stable, but it's really not production ready and is aimed at developers and testers. See the git documentation for more information.
* Generic, Debian-based instructions (the canonical INSTALL.txt instructions)
* CentOS instructions (should also work on RHEL or Fedora)
* Solaris instructions
* If you have a platform not featured above, follow INSTALL.txt and submit a HINTS file similar to the CentOS or Solaris one above.
As part of the install process, you will require the use of install.sh near the end of the install to deploy the required modules and packages. The install.sh is platform-agnostic.
Using Aegir
1. Aegir is installed - what next?
a. Setting up a 'Platform'
b. Import an Existing Website
c. Setup a new Website
d. DNS Wildcard configuration
e. Migrate / Upgrade Websites
f. Delete a Website
2. Advanced Features
a. Multi-user access control with the 'Clients' Feature
b. How to configure SSL/HTTPS on Aegir
c. Configuring Multiple Web Servers
e. Manually move sites between servers
f. How to configure site aliases and domain redirection on Aegir
g. Customizing Site Settings in an Aegir Environment
3. Contrib Features
a. Ubercart Integration
Understanding Aegir
a. Aegir Architecture (schematic)
b. Aegir File System Structure
Upgrading Aegir
The upgrade instructions are kept up to date in UPGRADE.txt.
Uninstalling Aegir
WARNING: Performing these steps will remove Aegir from your server and may result in loss of data. Use with caution.
- Backup anything you need to keep from the /var/aegir/ directory
- Remove the /var/aegir/ directory:
rm -rf /var/aegir/ - Remove the aegir user's crontab:
crontab -r -u aegir - Delete the aegir user:
userdel aegir - Drop the database(s) and db user(s)
- Delete the symlink/include to the aegir directory from /etc/apache2/conf.d/ (if it exists)
FAQ
If you have trouble or have questions about Aegir, please see if your question wasn't already answered in the FAQ.
Troubleshooting
As a developing technology, Aegir occasionally encounters a problem. The FAQ are the next place to look for troubleshooting help.
A Platform or Site Fails to Install or Verify :: Forcibly Deleting a Defective Site or Platform
Platform and site creation can fail for a number of reasons, leaving a platform or site visible in the Aegir front-end but not usable. Retries of platform and site verification and installation likewise may fail. When a platform or site has not been created, installed, and verified successfully, Aegir likely will not be able to delete the platform or site.
This Post explains how to forcibly delete a site or platform.
Bug Reporting
See the bug reporting guidelines.
Getting Involved
Finding bugs, testing patches and helping out
Developer Documentation
Git access to the code
Release process
Design documents
1. Project Goals
2. Project Roadmap
3. Aegir Design & Terminology
Getting Help
The Issue Queue for all the projects that make up Aegir is here.
This is the first place to look after the FAQ - chances are someone's had the same problem as you before, and you'll get the quickest answers by searching for what they discovered.
Before asking a question or reporting an issue, you should read the bug reporting guidelines.
You can join the #aegir channel at Freenode on IRC. (IRC instructions for drupal users are at: http://drupal.org/irc). It's a friendly community, but a small one, so ask nicely and be patient!
Some users have posted their experiences and tips for installing Aegir on specific systems:
* RedHat EL: http://groups.drupal.org/node/20433
* CentOS 5: http://groups.drupal.org/node/19170
Credits
Aegir's core developers are adrian (Vertice), anarcat and mig5.
Documentation by: steveparks (pilot), mig5 and other helpful volunteers editing these wiki pages :)
A Video Presentation of Installation of Aegir
Installing Aegir - A live presentation from Drupal camp (external link but useful)(for Aegir 0.4 Alpha 5)
Outdated documentation
This documentation was produced in early releases and no longer applies.
1. Manual Installation: a/ Preparing a server for Aegir (applies only to 0.3, and doesn't work anymore)
2. Manual Installation: b/ Install Aegir (applies only to 0.3, and doesn't work anymore)
3. Auto Installation: Install Aegir Using the Shell Install Script (applies only to 0.3, and doesn't work anymore)
4. Installing Aegir - The Movie! (ext. link)(outdated: only relevant to 0.2)