Installation requires that Drush is installed, Git is installed, and you have your database credentials (user name and password) available.
You can check whether git is already installed by typing
If you get output showing you your git version you are all set. If you get "command not found," git is not installed.
Step #1: Decide Which Luggage Is Right For You
If you are using Luggage to develop at Iowa State University, you should use Luggage ISU.
Else, you should use Luggage and in fact fork it to a Luggage that will be specific to your institution. In your fork, you can then add your own default theme and other modifications.
Step #2: Getting Luggage
A prerequisite for the following is that you need to have a Github account set up with ssh keys. This is a one-type task that will make your relationship with Github much happier.Github has step-by-step instructions.
Open a bash terminal and type in the following git command:
git clone email@example.com:isubit/luggage_isu.git
You now will have a directory called "luggage_isu" that you can navigate into:
Step #3: Building Luggage
There are two ways to install Luggage, the automated way via the build scripts or the manual way via individual commands.
The Automated Way
Luggage comes pre-packaged with build scripts, which are located in the scripts directory.
If you are building Luggage ISU, you can build via the build_luggage_isu.sh script:
cd /path/to/luggage_isu bash ./scripts/build_luggage_isu.sh
The script attempts to figure out your database user name and password from the $DBCREDS environment variable that you may have set. If the script cannot figure out those credentials, you will be prompted for them.
Note: Luggage ISU also contains the regular Luggage build script, build_luggage.sh. Do not run this script if you are at ISU. Run build_luggage_isu.sh instead.
The Manual Way
Although we recommend using automated installation, you might want to go through the steps manually so you understand what is happening. Luggage is Drupal at its core so installation closely resembles the installation of Drupal. In short, the steps include:
- Fetching the code for the Git submodules
- Installing Drupal, via Drush or the web browser
- Enabling Luggage features
- Resetting the cache and reverting the features to a known clean state
If you look at the build scripts, you will see that they closely follow this pattern. Lets run through this in more detail:
Fetching the code for the Git submodules
From the root of your newly cloned luggage_isu repo run:
git submodule update --init --force
This command iterates over each "submodule" defined in the `.gitmodules` file located at the root of the repo and pulls in the latest code. Git submodules track a commit hash so by "the latest code" it really means the code associated with the hash that the repo is tracking. Travel to the luggage features directory to see an example.
Installing Drupal, via Drush or the web browser
The quickest way to install an instance of Drupal is to use the Drush "site install" command. In the Luggage install scripts you will find the command:
drush $ALIAS si minimal -y --db-url=mysql://$DBCREDENTIALS@localhost/$BASENAME --site-name=$BASENAME --account-name=adminn install_configure_form.update_status_module='array(FALSE,FALSE)'
Substitute the appropriate values for each variable and run the command.
Refer to the Drush documentation for the site-install command for your version of Drush.
If you want to use the web browser, follow the online documentation on Drupal.org.
Enabling Luggage features
The quickest way to install Luggage features is via Drush. The features are just Drupal modules that use the Features module to package configuration along with the modules, so they can be installed via the browser at the path "../admin/structure/features." To install via Drush:
drush en luggage_[feature name] -y
For example, to enable the luggage_seo feature:
drush en luggage_seo -y
or for all features:
drush en luggage_* -y
Resetting the cache and reverting the features
The final step is to make the database align with the configuration that is defined in the features.
drush fra -y
Which stands for "feature revert all," and reverts all of the features to their original state defined by the code.
Then clear caches:
drush cc all
At this point your Luggage should be available.
Step #4: Viewing Luggage
Once the build script completes, the last line of output will be a login link that you can use to login as user 1, or the root user. The link will probably look something like this:
Now, copy everything from "/user" and on:
Then open your browser of choice, then navigate to "luggage" on your local webserver and append the text string to the end of the url. The final string should look something like the following:
Press enter. You will now be logged in as the admin user and are freely able to configure Luggage as you please!