Resources for Drupal Developers and Site Administrators

Resources for Drupal Developers and Site Administrators

Learn how to administer or build Drupal sites at GT. Read on for knowledge, tools, and best practices shared by Drupal developers from across campus.

Much of the content below is for Drupal 7, but we're slowly adding Drupal 8 relevant information throughout – check the "Drupal Version" tag on a page to see the version(s) for which it is applicable. For the time being, Drupal 8 specific guides, tips, and tricks, can be found in their own section.

Get involved: consider joining our helpful mailing list and attending our fascinating monthly meetings.

Sections

root Tue, 03/12/2013 - 15:56

Where Do I Begin?

Where Do I Begin? kp37 Thu, 09/26/2019 - 13:28
Drupal Version

Whether you are an experienced Drupal developer / site administrator who has come to Georgia Tech, or an existing staff member asked to venture into the world of Drupal, you may be wondering how you should get started with using Drupal for a Georgia Tech website.

What Version of Drupal Does Georgia Tech Use (and What Should I Use)?

At this time, much of campus uses Drupal 7, and many of those Drupal 7 instances use a custom distribution known as Drupal Express. While Drupal 7 and Drupal Express are still supported, you may be aware that the current release of Drupal is version 8, and that version 9 is slated to be released in mid-2020.

If you are familiar with Drupal 8, are savvy with backend coding, and want to be ahead of the curve, then you will likely want to look at Drupal 8 for any new websites.  Some of the necessary campus specific tools for Drupal 8 are now available, though they are not completely mature yet. GUI based access to Composer for managing Drupal 8 sites is now available on central OIT Web Hosting accounts, and there is a way for the experienced backend developer to access it from the command line.

If you are not already familiar with Drupal 8, the campus Drupal Express distribution of Drupal 7 is a perfectly usable option. However, you should try to avoid certain pieces of it as much as possible to make your eventual upgrade to Drupal 8 go smoother.  Specifically, the Horizontal Landing PageVertical Landing Page, and Multipurpose Page content types are custom designs that are not going to be available in Drupal 8, nor will Super Blocks, another custom design tool made just for Georgia Tech.  If you can get by building only Basic pages for now, you'll have less work to do when you upgrade to Drupal 8.

Sounds Good, How Do I Get Started?

The Installing Drupal section of this handbook offers advice on selecting a place to host your site and getting through the initial Drupal installation and configuration.  Some people like to set up a development site on their own local computer, and that topic is covered in the Installing Drupal section as well.  If you choose to develop in a hosting area separate from where your final site will be hosted, the Moving a Site to OIT Web Hosting section may be helpful, even if you're not actually moving the site to OIT Web Hosting.

Before and after you deploy your new site, be sure to review our Best Practices Checklist to make sure your site is secure and streamlined.

As you continue developing and maintaining your site, the rest of this developer's handbook can provide useful insights, helpful tips and troubleshooting guides, and pointers to additional information.  You can also join the Georgia Tech Drupal Team in Microsoft Teams and/or the Georgia Tech Drupal Mailing List, or join us at our regular meetings and drop-in help sessions for assistance.

Installing, Upgrading (and Migrating) Drupal Sites

Installing, Upgrading (and Migrating) Drupal Sites kp37 Tue, 03/26/2019 - 18:52
Drupal Version

This section contains tips on how to install Drupal from scratch, how to apply routine point release updates, and how to migrate between major version of Drupal.  There is also a guide to moving sites from development (either on your local computer, or on a development server) to a production environment (e.g. OIT Web Hosting).  For more generic but also more official guidance, the official Drupal website has a Guide to Migrating a Drupal Site.

Please be cautious in using any of the information provided here in conjunction with upgrading or migrating a production Drupal site:  always make backups of your live production site first, so that if anything goes wrong, you can revert back to the old version of the site.

Installing Drupal

Installing Drupal root Tue, 12/04/2012 - 13:17
Drupal Version

This section contains guides to help you with installing a new copy of Drupal.  Information on updating and upgrading existing Drupal sites can be found elsewhere in the handbook.

Where to Host Your Drupal Site?

Where to Host Your Drupal Site? esembrat3 Fri, 03/15/2013 - 14:18
Drupal Version

There are a number of ways you can host your Drupal site on campus, which is strongly suggested for any unit-level website.

All units can take advantage of the central OIT Web Hosting service.  This service can host many popular PHP based content management systems, including Drupal and WordPress.  For those looking to quickly setup a unit-level website, OIT Web Hosting now supports Drupal Express, which will give you a jump start on building a Drupal based website by installing Drupal plus a number of standard add-on components, such as the official Georgia Tech website theme.

Should you choose not to use OIT's services, some Schools, Colleges, and other units have their own externally hosted or internally housed servers for web hosting. You should consult with the local IT representatives within the group to see if this is available.  In some cases, you may still be able to make use of Drupal Express by using the generic version of the Drupal Express installation script.

Installing Drupal to an OIT Web Hosting Account

Installing Drupal to an OIT Web Hosting Account kp37 Wed, 03/23/2016 - 16:19
Drupal Version

The following steps should guide you in getting a Drupal installation set up in an OIT Web Hosting account.  They have been updated for Drupal 8 – if you are needing to create a new Drupal 7 site, there is a separate page of instructions for installing Drupal 7 to OIT Web Hosting.

Should I Use Drupal 8 on OIT Web Hosting Yet?

Please see the OIT FAQ guide Is Drupal 8 the right choice of CMS for my site?

Before You Begin

If you haven't done so already, you'll need to request a hosting account from OIT.  You will also need to know how to access the Plesk control panel for your account in order to complete the rest of these steps, and you may also wish to set an SSH password so that you can SSH into your web hosting space.

If you decide to set up Drupal somewhere else to build your site, and now want to move that site to OIT Web Hosting, you should see our separate Site Migration Guide.

Installing Drupal 8 Using GitHub and Composer

Please see the following OIT FAQ guides:

Installing Drupal 8 Manually From a Downloaded Archive File

Another way to install Drupal is to download the installer and copy it to your hosting account.

  1. Visit the Drupal.org website and download the latest version of the Drupal 8.x series for any site that needs to have standard Georgia Tech branding.
    • Use the latest stable release of Drupal 8, ideally 8.8.1 or later.
    • If your are comfortable with using SSH to connect to your Web Hosting account, you can select either download format (.tar.gz or .zip).  If you prefer to upload the archive file to your Web Hosting account via the Plesk control panel, you must download the ZIP format file.

  2. Upload the archive file to your OIT Web Hosting Account and unpack it where you want your Drupal installation to live.  From within the Plesk control panel, you can upload the archive file via the File Manager.  Once the file is uploaded, just select it in the File Manager to unpack it.  After the archive file has been unpacked, move it to your hosting account's "/private/" folder.

  3. In the Plesk control panel, go to the Databases manager and create a new database.  Copy down the database name, the database user name, and the password, as you will need them later.

  4. Navigate to your Web Hosting site's URL and you should get an installation screen for Drupal.  Follow the prompts and answer the questions - they should mostly be straightforward.  Refer to the Drupal Installation Guide if you need any help.

Installing Drupal 7 to OIT Web Hosting

Installing Drupal 7 to OIT Web Hosting kp37 Wed, 02/26/2020 - 15:58
Drupal Version

The following sections describe options for setting up Drupal 7 on OIT Web Hosting.  These steps will give you a generic Drupal 7 installation – if you'd rather start with a more turnkey configuration, you may want to look at Drupal Express.

Installing Drupal Using Installatron

The quickest way to get Drupal setup is to use the Installatron Applications Installer, which will download and setup Drupal for you.

  1. From the front page of the Plesk control panel, look for the Installatron Applications Installer link on the right-hand side of the page.
  2. Under the heading "Apps for Content Management", look for and select the Drupal blue water drop icon (the text underneath reads 'Drupal cms'. 
  3. You can read about Drupal on the next page and view the live demo if you like.  When you are ready to install, look for the drop-down in the top right section of the page with a big blue plus symbol and the words "install this application"
  4. On the next page answer all of the questions about your installation.  Details on some of the more notable settings are given below:
    • Version:  You should install the latest 7.x version, as it the only version currently supported by the Georgia Tech Drupal Theme and other GT Drupal modules.  Do not under any circumstances select a version earlier than 7.65, and only select an 8.x version if you are setting up a site that doesn't have to have full Georgia Tech branding and you are already familiar with and comfortable with supporting the 8.x version of Drupal.
    • Automatic Update and Automatic Update Backup:  You can leave these settings at their defaults unless you have a good reason for changing them.
    • Administrator Username and Administrator Password:  These have been randomly generated, but you can change them if you prefer.  Avoid using 'admin' or 'administrator' for the username - something more unique provides a little better security.
    • Administrator Email:  Set this to an email address that someone will be watching (ideally yourself).  The default will be for the mailing list that sends to everyone who is an owner or administrator for your OIT Web Hosting account.
    • Advanced:  Most of these can be left alone.  However, you may wish to select Let me manage these settings and then under Email Notification choose Let me choose which notifications are sent and uncheck some of the options.  Otherwise, you may get quite a bit of email from Installatron about your application.  For example, you may prefer to uncheck all of the "*Something* Complete" options so that you only get emails when an operation fails or when updates come available.
  5. Select the Install button at the bottom of the page to complete your installation.
  6. Once installation is complete, you can visit your site's URL to log into your Drupal installation and start configuring it and adding content.

Installing Drupal Manually From a Downloaded Archive File

Another way to install Drupal is to download the installer and copy it to your hosting account.

  1. Visit the Drupal.org website and download the latest version of the Drupal 7.x series for any site that needs to have standard Georgia Tech branding.
    • Do not under any circumstances select a version earlier than 7.65, and only select an 8.x version if you are setting up a site that doesn't have to have full Georgia Tech branding and you are already familiar with and comfortable with supporting the 8.x version of Drupal.
    • If your are comfortable with using SSH to connect to your Web Hosting account, you can select either download format (.tar.gz or .zip).  If you prefer to upload the archive file to your Web Hosting account via the Plesk control panel, you must download the ZIP format file.
  2. Upload the archive file to your OIT Web Hosting Account and unpack it where you want your Drupal installation to live.  From within the Plesk control panel, you can upload the archive file via the File Manager.  Once the file is uploaded, just select it in the File Manager to unpack it.  After the archive file has been unpacked, move it to your hosting account's "/private/" folder.
  3. In the Plesk control panel, go to the Databases manager and create a new database.  Copy down the database name, the database user name, and the password, as you will need them later.
  4. Navigate to your Web Hosting site's URL and you should get an installation screen for Drupal.  Follow the prompts and answer the questions - they should mostly be straightforward.  Refer to the Drupal Installation Guide if you need any help.
    • IMPORTANT NOTE:  When entering your database information you must enter "mysql.localhost" as the server name.  This in an artifact of the way that the OIT Web Hosting Servers are set up.

Installing Drupal on Your Own Computer

Installing Drupal on Your Own Computer esembrat3 Fri, 07/19/2013 - 15:10
Drupal Version

Drupal can be locally installed by using the Acquia Dev Desktop application. Read Eric Sembrat's excellent Local Dev Environments slides about your other options.

Purpose

Acquia Dev Desktop installs a functional local web server on your machine and allows you to easily create, edit, and remove multiple Drupal sites using their user interface.

Potential Uses

  • Testing new patches or major upgrades.
  • Testing out new themes or modules.
  • Module or theme development.
  • Stress-testing a site.
  • Getting familiar with Drupal.

Expert Local Development Guides

How to Setup a Mac OS X / macOS System for Local Development

How to Setup a Mac OS X / macOS System for Local Development bwaye3 Tue, 10/07/2014 - 09:08
Drupal Version

This process allows you to set up your Mac as a faux-server for local development.

  1. Download XCODE from the App Store: https://developer.apple.com/xcode/
  2. Install command line tools: http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/
  3. Install and configure WGET: http://coolestguidesontheplanet.com/install-and-configure-wget-on-os-x/
  4. Download wgethttp://ftp.gnu.org/gnu/wget/wget-1.15.tar.gz

How to Install Acquia Dev Desktop as a Local Development Environment

How to Install Acquia Dev Desktop as a Local Development Environment afrank30 Wed, 11/26/2014 - 09:28
Drupal Version

With the Acquia Dev Desktop (ADD) tool, you can easily and quickly set up a local development environment for Drupal on your computer.

Install Acquia Dev Desktop (ADD)

This handy, easy-to-install software is the fastest way to Drupal on your own computer! It includes all the pieces you need to run Drupal on Mac or Windows. With Acquia Dev Desktop, you can develop and test locally, then export to your server(s).

Make sure to write down where you install this on your computer (so you can find it later) and which default username and password you choose.

Add new ADD site

You can add a fresh new Drupal 7 site in Acquia Dev Desktop by clicking: Settings > Sites > New. (See Acquia's documentation for more information).

In this example, we will leave all the default settings for acquia, and change only the "Site name" (to "oit").

Using the DX Shell Script with ADD

See instructions on how to use ADD with the Drupal Express Shell Script.

How to Use the Drupal Express Shell Script on your computer with Acquia Dev Desktop

How to Use the Drupal Express Shell Script on your computer with Acquia Dev Desktop afrank30 Tue, 11/10/2015 - 09:41
Drupal Version

The following instructions are for using the Drupal Express Shell Script on your local computer to test Drupal site settings. These partially-complete instructions use Acquia Dev Desktop (ADD) and have only been tested on a Mac. (The author would be super grateful is someone could test on Windows and share any problems they encounter!)

Install Acquia Dev Desktop (ADD)

We have a separate page detailing ho to install Acquia Dev Desktop on your computer.

Prepare Your Folders and Files

  • Change the permissions to allow "Writing" for your new site's folder (oit.localhost), so that you can make changes.
  • Delete all the folders and files underneath "oit.localhost" (except settings.php).
  • (Optional) Decide if you want to delete any acquia modules (under profiles/acquia/modules), such as acquia_connector
  • (Optional) Decide if you want to add any modules you commonly use to sites/all/modules.

Empty Your Database

  • Choose the "Manage my database" option in Acquia Dev Desktop.
  • Select the "Check ALL" option at the bottom of the view for this site's database only, and choose "Drop". This will remove all the tables from this database.

Copy DX Database

Download the DX SQL.

Using phpmyadmin, follow the instructions in the README file, starting at "Import SQL file into your database" for the database ADD created for you (oit). This will make sure your user account (gburdell1) can log in to your new site.

Copy DX Files

Download the DX Files and then replace all the files and folders underneath "oit.localhost" (except settings.php).

Run update.php

In your settings.php file, find the line that says $update_free_access = FALSE; and change the "FALSE" to "TRUE". Save your settings.php file (you will need to change this back at the end).

Using the Acquia popup box, choose "Go to my site" (while the site chosen is your new oit.localhost site).

At the end of the web address it sends you to (such as oit.localhost), add "update.php" and hit Return. Run updates as you might normally on a Drupal site.

Change File System

Once finished updating, change the value in your settings.php file back to $update_free_access = FALSE;.

The design of the site won't look quite right until you change your site's file system (which was automatically set in the GT Editor module) by logging in to the site and visiting: admin/config/media/file-system

Change the "default" folder in each of these three paths to your site (oit.localhost):

  • Public file system path:sites/default/files, becomes sites/oit.localhost/files
  • Private file system path: sites/default/files/private, becomes sites/oit.localhost/files/private
  • Temporary directory: sites/default/files/tmp, becomes sites/oit.localhost/files/tmp

After you save these changes, your site should work.

How to Use Lando for a Drupal 8 Development Environment

How to Use Lando for a Drupal 8 Development Environment
Category
esembrat3 Tue, 05/21/2019 - 09:52
Drupal Version

What is Lando? From the Lando documentation:

It's a free, open source, cross-platform, local development environment and DevOps tool built on Docker container technology and developed by Tandem. Designed to work with most major languages, frameworks and services, Lando provides an easy way for developers of all skill levels to specify simple or complex requirements for their projects, and then quickly get to work on them.

In simpler terms, it is a container system built on Docker that runs on Windows, MacOS, and Linux, letting you spin up development websites with a minimum technical hassles.  It is just one of many ways to easily set up a Drupal 8 development site for either building a complete new website, doing module development work, or testing third-party modules in a safe "sandbox" environment.

Enabling a Mail Server in Lando

Enabling a Mail Server in Lando
Category
esembrat3 Fri, 08/09/2019 - 08:54
Drupal Version

The Lando Drupal 7 recipe does not come with mail functionality out-of-the-box. However, DrupalEasy has written straight-forward documentation on how to enable server mail functionality.

This is helpful for enabling mail notifications for password resets, trigger/Rules configuration.

Process

  1. Add the following configuration to your .lando.yml recipe:
    proxy:
      mailhog:
        - mail.lemp.lndo.site
    services:
      mailhog:
        type: mailhog
        hogfrom:
          - appserver
  2. Edit mail.lemp.lndo.site to better match, mirror, or apply to your local Lando website.

  3. Run "lando rebuild". Caution should be used when using using the 'rebuild' command, as while most services retain their data during a rebuild, some may not

  4. Running "lando start" will now initialize a Mailhog server, which will siphon all Drupal-generated mail into that inbox.

Starting a Drupal 8 Website with Lando

Starting a Drupal 8 Website with Lando
Category
esembrat3 Tue, 05/21/2019 - 09:53
Drupal Version

The below scenario assumes you have Lando installed on your own machine for local development.

Kickstarting a Drupal 8 website

Install Drupal via composer:

composer create-project drupal-composer/drupal-project:8.x-dev SITENAME --no-interaction

Enter SITENAME and init lando.

cd SITENAME
lando init

During the lando init process:

  • Select the appropriate recipe (drupal8) for lando.
  • Provide the webroot directory (web).
  • Provide a shortcut name for the lando app (your choice and preference).

Once completed, now start up your virtual environment with:

lando start

Lando will kickstart the virtual filesystems in your specified root directory and initialize a locally-hosted database and web server (using Docker).

When you see BOOMSHAKALAKA!, Lando has configured all the environment configurations and is ready to party.

Using Drupal 8 with Lando

Using Drupal 8 with Lando
Category
esembrat3 Tue, 05/21/2019 - 10:10
Drupal Version

Drupal Console, Drush and Lando

Lando provides scaffolding for tools like Drupal Console and Drush.

To use these tools within Lando, just pre-empt your command with lando to make sure it's running within the Lando interface.

For example, to install a new module in Drupal 8 using Drupal Console, use:

lando drupal moi module_name

Or, to clear all caches using Drupal Console, use:

lando drupal cc all

Please see the Lando Drupal 8 documentation for a full list of tools.

File or Directory Permissions Errors

File or Directory Permissions Errors afrank30 Fri, 06/19/2015 - 13:26
Drupal Version

General Permissions Errors

Note:  If you are running in a shared hosting environment, like OIT Web Hosting, then you are not likely to get many if any general permission errors, as each website runs under its own hosting account in these environments.  Thus, it is nearly impossible to mess up file and directory ownership in these environments.  However, it is worth checking the file and directory permissions, as they are often changeable, and if the owner-write permission is removed from a file or directory then the web server will not be able to modify that file or directory.

If you see any kind of general file or directory permissions errors, the first thing to check is that your sites "sites/default/files" directory and all of its subdirectories are writable by account that your web server runs under.  On stand-alone web servers, these directories and their files don't necessarily have to be owned by this account, but the account still has to have permission to access them.  Consult with your server administrator if you need help in determining the right user and group ownerships for your website's files and directories.

Temporary Directory Permissions Errors

Sometimes after moving a Drupal site to a new web server, you may see an error message that looks something like this:

The specified file temporary://fileX could not be copied, 
because the destination directory is not properly configured. 
This may be caused by a problem with file or directory permissions. 
More information is available in the system log.

Often this is accompanied by the site looking strange and not having much theming or design. This happens because your site's file system needs permissions to access the Temporary directory.  Usually this directory is located at "/tmp", but sometimes the person who built the Drupal site configured it to use a special directory, and then when you copied the site to the new web server, either that special directory was not created or its permissions were not set correctly.

To fix this, try to log into the site as an administrative user and then navigate to the Media section of the Configuration administration page, and go into the File system sub-section.  If you have trouble navigating through the site, you might try going directly to that page:

  http://your-site-host-name/admin/config/media/file-system

On the File system page, make a note of the path set for Temporary directory and then check to make sure it exists on your server and that it is writable by the account that your web server runs under.  Alternatively, you may want to just change the value of Temporary directory to "/tmp" and see if that works.  For websites on OIT Web Hosting, the path "/tmp" should always work, and it's a good starting point for many other web servers out there as well.  If you still run into problems then you may need to contact your server administrator to find out what temporary directory path you should use with Drupal for that server.

Moving an Existing Drupal Site to OIT Web Hosting

Moving an Existing Drupal Site to OIT Web Hosting esembrat3 Mon, 10/27/2014 - 13:11
Drupal Version

Moving an existing Drupal site (either a production site or one built on a development server) to an OIT Web Hosting account is not terribly difficult, but it is important to make sure you follow all of the right steps.

Skills Required for Migrating a Drupal Site

  • You will need to know how to access the Plesk control panel for your account in order to complete the rest of these steps you may also wish to set an SSH password so that you can SSH into your web hosting space.
  • You should have a basic understanding of filesystems and mySQL databases, as well as phpMyAdmin
  • If you need assistance with some of these steps, check with your local unit's IT support staff 

Before You Begin

If you haven't done so already, you'll need to request a hosting account from OIT.  If you are moving a live site, you should ask for the account to be set up as the hostname of your live site, but ask that DNS not be updated yet, since that would disrupt your existing site.  Once the account is set up, you can do one of two things to access it while you are working on migrating your existing site:

  1. You can edit your local computer's hosts list (on Linux and Macintosh computers, this is /etc/hosts) to locally map your live site's hostname to your OIT.  This is the quickest method, but while you have this mapping in place, you won't be able access your existing live site from that computer.
  2. You can create a DNS alias for your new site.  You or someone in your IT staff will have to create the alias in DNS, and then you'll have to go into the Plesk control panel for your new OIT Web Hosting site and add the alias there (via the Add New Domain Alias button on the main page) so that the Plesk server knows that your DNS alias goes with your OIT Web Hosting account.  This method takes a little more effort to set up, but with it you can access your new site from anywhere while you are testing it, and you can access your existing live site from the same computer at the same time.
  3. You could actually mix these two methods for perhaps the most versatile option:  you can define an alias for your new site in your local computer's host file, and then add that alias to your Web Hosting account via the Plesk control panel, but without adding the alias to DNS.  This will let you access both the old and new sites from your local computer, but you still won't be able to access your new site from anywhere else.

When your new site is ready to go live and replace your existing live site, you can have DNS updated (see below) and remove any unneeded aliases that you have created.

Moving Any Drupal Site to an OIT Web Hosting Account

  1. You will need to create an archive of the filesystem of your existing site, and an archive (often called an SQL dump) of your existing site's database.  How you do this will depend on where your existing site is located.  Please note that if you are comfortable with using SSH, you can archive your site's filesystem as either a GZipped Tar archive (.tar.gz extension) or a Windows style ZIP archive (.zip extension).  If you are not comortable with SSH and prefer to upload your archive to your Web Hosting account via the Plesk control panel, your archive must be in Windows style ZIP format.
  2. Upload the archive file to your OIT Web Hosting Account and unpack it where you want your Drupal installation to live.  From within the Plesk control panel, you can upload the archive file via the File Manager.  Once the file is uploaded, just select it in the File Manager to unpack it.  After the archive file has been unpacked, move it to your hosting account's "/private/" folder.
  3. In the Plesk control panel, go to the Databases manager and create a new database.  Copy down the database name, the database user name, and the password, as you will need them later.
  4. While still in the Databases manager, on its main page select the Webadmin link for the database you just created.  This will open phpMyAdmin for this database in a new browser window or tab.  On the Import tab of phpMyAdmin, import the SQL dump of your existing site's database.
  5. Either vis SSH or the Plesk control panel's File Manager, modify your Drupal site's sites/default/settings.php file and update the database information in it to match what you copied down in step three above.
  6. Navigate to your Web Hosting account's main URL, and you should hopefully see the front page of your Drupal site.  Try logging into it and check the Drupal status page and error logs to see if there are any problems with the site.

Updating DNS When Moving a Live Site

If your site is already live in another location, then you will need to update DNS to point your site's hostname to your new OIT Web Hosting account.  You will need to know your hosting account's server name - to get this, just look in your browser's address bar while logged into your Web Hosting account's Plesk control panel.  The server will be web-plesk#.gatech.edu, where # is a number from 1 to 11 (or higher, should they add more servers in the future).  Either update your existing site's hostname to point to this plesk server, or if you don't have that kind of access, ask your local IT support staff to make the change for you.  If you don't have anyone in your unit who can update DNS, you can always open a support request with OIT.

A Word on Migrating a Development Site to Live Production

If you are developing your site somewhere else and then moving it to an OIT Web Hosting account (or any other server where the DNS hostname for the site will be different from what it was in development), then you need to take special care to make sure that your internal links do not break.

When setting the URL paths for page links, inline images, attachment files, etc., make sure to enter those URLs as relative paths.  A regular (called 'absolute') URL looks like this:

  http://your-site-host-name/path/to/my/file.xyz

The relative version of that path looks like this:

  /path/to/my/file.xyz

Relative paths will continue to work even after you change the hostname of the website.  Absolute paths will cause the user's web browser to try to follow the link back to the development site.  This can cause all kinds of problems, ranging from links not working and images not showing as soon as the new site goes live, to problems that aren't detected until someone updates an attachment file yet no one sees the update because the link to that file is still retreiving the old version from your development server.

The command line savy developer may want to search through his/her SQL database dump for the hostname of the development server before uploading that dump file to the new OIT Web Hosting account.  This is a great way of catching any absolute URL links that are still lingering about somewhere in the site.

Importing a Migrated Site into Installatron

Installatron is a service available in OIT Web Hosting that (among other things) can keep the core of your Drupal site automatically updated with security patches. To import a migrated Drupal site into Installatron, please refer to the Installatron documentation provided by OIT's Web Hosting team and watch the video tutorial on this page.

Please note that by default, Installatron does not enable automatic updating of Drupal core when importing a Drupal website into Installatron. To turn on automatic update:

  1. From the front page of the Plesk control panel, look for the Installatron Applications Installer link on the right-hand side of the page.
  2. In the section that gives details about your Drupal installation, select the blue wrench icon button.
  3. Under Automatic Update, select 'Create a backup and update to new minor versions and security releases. (Recommended)'.
  4. Select Save All

Best Practices for Configuring and Managing Drupal

Best Practices for Configuring and Managing Drupal afrank30 Fri, 09/12/2014 - 14:56
Drupal Version

Before you take a Georgia Tech Drupal site live, it is a good idea to go through the following checklist of best practices to make sure your site is secure and streamlined for production use. This checklist is designed for Drupal 7 sites on OIT's Web Hosting, but will generally apply to other environments and later versions of Drupal as well.


Within the Drupal Application

Helpful Tip: The admin interface can be accessed via the black admin toolbar at the top of any page when logged in with administrator rights.

Make Sure Core, Module, and Theme Updates Get Applied When Needed

Enable the Update manager using the following settings so that you and your team will be notified of important available updates.  Then, make sure those updates get applied in a timely fashion (but be sure to back up your site before doing so, in case anything goes wrong).

Installatron will automate core Drupal updates, and is highly recommended for any sites on OIT Web Hosting.  However, before running updates through Installatron, you must backup your .htaccess and robots.txt files if you have customized them!

Recommended "Available updates" Settings

Located at: Reports -> Available Updates -> Settings (admin/reports/updates/settings)

  • Check for updates: Weekly
  • Check for updates of disabled modules and themes: Yes (unless on a multi-site, where only 1 site should check this)
  • E-mail addresses to notify when updates are available: At least TWO (2) email addresses (preferably some office-wide emails).
  • E-mail notification threshold: Only security updates

Limit Access to Your Site

Avoid giving out any more access than necessary

  • Make sure you have a suitable user account role for content managers that does not let them install modules, change themes, adjust low-level Drupal settings, etc.
  • Ideally, only trained IT and/or web development staff should have administrator or super administrator privileges

Review your User Account List Regularly

Remove (or block) accounts of users no longer working in your unit; blocking is often the better option, as that maintains tracking of what those users did. Removing the account will require all content changes to be attributed to the "anonymous" user.

Review your Role Permissions Regularly

Roles are what map Drupal access permissions to individual users.  Review the list (found at People -> Permissions) to make sure roles do not have unnecessary permissions that put your site at risk.

Recommended "Account settings" Settings

Located at: Configuration -> People -> Account settings (admin/config/people/accounts)

  • Anonymous users - Name: Visitor
  • Administrator role: Super Administrator (for Drupal Express sites only; for all other sites: Administrator)
  • Who can register accounts?: Administrators only
  • Require e-mail verification when a visitor creates an account: Yes.
  • When cancelling a user account: Disable the account and keep its content.
  • Personalization
    • Enable signatures: No
    • Enable user pictures: No

Enable GT Account Authentication

  • Most Georgia Tech Sites should use GT Account Authentication, which is provided by the CAS (cas) module
  • Drupal Express has the CAS module already installed
  • For all other sites, see the Installing CAS section for installation and configuration instructions

Recommended "Text formats" Settings

Located at: Configuration -> Content authoring -> Text formats (admin/config/content/formats)

  • Order matters: place "basic text editor" at the top/first, then "minimal HTML", etc.
  • "Plain text" is the only format to which Anonymous users should have access.
  • If "PHP code" is present, DO NOT allow anyone to use it!

Configure Error Logging Securely

Drupal and PHP error messages shown to regular users could reveal sensitive details about your site, and just look unprofessional as well.  Use the following settings to hide error and warning messages from site visitors and keep them from overflowing your site's database.

Note: Do not enable the core syslog module if you are using OIT Web Hosting. According to the syslog module documentation, it is not appropriate for shared hosting. You should be able to find most useful debugging information by going to the Logs section in the OIT Web Hosting Control Panel and looking at the error logs.

Recommended "Logging and errors" Settings

Located at: Configuration -> Development -> Logging and errors (admin/config/development/logging)

  • Error messages to display: None
  • Database log messages to keep: 100

Enable Caching to Improve Site Performance

Recommended "Performance " Settings

Located at: Configuration -> Development -> Performance (admin/config/development/performance)

  • Caching
    • Cache pages for anonymous users: Yes.
    • Cache blocks: (Depends on how often your blocks change)
    • Minimum cache lifetime: (Depends on how much dynamic content you have)
    • Expiration of cached pages: (Only matters if you are using an external cache like Varnish)

  • Bandwidth optimization
    • Aggregate and compress CSS files: Yes
    • Aggregate JavaScript files: Yes

Protect Web Forms and Collected Data

Note: You should try using non-Drupal solutions for forms, such as Qualtrics, whenever possible. Keeping forms and general data out of Drupal is more secure and makes it easier to manage and later upgrade your Drupal site.

In general, do not use Drupal to store sensitive data of any kind: FERPA protected, HIPAA protected, DoD protected, or personal identity information (SSNs, birthdates, etc.)!  The exception to this rule is if your Drupal site is for internal use only and is firewalled properly to prevent access from off-campus.  Even then, you should apply all possible security protections to prevent internal hacking of your sensitive data.

If you still need to have a form on a Drupal site, use the latest version of WebForm, and install some type of anti-spam / anti-bot protection, as forms get hit by bots quickly and regularly once they are made public.

  • Look at modules like Honeypot, Spamicide and BOTCHA to fend off bots
  • Avoid CAPTCHA if at all possible, as it will greatly irritate your users
  • If you're resorting to CAPTCHA, consider whether or not the form can instead be locked down to just the Georgia Tech Campus only

Recommended "Site information" Settings

Located at: Configuration ->  System -> Site information

"E-mail address" is the address from which emails are sent by the site, so it should be generic, rather than the address of a real person.  Note: this must be an @gatech.edu email address for the campus email servers to accept messages from your website!

Note that the Georgia Tech web theme does not display the "Site name" set here, but rather has it's own site title fields on the theme configuration page.  However, "Site name" is used for the name shown in a web browser tab and any page bookmarks in a browser, so it needs to be set to something meaningful, and ideally identical to what you set on the theme configuration page.

Module and Library Safety Tips

  • Where possible, sign up for alerts about updates to libraries being used (such as CKEditor, phpCAS, Flexslider, etc), especially security vulnerability alerts.  Drupal does not give any notifications about out-of-date libraries!
  • Always turn off the following (unless you really need them):
    • PHP filter
    • Tracker
    • Comments
  • Review your modules regularly and disable any that are not being used
    • Disabled modules should be uninstalled and then removed from the Drupal filesystem (move them to the /private folder if you are on OIT Web Hosting)
    • If Drupal reports that a module has been removed from its repository on the Drupal.org website, there's usually a good reason.  Remove any such modules from your site ASAP!
  • Avoid keeping development-only modules on live sites. If you really need any, keep them turned off when not in use.
  • Avoid alpha/beta release modules and anything that is poorly supported or not supported at all.
    • When evaluating new modules, look at the last date of a release (be wary if more than a year ago), number of sites reporting usage of the module, reputation of the module's maintainer(s), and the number of open issues in the development queue.

Check Your Site's Health

  • Check the Status report (found at Reports -> Status report) and correct any problems listed
  • Use the Security Review module to scan your installation for common security problems

Custom Code and the Drupal Filesystem

General Rules of Thumb

  • Always write secure code!
  • Never hack the core Drupal code or any third party modules!
    • Hacks will likely get overwritten when updates are applied later on.
    • Instead, look for ways to extend or adjust the code through a custom module.
  • Avoid using unsupported modules, libraries or themes.
  • Test anything new or uncertain in a separate instance of Drupal.  Never develop on your live site!
  • Don't bother trying to hide the fact that you're running Drupal - it's really not worth the time and effort.

Drupal Filesystem Maintenance

  • Avoid putting anything but Drupal related code in or under the main Drupal directory
    • Adding other files or applications complicates the upgrade process, which can result in those other files or applications disappearing unexpectedly.
      • Drupal version 8 and beyond does not support running any other applications from within or under the main Drupal directory.
    • If you manually install modules or themes, don't leave their archive files within the Drupal directory tree.  Move them to the /private directory if you want to keep them around.

OIT Web Hosting Control Panel

General Hosting Account Configuration

Owner/Administrator

  • Avoid giving out hosting account access unless it is absolutely needed; only those who need to perform Drupal code upgrades should have hosting account access - content managers should never be given access to the hosting account.
  • Regularly check that the administrators of a site are correct (and remove any former maintainers).

Notification Email Address for Website

Only one email address is allowed, so set to the address of a mailing list or alias that forwards to all of your site administrators.

Installatron Applications Installer

  • If you are using Drupal, you should import your site into Installatron so it can keep your core Drupal code updated and secure.
  • Recommended settings:
    • Administrator Email: Should ideally go to two or more IT people with access to manage your site
    • Automatic Update: Update to new minor versions and security releases.
    • Automatic Update Backup: Create a backup and automatically restore the backup if the update fails.
    • Automatic Backup: Do not automatically maintain backups
  • Note on the "Automatic Backup" setting: OIT is doing automatic backups through the Backup Manager (see below), so it's a waste of resources to configure Installatron to do automatic backups as well.
  • Check that Installatron is using the correct URL (web address) for your site, found in the "Location URL" field on the "Advanced" configuration tab.

SSL Configuration

Follow the guide to SSL configuration to run your site with SSL encryption (via an https:// URL).

Backup Manager

  • Recommendations: Set to create one automatically each day, and to keep around 14 days worth.
  • Backups are now automatically enabled on all OIT Web Hosting Accounts now, so no need to configure them unless you need more frequent backups for some reason.

Scheduled Tasks (cron)

Directory structure (multi-site vs. solo site, single system per virtual host, etc.)

  • This will vary depending on your site setup, but we no longer recommend using "contrib" and "custom" subfolders in the sites/all/modules folder.

URL Redirects

  • These are usually created in your .htaccess file (always keep a copy of the latest in your /private directory).
  • Check that your redirects did not get overwritten when your site's Core code was late updated.

Additional ideas can be found in the recording of the How Not to Build and Maintain a Drupal Site session at DrupalCon Amsterdam 2014, and in the following:

Updating Drupal

Updating Drupal root Tue, 12/04/2012 - 13:40
Drupal Version

Updates patch Drupal to sometimes add new features and sometimes protect against discovered vulnerabilities and keep your sites working optimally. Always test new updates on a development site before applying them to your live, production site.


Drupal Updates Sub-Topics

Configuring the Drupal Update Manager

Configuring the Drupal Update Manager esembrat3 Thu, 02/21/2013 - 10:21
Drupal Version

The Update Manager, if used properly, can provide you an easily-accessible location to view what modules and themes need updating.

The settings for the Update Manager ( admin/reports/updates/settings ) provide a few key settings:

  • E-mail addresses to notify when updates are available - A list of emails to be notified when Drupal finds a new release of a module.
  • Check for updates of disabled modules and themes - To ensure all modules are kept up to date, this should be checked (on multi-sites, you only need to check disabled modules and themes for ONE of the multisites).

Updating Drupal Core Via Installatron

Updating Drupal Core Via Installatron root Tue, 12/04/2012 - 13:41
Drupal Version

Before You Begin

  • To be able to use this method of upgrading, your Drupal site must have been created via Installatron or imported into Installatron.
  • Please note that if you installed the Drupal application via Installatron with the update automatically setting, you will not need to go through these steps, as Installat ron will update the site as soon as the new release is posted.
  • Important!!! Installatron will overwrite your .htaccess and robots.txt files.  If you have made any changes to them, be sure to back the m up before upgrading so that you can restore your custom changes after the upgrade is done.
  • Be sure that your Drupal website is configured in Installatron.

Upgrade Process

  1. Open a web browser and navigate to http://hosting.gatech.edu/.
  2. Log in using your GT Account Username and password, and then select the appropriate site from the list.
  3. From the left-hand menu, select Installatron Applications Installer.
  4. An entry describing your Drupal site should appear.  Select the Upgrade button.
  5. Installatron will guide you through the upgrade process of the site.
  6. Follow the directions on the page and select Upgrade to complete the process.

Installatron Updating Tips

Installatron Updating Tips esembrat3 Thu, 08/28/2014 - 07:37
Drupal Version

Running updates on OIT Web Hosting is essential to ensuring that your site remains safe and responsive to every user. The preferred method of running updates is through Installatron, a server application which manages installed web applications on a hosting account.

Update Check

By default, Installatron will check for core updates in one of two ways:

  • For new Installatron Drupal websites, Installatron checks every 6 hours for Drupal security updates. 
  • For imported Installatron Drupal websites, Installatron does not check for Drupal core updates.

Installatron keeps track of each site's app separately, so there is not a way to determine exactly when an update is going to apply for a site. The documentation for Installation say that a site's web app will update between 12am and 6am server time.

Similarly, when Installatron checks for web app updates from the mothership, it's independent (e.g., the updates do not happen at 12 pm, 6 pm, 12 am, 6 am). This makes sense since the increased load of websites all applying updates concurrently would heavily degrade the hosting service.

Configuring Installatron Updates

To configure your Drupal site on Installatron to automatically update, follow the directions below:

  1. Log in to your website from OIT Web Hosting.
  2. Select Installatron Applications Installer.
  3. For the Drupal site in question, select the wrench to view/edit details.
  4. Under Automatic Update, select "Create a backup and update to new minor versions and security releases. (Recommended)".
  5. Select Save All.

Updating from Installatron

Please see Updating Drupal Core (Installatron).

False Flag on Latest Version

As Doug Curtis from OIT Web Hosting notes, there is a current bug in detecting the latest release of Drupal from within Installatron.

  • There is an open issue where Installatron shows a green check mark indicating it has the latest version but if you check the version number next to the check mark, it is not [current]. I have a ticket open with the vendor about this. This is a good reminder that you should always manually check your versions and not rely 100% on automatic systems.

Backup Directory

The default backup directory for Installatron is:

  • /application-backups

You can set custom backup locations through Installatron by editing your Drupal installation via the Applications Installer, and looking under "Default Backup Location".

Updating Drupal Core Manually

Updating Drupal Core Manually root Tue, 12/04/2012 - 13:43
Drupal Version

Before You Begin

  • The instructions below are for moving between different releases of the same major version of Drupal (e.g. 7.x, 8.x. etc.)  Please see our Site Migrations section for more details on moving to the next major version of Drupal, which is a much more involved process.
  • The instructions below assume your site is on a UNIX style web server and regularly reference the OIT Web Hosting environment.  If your site is hosted on a different kind of web server, then these instructions may have to be modified to work correctly for you.
  • Additional information can be found on the Drupal.org page about minor version updates.

Drupal Core Upgrade Process

  1. Open up a web browser and navigate to your Drupal site.
  2. Log into the site as an Administrator.
  3. Navigate to the Maintenance subsection of the Development section of your site's Configuration administration area (Configuration -> Development -> Maintenance) and enable the "Put site into maintenance mode" checkbox.  (Don't forget to save your change!)
  4. Either via SSH/SFTP or (for sites on OIT Web Hosting) the Plesk Control Panel, make a backup of your site's filesystem.
    • If you are using SSH, you can navigate to your site's base directory and issue the following command:
      • tar czf ~/drupalbackup.tgz *
    • If you are on OIT Web Hosting, you should store your backup in the "private" folder like so:
      • tar czf ~/private/drupalbackup.tgz *
  5. Backup your MySQL database.  On OIT Web Hosting, the easiest way to do this is to log into the Plesk Control Panel for you site and access phpMyAdmin via the Webadmin link in the Databases management section.  On the other hand, if you are on a stand-alone web server where you have direct access to mySQL commands, you can run a command like the following (be sure to insert the correct username, password, and database name for your particular website):
    • mysqldump -u USERNAME -p DATABASENAME > ~/backups/database-backup.sql
  6. Rename the directory containing your Drupal installation or move the contents of the directory to another location.  With many shared hosting services, you won't be able to rename this directory, so your only choice will be to move its contents.  When moving the contents, be sure to get the .htaccess file from this directory so that you'll have it for reference later on.
  7. If you were able to rename the directory containing your Drupal installation, then from that same parent directory, download and unpack the latest version of Drupal core (be sure to replace 'x' and 'y' with the right major and minor version numbers) and rename the new drupal-x.y directory to match the orignal name of your Drupal installation directory.
    • wget http://drupal.org/files/projects/drupal-x.y.tar.gz
    • tar -xzvf drupal-x.y.tar.gz
    • mv drupal-x.y orignalDirectoryName
  8. If you had to move the contents of your Drupal directory somewhere else, then make sure you are in that now empty directory and do the following:
    • wget http://drupal.org/files/projects/drupal-x.y.tar.gz
    • tar -xzvf drupal-x.y.tar.gz
    • mv drupal-x.y/* drupal-x.y/.???* .
    • rmdir drupal-x.y
  9. Move the following folders to your old Drupal directory to your new Drupal directory:
    • sites/
  10. Return to your web browser and navigate to  http://yourSiteHostName/update.php.  Follow the prompts to apply any database table updates that are needed.
  11. Check the administrative Status report to verify that everything is working as expected.
  12. Navigate to the Maintenance subsection of the Development section of your site's Configuration administration area (Configuration -> Development -> Maintenance) and disable the "Put site into maintenance mode" checkbox.  (Don't forget to save your change!)

Updating Drupal Modules

Updating Drupal Modules root Tue, 12/04/2012 - 13:47
Drupal Version

Before You Begin

  • Installatron does not upgrade modules, so even if you use Installatron to manage your Drupal core upgrades, module updates must still be done manually.
  • The instructions below assume your site is on a UNIX style web server and regularly reference the OIT Web Hosting environment.  If your site is hosted on a different kind of web server, then these instructions may have to be modified to work correctly for you.
  • Additional information can be found on the Drupal.org page about module updates.

Drupal Module Update Process

  1. Open up a web browser and navigate to your Drupal site.
  2. Login to the site as an Administrator.
  3. Put the site into maintenance mode (Configuration -> Development -> Maintenance) by enabling the "Put site into maintenance mode" checkbox and saving the configuration.
  4. Either via SSH/SFTP or (for sites on OIT Web Hosting) the Plesk Control Panel, make a backup of your site's filesystem.
    • If you are using SSH, you can navigate to your site's base directory and issue the following command:
      • tar czf ~/drupalbackup.tgz *
    • If you are on OIT Web Hosting, you should store your backup in the "private" folder like so:
      • tar czf ~/private/drupalbackup.tgz *
  5. Backup your MySQL database.  On OIT Web Hosting, the easiest way to do this is to log into the Plesk Control Panel for you site and access phpMyAdmin via the Webadmin link in the Databases management section.  On the other hand, if you are on a stand-alone web server where you have direct access to mySQL commands, you can run a command like the following (be sure to insert the correct username, password, and database name for your particular website):
    • mysqldump -u USERNAME -p DATABASENAME > ~/backups/database-backup.sql
  6. Either via SSH/SFTP or (for sites on OIT Web Hosting) the Plesk Control Panel File Manager, locate the existing installation of the module and either delete it or move it somewhere outside your Drupal installation's base directory.
  7. Download the archive file for the new version of the module and unpack it into the same location where the module had previously been installed
  8. Via SSH, a typical set of commands for steps #6 and #7 might look like this:
    • cd /path-to-your-drupal-site/sites/all/modules
    • rm -r modulename
    • wget http://drupal.org/files/projects/module-x.y.tar.gz
    • tar -xzvf module-x.y.tar.gz
  9. Return to your web browser and navigate to  http://yourSiteHostName/update.php.  Follow the prompts to apply any database table updates that are needed.
  10. Check the administrative Status report to verify that everything is working as expected.
  11. Navigate to the Maintenance subsection of the Development section of your site's Configuration administration area (Configuration -> Development -> Maintenance) and disable the "Put site into maintenance mode" checkbox.  (Don't forget to save your change!)

Migrating to Drupal 7 from Drupal 6

Migrating to Drupal 7 from Drupal 6 afrank30 Fri, 10/04/2013 - 14:02
Drupal Version

Editor's  Note:  We sincerely hope that no one is still running a site on Drupal 6 at this point, but just in case you should inherit a site that turns out to still be on Drupal 6, we're leaving the following instructions in place, even though they are a bit outdated now, and there's no guarantee that the external links will continue to work.

Before You Begin

Create a SEPARATE Test site to use for this process, so you don't kill your Live, Production site and...BACK UP EVERYTHING!

The Recommended Process

Almost no one does a regular upgrade, because so much has changed between Drupal 6 and Drupal 7, and many contributed modules don't even exist in version 7. Instead, the process usually involves:

  1. Creating a new development Drupal 7 instance.
  2. Recreating any important content types and functionality in that development site.
  3. Removing any un-needed modules from the new site (this also keeps your maintenance work easier).
  4. Moving/migrating or recreating actual content (nodes, pages, users, files, taxonomy, etc.) into this new site.

How-To Links on Migration/Upgrading

Use the Feeds XPath Parser module to move content

Common Migration Problems

One of the more common problems with migrating Drupal 6 to Drupal 7 is that Drupal 6 did not have the now standard field system.  Instead, many developers of complex sites used a third-party (contrib) module called CCK (Content Construction Kit), which doesn't have a direct migration path into the Drupal 7 field system.

Another feature often used was the User Profile module, which while still present in Drupal 7, is officially deprecated and is only made available when you run a standard Drupal 7 upgrade process on a Drupal 6 installation.  If your Drupal 6 site uses this module, then you should really take the time to properly migrate that profile information into the Drupal 7 field system, since the user profile module isn't available at all in Drupal 8.

It is possible to do some automated migration of CCK and User Profile data via custom PHP scripting run at the command line, but this is not a task for the novice user, as you need a good understanding of the Drupal 6 and 7 database schemas.  For anyone else, you may either need to hire a web development company that can do this work, or consider hiring student assistants to manually re-enter the data (if the amount isn't too large) into a properly structured Drupal 7 development site.

Migrating to Drupal 8 from Drupal 7

Migrating to Drupal 8 from Drupal 7 kp37 Tue, 11/28/2017 - 18:56
Drupal Version

Migration, not Upgrading

Drupal 8, released in November of 2015, is a major rewrite of the Drupal core engine and APIs. Because Drupal 8 has changed so much, there is no direct in-place upgrade path to go from any earlier version of Drupal to Drupal 8. Instead, Drupal 7 and earlier sites must be migrated to Drupal 8, which involves setting up a whole new Drupal 8 website and copying into it (manually or automatically) the content of the older website.

Requirements and Web Hosting Support

Drupal 8 requires a hosting environment running at least PHP 7.2* or later, which is available on OIT Web Hosting.  What OIT does not currently support is use of Drush and/or Composer (though Composer support will be in place by mid-February, 2020), so you'll need to do a traditional installation and traditional GUI based management of upgrade and updates.  You can install Drupal 8 from Installatron and use it to manage your updates - just be sure to start with the most current version, and remember that a fresh install of Drupal from Installatron will not include any Georgia Tech specific components (e.g. theme, Mercury Reader, etc.), so you'll have to install those separately after you finish the base Drupal installation.

* - Technically PHP 7.1, but 7.1 is no longer supported, so all Drupal 8 sites should be run on PHP 7.2 or later.

Georgia Tech Migration Roadmap

Beyond PHP support, each Georgia Tech unit website will need several extra components to be fully usable. The following table is an attempt to start tracking the status of the components needed for Georgia Tech Drupal 8 sites, and it will be updated as releases and additional information come available.

Status of common Drupal 7 components in Drupal 8
(Last Updated January 30th, 2020)
Component Name Available
for
Drupal 8?
Comments?
Georgia Tech Web Theme In Testing

An official Institute Communications "release candidate" theme was released in early October 2018 for more seasoned developers to begin testing.

Please see the Georgia Tech Web Theme section for more information on the status of Drupal 8 theme development.

GT Account Authentication Yes

CAS module v1.0 is fully usable and CAS configuration instructions are available.

Mercury News and Events In Testing

An "alpha" port of the official Hg Mercury was released in early fall 2018.

An alternative community built approach using the Migrate API is being investigated, but no details are available yet.

GT Content Types No Vertical, Horizontal, and Multipurpose page types are not expected to be ported to Drupal 8. Such pages will have to be rebuilt in Drupal 8. Alternative page layout systems include:
GT Drupal Express (DX) No

A Drupal 8 installation akin to GT Drupal Express (DX) has not been announced or planned.  Institute Communications is developing an automated installation of Drupal 8, but this will not be a direct replacement (or direct upgrade path) for existing DX sites.

Current DX websites should remain on Drupal 7 and their developers should consider manual content migration to Drupal 8 in the future, as it is unlikely that a script will be developed to aid DX migrations to Drupal 8.

A Drupal Express migration strategy guide is under development.

Web Forms Yes

The traditional Webform module has been completely rewritten for Drupal 8 and is much more capable than the old version, but also more complex.  Existing users should treat it like a new product and go through all available getting started and training guides / videos before trying to build a form under Drupal 8.

Drupal 8 itself comes with a limited Contact Form functionality and a handful of contrib modules (such as Contact Storage) are available to extend that functionality, though not to the level found in the traditional WebForm module. Contact forms are recommended for simple RSVP and feedback forms.

Complete Migration Process

Kevin Pittman has posted a guide to migrating from Drupal 7 to Drupal 8 that includes a lot of planning tips and technical details.

Drupal Express (DX) to Drupal 8 Upgrade/Migration Strategies

Drupal Express (DX) to Drupal 8 Upgrade/Migration Strategies kp37 Thu, 11/30/2017 - 10:56
Drupal Version

Many Georgia Tech websites have been built using Drupal Express (DX), which is a custom version of Drupal 7 that allows you to create a website with little technical or design expertise. The ready-made site comes with built in features and tools like news and events listings, and mobile optimization.

For several years, the Office of Information Technology has offered Drupal Express as an option when requesting a new web hosting account.  Selecting this option causes Drupal Express to be pre-installed in the account so that the unit can start using the site almost immediately without having to do any technical work on the back end of the site.

Unfortunately, the people who helped to create Drupal Express no longer work in Georgia Tech's Institute Communications Office, so there has been no planning at this time for any kind of automated upgrade or migration path for Drupal Express sites. Even if anyone were to work on such a path, the high level of customization in Drupal Express's page layouts and other tools coupled with the major changes in Drupal 8's underlying architecture would make an automated upgrade of a Drupal Express site very difficult if not impossible.

With this in mind, owners of Drupal Express sites should review the guidelines and tips below for planning a manual site migration from Drupal Express to Drupal 8:

  • Drupal Express sites may still benefit from using the Drupal Migrate tool to at least bring over their Basic Page content. Bear in mind that some amount of clean-up will be necessary after using Migrate, but the clean-up may be easier than cutting and pasting a lot of Basic pages into your new site.

    Kevin Pittman has posted a detailed Drupal 8 Migration guide that describes how to use the Migrate tool.

  • Vertical, Horizontal, and Multipurpose page types are not expected to be ported to Drupal 8 and will not be copied over by the Drupal Migrate tool. Such pages will have to be completely rebuilt in Drupal 8. Alternative page layout systems you should consider include:

    • Layout Builder - Available in Drupal 8.7, but still has bugs and limitations; expected to be more usable in Drupal 8.8 or 8.9.  Layout Builder will be the foundation of page layout for the official Georgia Tech Drupal 8 web theme system being released in early 2020 by Institute Communications, so expect to use it with any site that needs the official theme.

    • Paragraphs - A solid product for smaller sites that do not need the official Georgia Tech theme.

    • Panels and Panelizer - For really advanced developers only

  • Other components included in Drupal Express may not be available for Drupal 8 or may have been superseded by new components. A breakdown of known Drupal Express components and their status is posted below.

In case you are enlisting the help of someone with technical developer skills who would like to know more about the make-up of Drupal Express and what to expect when migrating a Drupal Express site to Drupal 8, below is the full list of components included in Drupal Express (excluding minor ones no longer needed in Drupal 8) and their known Drupal 8 status.

Please note that just because a module has a production version, this does not mean that it works the same as it did in Drupal 7 or that it supports all of the features in the Drupal 7 version.  Please read the documentation for each module to see what has changed.

Custom Drupal Express components and their Drupal 8 status
(Last Updated January 30th, 2020)
Component Name Available
for
Drupal 8?
Comments?
Georgia Tech Web Theme In Testing

A community built version of the GT 3 beta theme implementation is available.

An official  Institute Communications "release candidate" theme was released in early October 2018 for more seasoned developers to begin testing.

GT Superblocks No No port planned or expected of this custom module
GT Editor No No port planned or expected of this custom module, but the built-in CKEditor provides much of the same functionality and can be customized as needed
GT Login No No port planned or expected of this custom module, but the CAS module can be installed to provide GT Account Username based authentication.  CAS configuration instructions are available.
GT Tools In Testing The official Drupal 8 Georgia Tech theme has it's own required "GT Tools" module that provides support for some of the theme's features.
HG Reader Planned A "release candidate" port of the official Hg Mercury was released in early fall 2018.
JWFilter Superseded JWFilter was for the old OIT DMI media repository that is no longer available.  Please use the Ivan Allen College's Support for oEmbed module for embedding videos from the new Georgia Tech MediaSpace repository
Contrib (Third Party) Drupal Express components and their Drupal 8 status
(Last Updated January 30th 2020)
Component Name Available
for
Drupal 8?
Comments?
Admin Menu Superseded Use Admin Toolbar
Admin Views In Drupal 8 Core  
Block Reference Superseded Use the built in Entity Reference field
CKEditor In Drupal 8 Core  
CTools Production Not required by any previous Drupal Express modules in Drupal 8
Custom Search Beta From the Custom Search project page: "The 8.x-1.0-beta branch is usable, and instead of overriding the default search block like it did with D6/7, it provides its own block(s)". Not recommended for use (not being updated by maintainer)
Date In Drupal 8 Core  
Diff Production See the Diff project page ; Works, but may not be as full-featured as Drupal 7 version
Field Group Production See the Field Group project page ; (Only minimally maintained)
Google Analytics Production See the Google Analytics project page
IMCE Production See the IMCE project page
IMCE MkDir Superseded Now part of the main IMCE module in Drupal 8
Libraries Development Not required by any previous Drupal Express modules in Drupal 8
Link In Drupal 8 Core  
LinkIt Production See the LinkIt project page
Menu Block Production See the Menu Block project page
Module Filter Production See the Module Filter project page
Nodeblock Superseded Create a custom block type in Drupal 8 and add an Entity Reference field configured to reference node content
Override Node Options Production See the Override Node Options project page
Pathauto Production See the Pathauto project page
Pathologic No  
Revisioning In Drupal 8 Core Replaced by the combination of Workflows and Content Moderation.
Token Production See the Token project page
Transliteration No A filename transliteration patch for Drupal 8 core is available if you want to have filenames transliterated, but that patch hasn't been committed to production core yet.  It has been rolled into a Transliteration Filenames module.
Video Embed Field Production See the Video Embed Field project page
View Unpublished Alpha See the View Unpublished project page ; Not recommended for use (not being updated by maintainer)  Note: if you're really in need of this functionality, contact Kevin Pittman - he has a method for doing this that works, but requires a little setup to get working.
Views In Drupal 8 Core Existing views do not migrate to Drupal 8, but can be recreated by hand
Views Bulk Operations Production See the Views Bulk Operations project page
WYSIWYG Filter In Drupal 8 Core  

Version Agnostic Migration Resources

Version Agnostic Migration Resources afrank30 Thu, 06/26/2014 - 09:09
Drupal Version

Downloading a Site Backup File From OIT Web Hosting

Downloading a Site Backup File From OIT Web Hosting afrank30 Tue, 03/10/2015 - 10:58
Drupal Version

Download an OIT Web Hosting Backup File

Log into your Web Hosting account's Plesk Control Panel and select the Backup Manager option on the right-hand side of the main page.

On the Backup Manager page, you will see all of your existing site backups.  If you have not configured automatic backups and have never run a manual backup, then you won't have anything to download.  In this case, you can select the Back Up option and follow the prompt to initial a backup of your site.  Do note that this is done in the background and may take a while on bigger sites, so start it before you go to lunch, and hopefully it will be done by the time you get back to your office.

Locate the backup that you want to down load and select the green down arrow icon on the far right of the backup's entry (see screenshot below).

Your backup will download to your computer, and have a name similar to this: 

backup_mysite.gatech.edu_info_1503101033.xml.tar

Uncompress a Downloaded Backup File

You will need a special program to unarchive a backup file, as backups are provided in the TAR format.

  • On a Macintosh, you may be able to double-click the file and get Mac OS X to unpack it for you - your mileage may vary depending on your version of Mac OS X and how large the backup file is.  You can always go to the command line and unpack the file as well (see the Linux option below for instructions)
    • If you prefer to not use the command line and Mac OS X is giving you trouble, you can try the open-source Unarchiver App
  • On Linux or FreeBSD (or Mac OS X), you can unarchive the backup file from the command line like so:
    • tar -xf backup_mysite.gatech.edu_info_1503101033.xml.tar
  • On Windows, you'll need a utility app that can unarchive a TAR file, such as 7-zip.

What is In a Backup Archive File?

Once you uncompress your backup file, you will have a directory with the same name as your file, but without the ".xml.tar" at the end.  Inside this directory, there are two files you will be working with:

  • The SQL backup of your site's database
  • The file system of your Drupal site

File System

The files for your site will be within a compressed file that has "user-data" in its name, like this:

backup_mysite.gatech.edu_user-data_1503101033.tgz

Uncompress this file into a folder of the same name (without .tgz on the end), then look inside it for a folder named "httpdocs", like this:

backup_mysite.gatech.edu_user-data_1503101033/httpdocs

This folder is where your Drupal site files live.  You can review them, copy them to a development web server on your local computer, or archive just that section of the file system in order to transport them to another computer.

Change settings.php Immediately

If you are going to try to use this backup to create a development copy of your live website, immediately change the database connection information so that you don't accidentally connect to your live site.  Look for your Drupal settings file at:  

backup_mysite.gatech.edu_user-data_1503101033/httpdocs/sites/default/settings.php

Database

The SQL for your database will be under a folder called "databases" and then another folder with the same name as your database, like this:

databases/database-name/backup_database-name_1_1503101033.tgz

Rename Your Database in SQL

First, uncompress this file.

If you want to edit the SQL, you should use a very basic text editor (such as Notepad on Windows or TextEdit on mac) because it is a LARGE file and may overwhelm fancier programs.

The main recommended edit is to remove the actual name of the database from the line near the top. This prevents conflicts when importing your SQL into an empty database with a different name.

Redirection and Checking for Broken Links

Redirection and Checking for Broken Links esembrat3 Thu, 08/04/2016 - 08:29
Drupal Version

A Redirect module is available for Drupal 7 and Drupal 8 to help manage link redirects and locate problem areas on your site post-migration.

Installation

To install, follow the directions below:

  1. Download the Redirect module
  2. Upload the module to your /sites/all/modules/ folder, or use the Upload New Module administration page.
  3. Install and enable the module.

Usage

The interface for the Redirect can be found under Configuration -> Search and Metadata -> URL redirects, or by navigating to /admin/config/search/redirect.

On the overview page, a listing of your existing redirects are in place. Drupal tracks each redirect, their status, the type of redirect, and how often they're accessed. 

Finding and Fixing Dead Links

You can also use the Fix 404 Pages, located at /admin/config/search/redirect/404 or as a sub-tab off of the URL Redirects page. 

This page allows you to identify currently-broken links on your site and a quick way to create a redirect. 

Leverage your local web developer (or contact the Georgia Tech Drupal mailing list) to see if a page or link needs to be redirected.

In the example above, wp-admin.php is a WordPress (another content management system) login page and is routinely used by bots and hackers to attempt to infiltrate your website. Because we're running Drupal, we can ignore most all of those pages. 

To add a redirect to one of these 404'd pages, select the Add Redirect link to the right.

Redirect Options

When creating a redirect, the form should look similar to below.

All that is needed to complete a redirect is completing the To, or where the page needs to go when redirected.

Under Advanced Options, the redirect status can help search engines and browsers interpret the link. The Redirect module provides some short description by each one to give an idea of what each does.

Unless otherwise noted, 301 Moved Permanently or Default (301) should always be used.

If you think you have a use case for any of the other redirect types, please contact a web developer on-campus. Improper usage of the redirect type may hurt access to your redirected page by search engines.

Upgrading to Drupal 9

Upgrading to Drupal 9 kp37 Thu, 07/09/2020 - 11:20
Drupal Version

Notes, tips, and tricks for upgrading a Drupal 8 site to Drupal 9

Moving to Drupal 9 from Drupal 8 does not involve near as much planning and preparation work as previous major version upgrades thanks to changes the Drupal organization has made to the development process.  Instead of Drupal 9 introducing a new batch of features, new features have been added gradually over the major point releases of Drupal 8.  The key changes with the first release of Drupal 9 will be to remove deprecated (old and no longer used) code, and to upgrade the underlying Symfony framework.  On the surface, though, you should not see any notable differences between Drupal 8.9 and Drupal 9.0, assuming you have prepared your site properly.

Preparation

Basic Requirements

  • Drupal 9 requires PHP 7.3 or higher.  If your site is on OIT Web Hosting, make sure you've requested a PHP upgrade before you try to upgrade to Drupal 9.

  • Drupal 9 requires a settings.php change:
    • The line beginning with "$config_directories['sync'] =" has to be changed to "$settings['config_sync_directory'] ="
    • Note: Not sure if you can do this before upgrading, but at a minimum you can duplicate the line and change the duplicate, then later delete the original after you've upgraded.

  • To upgrade to Drupal 9, you must be on Drupal 8.9 or higher
    • If you are already on 8.9, make sure you have the latest patch release to get the smoothest transition
    • If you are on anything earlier, upgrade to the latest patch release of 8.9 first, then upgrade to the latest 9.0 release.

  • Drupal 9 requires all active themes and modules to declare Drupal 9 compatibility (and they, of course, need to actually be compatible, too.)
    • Compatibility is indicated by a line in the theme or module's .info.yml file that starts with "core_version_requirement:"
    • Check and update all custom modules in particular, but also check your contrib modules, too.
    • Note that at the moment, the Georgia Tech theme package and Mercury Reader package have not been certified Drupal 9 compatible, so you may want to wait for them to be certified before trying to upgrade.

  • Drupal 9 (as did Drupal 8.9) uses CKEditor 4.14.0, but Drupal 9 seems to be pickier about CKEditor plugins.  If you are using any add-on CKEditor plugins, check each one to see if there's a 4.14 specific version and upgrade as needed.  (Balloon Panel, used by Accessibility Checker, is one that needs to be up-to-date to work in Drupal 9).

Checking Module / Theme Compatibility

For what it's worth, there are several tools available that are supposed to check your site's modules and themes for Drupal 9 compatibility. The present options either require the ability to run PHP at the command line or require your site to be managed through Composer (such as Drupal Express websites).

If you are comfortable with running simple commands at the Linux command line, you can get a quick overview of your modules declared compatibility by going to the main modules directory and running the following command:

  grep "core" */*info*

For any module where you do not see a line with "^9" near the end, you'll need to do some testing and research to see if the module will work with Drupal 9.  Check first for a new major version release, and if there is none, you could try the instructions given below for testing a previously Untested Release to see if it causes any problems.

Process

Once you've completed all of the preparatory steps, upgrading is the same as if you were upgrading to another point release of Drupal 8.  More than ever, though, make a full backup (filesystem and database) before you begin, just to be safe. Afterward, test everything thoroughly since a lot of old code has been removed and the underlying Symfony engine has received a major upgrade.

Issues

Semantic Numbering - New Major Releases

As more time goes by, more module developers will move to the new semantic numbering system that is not tied to a Drupal version number (e.g. 7.x-1.0).  Typically, if a module was at say version "8.x-3.5" then the next major release done under the new numbering system would be "4.0.0".  You'll have to check carefully for this change, as Drupal alerts major version releases (8.x-3.5 to 4.0, for example) as "Other versions available".  However, in the case of modules like Webform you may find you are expected to upgrade to the next major version (4.0.0 in this case) when you upgrade your site to Drupal 9. Module version updates to the next major version can be complete with Composer. Otherwise, it may be easiest to do this by hand at the filesystem level. As with most major version upgrades, you'll likely have to manually run schema updates (go to update.php after updating), as Drupal will only do a major version upgrade through the GUI if the previous major has been marked as unsupported.

Known Problem Modules

  • Devel has a new 4.0.0 release just for Drupal 9, which is fine and well, but the popular Kint debugger sub-module is gone from 4.0.x.  To get that functionality you have to use composer to install a Kint plugin for Devel 4.0.x or use the devel_kint_extras module. That's a big complication if your site is not set up to be managed by composer.  As a workaround, you can download the PHAR version of Kint and manually include it in your site to get it's functionality - it's not as streamlined an install as a prepackaged module, but if you need to use it, you should likely understand already how to manually set something like this up.

  • Webform 8.x-5 is not compatible with Drupal 9 at all and will actually break the update.php process.  If you use Webform, do not attempt to upgrade to Drupal 9 until you have upgraded Webform to its new 6.0 release (which is currently in alpha state, so your mileage with it may vary.).

Georgia Tech Drupal Themes

Georgia Tech Drupal Themes esembrat3 Fri, 10/04/2013 - 12:42
Drupal Version
Tags

Drupal 7 Georgia Tech Theme

Since September of 2013, Georgia Tech Institute Communications has provided an official Georgia Tech Drupal theme suitable for all official unit websites, including but not limited to college, school, project center, and administrative units. This Drupal 7 (D7) theme implements the Georgia Tech Website Visual Style Requirements that all official websites are expected follow.

2019 Updated Drupal 7 Theme

A new version of the Drupal 7 Georgia Tech Theme updated to the new "Tech Gold" color scheme was released in early March 2019. Make sure you use the latest version, which as of April 16th, 2019 is 3.2.  The previous versions of GT Tools (2.9) and Super Block (2.9) will continue to work with the new theme package, so they do not need to be updated unless they were not already up-to-date on your site.

Drupal 7 Theme Configuration Walk-through Video

If you are new to the Georgia Tech Drupal theme, you can watch the installation and configuration of the Georgia Tech Theme section of the video recording of the November 2013 GT Build Day. This is the first section of the video and runs approximately 45 minutes.  Please note this video demonstrates the old pre-2019 theme, but the techniques for installing and configuring the theme remain the same for Drupal 7.


Drupal 8 Georgia Tech Theme

Institute Communications' project to create a new theme that's compatible with Drupal 8 (D8) will go through several phases, from April to October 2018, and into early 2019.

Drupal 8 Theme Completed Deliverables

Based on feedback from campus stakeholders, Institute Communications will revisit the current Drupal 7 theme, incorporating the new header-footer design, in early 2019. The Drupal 8 B theme, which will include components/elements built into CKEditor and brand-aligned body design styles applied to views, has been added to the project list.

Drupal 8 Theme Target Dates

  • Body design elements style sheet: first week of December
  • Drupal 8 B theme: TBD

Drupal 8 Theme Timeline (Subject to Change)

Drupal 8 Theme Development Contacts

Louise Russo
Director of Institute Digital Strategy
404-385-3658
Email: Louise Russo

Tionna Carthon
Director of Institute Marketing and Communications Consulting
404.894.9793
Email: Tionna Carthon


Page Update History

  • Edited November 15, 2018: Moved delivery date for body design elements spec sheet from November to first week in Dec.
  • Edited November 13, 2018: Moved delivery date for Drupal 7 theme from first week in January to late January.
  • Edited November 13, 2018: Added Drupal 8 B theme to calendar for delivery mid-February. 
  • Edited August 9, 2018: Changed Mercury Reader module delivery date from end of July to mid-August

Georgia Tech Theme Sub-Topics

Installing, Extending, and Upgrading the Georgia Tech Drupal Theme

Installing, Extending, and Upgrading the Georgia Tech Drupal Theme klp Thu, 03/03/2016 - 17:20
Drupal Version
Tags

Installing the Georgia Tech Theme

You will need to download both the current Georgia Tech Drupal Theme package, and the GT Tools module.

  1. Install the GT Tools module into your sites/all/modules directory, and the Georgia Tech Drupal Theme package into your sites/all/themes directory.
  2. Log into your site with administrative privileges and enable the GT Tools module.  Please note that you do not have to enable the GT Content Types or GT Directory sub modules that come with GT Tools.
  3. Go to the Appearance administration page and enable the "Georgia Tech - Drupal 7 Theme" and make it the default theme.
  4. After enabling the new theme, follow the Settings link shown below its name to configure the theme's settings, using our GT Theme Settings Guide as a reference as needed.

Extending the Georgia Tech Theme

The recommended way of extending the Georgia Tech Theme to meet your unit's special needs is to create a sub-theme instead of modifying any of the files in the Georgia Tech Theme.  This way, when new versions of the official theme are released, you can just drop them into place and not have to figure out all the different things that you customized.

As a way to get started quickly, there is an unofficial GT Sub-theme package that you can use as a base for your own custom sub-theme.

An important hint for those new to sub-themes:  on your Appearance administration page, you set your sub-theme to be your enabled and default theme.  It will then include everything that it needs from your base theme (the official Georgia Tech Drupal Theme).  For this reason, you must leave the Georgia Tech Drupal Theme installed on your site, and it's a good idea to leave it enabled as well.

For advanced developers, there is also a Sass based version of the official Georgia Tech Drupal Theme.

Upgrading the Georgia Tech Theme

It is highly recommended that you first test any new version of the official Georgia Tech Drupal Theme against a copy of your website to make sure you fully understand the effect it will have on your pages and content.

If you have done all of your customizations in a sub-theme, then upgrading the official Georgia Tech Drupal Theme is very easy:

  1. Download the latest version of the Georgia Tech Drupal Theme
  2. Backup the existing files in your sites/all/themes/gt directory and then remove the directory.
  3. Remove the sites/all/themes/gt directory.
  4. Install the Georgia Tech Drupal Theme package into your sites/all/themes directory.
  5. Log into your site with administrative privileges and flush all of the caches.  This can be done on the Configuration -> Development -> Performance administration page, or via the 'Home' menu if you have the Admin Menu third-party module installed.
  6. Go to the Georgia Tech Drupal Theme settings page and verify that all of the available settings are correct.  Note: it has been observed that sometimes after upgrading the theme, you will find all of the settings fields blank the first time you visit the settings page.  If this happens, simply switch to the global theme settings page and the go back to the GT theme settings page, and your old settings should be restored.

Please note that a new version of the Georgia Tech Drupal Theme could cause conflicts with custom CSS and template code in a sub-theme, so you'll have to watch for these issues and update any custom CSS/template files accordingly.

GT Theme Settings Guide

GT Theme Settings Guide eh94 Mon, 11/04/2013 - 13:10
Drupal Version
Tags

The GT theme version 2.x offers a variety of settings options.

How to Manage Theme Settings

To manage these options:

Description of Theme Settings

These include:

Georgia Tech Logo Options

Select the default GT logo, or go with one of the college logos. You can also upload a file to use, but it must be a transparent .png, and be within the specified dimensions -- plus be an official logo approved by Institute Communications! Contact Institute Communications if you need assistance getting a logo generated in the proper format.

Styling Version

This setting (only available in versions 2.5 through 2.7) configures which CSS/styling is applied to the GT website.  It allows you to switch to the new layout/style treatment (2.5) or stay backwards-compatible with previous styling. This is to help avoid "breaking" any styling folks may have done via a custom subtheme. The version 2.5 styling option also includes support for a couple of block classes that are added through the GT Tools module (/admin/config/system/gt):

New CSS styles for adding icons to block titles:

New CSS styles for adding colored backgrounds to block titles:

  • block-title-bg-gt-blue - GT Navy blue background w/ white text
  • block-title-bg-gt-gold - GT "Buzz" gold background w/ white text
  • block-title-bg-gray - "Dark" gray background (#646464) w/ white text

Site Header

These settings configure site header actions.

  1. Site Header Title: Same as the previous theme. The text provided here will appear in the site header, to the right of the main logo. The text will be set in "Buzz" Gold.
  2. Hide Home Page Title: Check this box if you want the default page title text to NOT appear on your home page. Note that this is NOT the Site Header Title (as mentioned above,) but the node title of your home page for your site.
  3. Search Options: (Removed in version 2.7) Select to have your search be the built-in Drupal search, the campus Google appliance, or user choice.
  4. Breadcrumb Options: By default the breadcrumb will list a link back to the main Georgia Tech site homepage first. If you'd like to have another default link always appear after the Georgia Tech link use these fields.

​Super Footer

These settings relate to the superfooter at the bottom of each page.

  1. Remove Superfooter: (Added in version 2.7): completely hide the superfooter
  2. Super Footer Menus Setup: The Full Georgia Tech Default option will give you the exact same set of super footer menus that appear on the home page of www.gatech.edu. The Georgia Tech Minimum option will give you just the menu from the left column in the super footer of the home page at www.gatech.edu, but the menu will be broken up into two shorter menus. The Configurable option allows you to have three fully configurable menus in your site's super footer.
  3. Collapsed Super Footer: Check this option if you would like to have the super footer collapsed by default. If this option is checked a "Resources" tab will appear above the lower footer, which serves as an open/close trigger for the super footer.
  4. Campus Map Image and Custom Street Address: By default the site super footer area will show an image of the campus map plus link to the map site, and the official GT mailing address. You can opt to upload your own map image, and have it link to where ever you'd like, plus enter your address.

Footer Login

These settings configure site footer login actions.

  1. Show a login link in the footer.
  2. Redirect to current page: (Added in version 2.7) instead of being redirected to homepage after you log in.
  3. Alternate Login URL: (Added in version 2.7): If you use a different URL to log in to your site, provide that full URL (i.e., http://editor.mysite.gatech.edu).

GT Tools Module

GT Tools Module afrank30 Thu, 12/19/2013 - 18:30
Drupal Version
Tags

The GT Tools module is required when using the GT Theme and should be installed before the theme on your Drupal 7 site.  It provides some additional functionality that Drupal doesn't support directly in a theme package, so this functionality had to be provided in a separate module.

GT Tools includes a sub-module called GT Content Types, which provides three new page layouts via custom content types.  If you want to use this sub-module, you must install the 2.2 version (or newer) of the blockreference module (older versions 2.0 and 2.1 don't work).

It should be noted that there are no plans to provide a migration path for the GT Tools custom content types (Multipurpose Pages, Horizontal Landing Pages, and Vertical Landing Pages) to Drupal 8, the new version of Drupal that campus will be migrating to over the next two years (roughly mid 2019 to mid 2021).  So, if you are building a new website, you should consider avoiding those content types and only using Basic pages to make your future Drupal 8 migration easier.

GT Theme Provided Menus

GT Theme Provided Menus eh94 Mon, 11/04/2013 - 13:35
Drupal Version
Tags

The GT Theme, by default, will use your site's "main menu" for your primary menu. The primary menu is the gold-colored horizontal one that sits below the main Georgia Tech logo. This menu will show the top-level links in a horizontal line, with child links appearing as drop-down boxes.

Additional menus provided by the GT Theme that you can modify include:

Social Media Links

Shown in the upper-right corner of every page, this menu includes presets for Facebook, Twitter, Google +, LinkedIn, Youtube, etc., plus an RSS feed icon. You can change the location that each icon links to. Be sure to let Institute Communications know if there are other social media outlets you think should be included.

Action Links

This menu appears to the right of your main menu, with a greater-than sign ('>') after each link. To keep things nice and streamlined we've limited the action links to three.

(Super)Footer Links

For the super footer you'll find three separate menus listed as footer links 1-3. If you opt to have a configurable super footer via the theme's appearance settings you'll get a list of default resource links that are hard coded into the the theme (Georgia Tech Resources, and Visitor Resources), and appear as the left column of links in the super footer, but you can customize up to three additional lists.

One thing to note is that the theme includes styling for "nolink" items added via the Special Menu Items module. If you install this module you can add links that serve as headers within a list of resource links to help break them up into different categories. "No link" items would appear like the Visitor Resources header does in the superfooter links on this site. You can also change the name of your resource links menus, which shows up at the top of the list of links.

Footer Utility Links

These links will appear above the standard "legal" links in the footer (Emergency Information, Legal & Privacy Info, etc.) This is ideal for adding a customized "Contact Us" link which can go to your own contact form.

Updating From version 7.x-1.x of the GT Theme to version 7.x-2.x

Updating From version 7.x-1.x of the GT Theme to version 7.x-2.x afrank30 Mon, 08/04/2014 - 14:58
Drupal Version
Tags

Editor's Note:  The following information is rather outdated, but believe it or not, there are still a few sites out there that are running version 1 of the GT Theme.  Our current-day recommendation for anyone running that theme is to strongly consider just rebuilding your site from scratch with a fresh copy of Drupal 7 or Drupal 8, as if your theme is that much out-of-date (version 2 was released in late 2013), your content and other site structures are also likely to be pretty out-of-date as well.

Below are tips and/or steps on how to update your Drupal 7 site from version 1 of the GT Theme (unofficial) to version 2 (official).

  1. Put your site in maintenance mode (and try this on a TEST site first!).
  2. Change the "Appearance" of your site, so that it uses only CORE-provided themes (such as garland).
  3. After you make copies of them and save them somewhere safe, disable any older versions of the GT Theme and any subthemes you made that were based upon it.
  4. Remove any the actual files for the older GT Theme and its subthemes from your file system.
  5. Flush the caches on your site and, just for fun, run "update.php", too.
  6. Install the parts that are required for the 2.x version of the GT Theme in this general order:
    1. GT Content Types (submodule of GT Tools)
    2. GT Tools
    3. GT Theme
    4. THEN, the GT Subtheme
  7. Check to make sure can now add the new content types (such as Horizontal landing page) that come with version 2.x of the GT Theme.
  8. Under Appearance, choose the GT Subtheme (NOT the GT Theme itself) as your default theme for this site.
  9. If re-using the same blocks for this new look, you'll need to put them into regions for this theme under Structure > Blocks.

GT Theme Troubleshooting and Advanced Topics

GT Theme Troubleshooting and Advanced Topics klp Thu, 03/03/2016 - 16:46
Drupal Version
Tags

The topics below are for troubleshooting specific problems and doing advanced implementations of the Georgia Tech Drupal theme. Implementing some of these features will require knowledge of advanced Drupal development techniques and/or PHP coding skills.


Advanced Topics Pages

Is Your Site Trying to Use the Google Search Appliance (GSA)?

Is Your Site Trying to Use the Google Search Appliance (GSA)? afrank30 Tue, 01/03/2017 - 11:11
Drupal Version

The Georgia Tech Google Search Appliance (GSA) was shut down at the end of December 2016.  If you are running version 2.9 or later of the GT Theme, then you do not need to worry about this, as version 2.9 and later of the them has had everything related to the Google Search Appliance removed.

If you are still running an older version of the theme, then we recommend that you upgrade to version 2.9 if you can.  If for some reason this is not feasible, then you can make sure your site is not trying to use the Google Search Appliance by doing the following:

  1. Visual check:  Select the 'SEARCH' link (shown with a magnifying glass) on your site.  If the drop-down has any checkboxes below the white search text field, then you need to follow the remediation instructions below.
  2. Search check:  If you don't have those checkboxes, then type something into the box and press Enter or Return.  If you are taken directly to Google, then you need to follow the remediation instructions below.

Remediation Instructions

Again, these instructions only apply if you are running Drupal 7 and the GT Theme.

  1. Log into your site as an administrator
  2. Under Appearance (/admin/appearance), locate your site's active theme under the 'Enabled Themes' section. The active theme for your site is indicated by the words '(default theme)'.
  3. Select the Settings link underneath the active theme's name (example: /admin/appearance/settings/gt_subtheme).
  4. Under the Search Options section, choose the Search This Site option.

To give better results when using Drupal 7's native search ability, you need to change the default search configuration settings.

Go to the Search configuration page at Configuration > Search and metadata > Search settings (or /admin/config/search/settings).

Under the Content Ranking section, change the default value of 0 for these settings:

  • Change Keyword relevance to a nice high number, such as 8.
  • Change Recently posted to a slightly lower number, such as 6.

Important Considerations for the Built-in Search Engine

Anyone leveraging Views or a page replacement module (Panels, Display Suite) will want to thoroughly test the local Drupal search engine, as Drupal's default search does not properly query Views.  In short, pages generated by views or Panels / Display Suite will not be cataloged and will not show up in relevant search query results.

On the flip side, just about all published content in any Drupal content type will be cataloged and shown in relevant search query results.  This means that search queries may turn up pages on your site that you have hidden by simply not linking them into any menus nor linking to them from any menu-linked pages.  Searches will also turn up Super Blocks and old GT Carousel image slides as individual content pages.

If this is a concern for you, you may wish to install the Custom Search module, which will allow you to hide content that you do not want showing up in search query results.

After installing Custom Search, navigate to the Configuration > Search and metadata > Custom Search > Content tab (found at admin/config/search/custom_search/content). At the bottom of the page, under the Content exclusion section, check the types of content, such as Super Blocks, that should NOT appear in search results.

GT Theme v2.8 - Search Text Box Not Appearing

GT Theme v2.8 - Search Text Box Not Appearing
Category
esembrat3 Mon, 03/20/2017 - 09:39
Drupal Version
Tags

Georgia Tech Drupal websites may notice that their search bar stops working after upgrading to version 2.8 of the official Georgia Tech Theme.  If your website was built by a developer or a vendor and uses overwritten template files, your website will likely exhibit this problem.

Symptoms

Search Box Does Not Appear

If your search selector shows an empty box (instead of the usual search box), you need to fix your Georgia Tech subtheme to match the new templates implemented in version 2.8.

 

Errors in Your System Logs

If you see an error like the following in your Drupal system log, your website likely has a broken search box.

Notice: Undefined variable: search_option_value in include() (line X of /var/www/vhosts/dev.coe.gatech.edu/httpdocs/sites/all/themes/[theme name]/page.tpl.php).

Solution

To fix this bug, replace the blob for your search box in any page-*.tpl.php files in your subtheme (sites/all/themes/[subtheme]/templates/[any page- tpl.php file] with the blob of search box code found in the file GT 2.8 Theme file sites/all/themes/gt/templates/page.tpl.php

Do not simply replace/overwrite the subtheme template file, as your subtheme may utilize custom template structure beyond the search box. 

How to Add Block Styles to Your GT Theme

How to Add Block Styles to Your GT Theme
Category
afrank30 Wed, 09/03/2014 - 15:15
Drupal Version
Tags

The GT theme includes some pre-set design treatments for blocks (see lists below of "Body styles" and "Title styles").

All versions of the new GT Theme include the CSS to display these design treatments for blocks, or "block styles". However, you have to manually add these styles to your site via the GT Tools settings to make them available as options when adding/editing blocks.

Option 1: Import SQL code into your database

The fastest way to get the standard styles is to import this sql code into your block_classes table (via phpMyAdmin in your web hosting panel).

Option 2: Create styles manually in your site's administrative interface

Another way to get the standard styles is via the block style class options, which you'll find under the GT Tools options. This is located under the System link (Configuration -> System -> GT Tools if you're using the Administration Menu module).

You can use this same method to add new block designs for your GT SubTheme, using CSS class declarations in your SubTheme and adding block styles classes through the interface (as described above).

Remember, the "Class name" must:

  • exactly match that of the class declaration in your CSS style sheet (e.g. "promo-block"),
  • begin with a letter, and
  • contain only numbers, lowercase letters, hyphens, or underscores.

Default Class names

  • promo-block
  • related-info-block
  • icon-info-title
  • icon-link-title
  • icon-alert-title
  • icon-download-title

As of version 2.5 of the GT Theme, the following styles were added:

  • icon-mortar-board
  • icon-institution
  • block-title-bg-gt-blue
  • block-title-bg-gt-gold
  • block-title-bg-gray

Georgia Tech Modules

Georgia Tech Modules esembrat3 Mon, 10/27/2014 - 12:57
Drupal Version
Tags

A number of custom modules for Drupal have been created by groups at Georgia Tech to aid campus web developers in building Drupal sites and connecting to Georgia Tech specific data sources.  The vast majority of these modules can be found in our central repository, and some of the more notable modules are described below:


Campus Supported Projects

GT Theme

The GT Theme is the official supported implementation of the website branding theme approved by Georgia Tech Institute Communications.  It requires the installation of the GT Tools module first (see below).

GT Tools

The GT Tools module provides some additional functionality that Drupal doesn't support directly in a theme package.  The Drupal 7 version also includes the GT Content Types sub-module, which provides the special content types "Horizontal Landing Page", "Vertical Landing Page", and "Multipurpose Page".

Mercury (Hg) Reader

The Mercury (Hg) Reader module lets you connect your Drupal site to Georgia Tech Mercury News and Events feeds.

Super Block Module (Drupal 7)

The Super Block Module provides content blocks preformatted with Georgia Tech design styles and colors.  It is installed like any other Drupal module, and will create a new content type called "Super Block".  The Drupal Editor's handbook describes how to create and use Super Blocks.


Community Supported Projects

Editor's Note: While GT Editor and GT Login are still part of the Drupal Express distribution of Drupal, they are no longer being supported and it is recommended that they not be installed on any non-Drupal Express site.

The following projects are not supported by Georgia Tech Institute Communications or the Office of Information Technology.  There is some limited help available from the campus web development community, but in general you should not install and use these projects unless you are a skilled Drupal developer who can handle advanced support and troubleshooting of Drupal modules.

GT Editor (Drupal 7)

GT Editor is a Drupal feature package that implements a WYSIWYG text editor with a great deal more control over what content editors can create, preventing them from doing things that might be dangerous (embedding JavaScript, for example.)  The WYSIWYG Text Editors section has documentation on configuring GT Editor.

GT Login (Drupal 7)

GT Login is a Drupal feature package that installs the CAS module and configures it to work effectively with the Georgia Tech CAS user authentication server.  Some web developers may prefer to just install the CAS module manually and configure it themselves.

GT SubTheme (Drupal 7)

GT SubTheme is a theme for Drupal that extends the GT Theme (see above) and makes it easier to add your own customizations to the theme.  Some GT provided modules may expect you to have GT SubTheme installed.

Popular Third-Party (Contrib) Modules

Popular Third-Party (Contrib) Modules root Tue, 12/04/2012 - 14:13
Drupal Version
Tags

This section describes third-party (non-Georgia Tech) modules that could be useful for your Drupal site.  These are often referred to in Drupal documentation as "contrib" modules.

You should only install modules that you absolutely need, so that your site is easier to maintain and patch.  If you decide not to use a module, be sure to disable it, then uninstall it (in Drupal 8, this is one and the same), and finally remove the module from your Drupal filesystem.  Uninstalling is very important: if you don't uninstall a module before removing it, your Drupal site will throw lots of errors at you.

If you are not sure what a module will do or if it will be useful, install it to a test instance of Drupal first so that you don't accidentally mess up a good site.


Drupal Contrib Module Lists

Popular Drupal 7 Contrib Modules

Popular Drupal 7 Contrib Modules root Wed, 07/12/2017 - 15:20
Drupal Version
Tags

Please see the introduction to contrib (third-party) modules before installing anything listed on this page.

The following information is provided as-is with no warranty or guarantees of any kind!  While members of the campus community have recommended the following modules for their listed purposes, it's perfectly possible you could blow up your Drupal website if you don't know what you're doing and install them incorrectly or alongside other modules that are incompatible.

Most descriptions are borrowed from the module's home page on the Drupal.org website.

APIs

These are only needed if required by another module.  The ones listed below are some of the most commonly used API modules.

  • Libraries - Introduces a common repository for libraries in sites/all/libraries and sites/<domain>/libraries
  • Chaos Tools (CTools) - A set of APIs and tools to improve the developer experience
  • Entity API - Extends the entity API of Drupal core in order to provide a unified way to deal with entities and their properties
  • FlexSlider - Integrates the Flex Slider library with Drupal, which allows you to build responsive, resizable slideshows 
  • Advanced Help - Provides support for advanced help documentation in modules provided in standard HTML format
  • JQuery Update - Upgrades the version of jQuery in Drupal core to a newer version of jQuery

Administrative Tools

  • Administration Menu - Administrative links are displayed in a CSS/JS-based menu at the top on all pages of your site, including links to common tasks and actions
  • Module Filter - Lets you more easily see installed modules grouped by type and quickly search through them
  • Filter Permissions - Provides filters at the top of the Permissions page for easier management.
  • Node Convert - Node Convert adds a menu tab "Convert" on the node view page that gives the ability to convert the node from its current content type to another content type.

User Authentication

Security

  • SpamSpan - Obfuscates email addresses to help prevent spambots from collecting them
  • Honeypot - Uses both the honeypot and timestamp methods of deterring spam bots from completing forms on your Drupal site
  • CAPTCHA - Provides CAPTCHA ("Are you a human?") challenge-response tests to virtually any user facing web form on a Drupal site.
  • SpamicideSpamicide adds an input field to each form then hides it with css, when spam bots fill in the field the form is discarded
  • BOTCHA - In BOTCHA, we don't abuse our human users - protection is completely transparent to them and non-intrusive. BOTCHA lets spambots to prove they are bots, and lets real users zip by
  • Mollom - Connects your site with the Mollom network to help determine if posts or comments are spam.
  • Security Review - Automates testing for many of the easy-to-make mistakes that can make your site insecure

User Interface

  • CK Editor - Allows Drupal to replace textarea fields with the CKEditor - a visual HTML editor, usually called a WYSIWYG editor
  • IMCE - An image/file uploader and browser that supports personal directories and quota
  • Image Resize Filter - Just insert an image and set it's height and width properties in HTML (done automatically by WYSIWYG editors) and the image is resized on output to match the HTML
  • Adaptive Image Styles - Allows any image to be adaptive simply by setting it to be rendered with the 'adaptive' image style.  Adaptive images are sized down based on the user's detected screen size, reducing bandwidth and load times.  [Requires .htaccess modifications]

Navigation / URL Paths

  • 404 Navigation - Causes Drupal to render the primary/main menu on 404 (page not found) error pages
  • Pathauto - Automatically generates URL/path aliases for various kinds of content (nodes, taxonomy terms, users) without requiring the user to manually specify the path alias
  • Pathologic - An input filter that can correct paths in links and images in your Drupal content in situations which would otherwise cause them to “break;” for example, if the URL of the site changes, or the content was moved to a different server
  • Redirect - Work in progress for a Drupal 7 integration and collaboration between redirection-type modules: Path Redirect and Global Redirect
  • Global Redirect - Makes sure that all ways to access a page redirect with 301 errors to a single URL path, which optimizes a site for search engines

Design / Layout

  • Paragraphs - Allows you — Site Builders — to make things cleaner so that you can give more editing power to your end-users
  • Node Block - Allows you to have nodes of specific content type(s) be provided as blocks, combining the editing flexibility of node fields with the placement flexibility of Drupal blocks
  • Panels - Allows a site administrator to create customized layouts for multiple uses
  • Menu Block - Provides configurable blocks of menu trees starting with any level of any menu

Flow and Logic

  • Workflow - Allows you to create arbitrary Workflows, and assign them to Entities
  • Revisioning - Allows for the configuration of workflows to create, moderate and publish content revisions
  • Rules - Allows site administrators to define conditionally executed actions based on occurring events (known as reactive or ECA rules)
  • Override Node Options - Allows permissions to be set to each field within the Authoring information and Publishing options field sets on the node form

Data Integration / Migration

  • Views - Provides a GUI for processing, sorting, and displaying data
    • Views Data Export - Provides a way to export large amounts of data from views [Requires Views module]
    • Views Bulk Operations - Augments Views by allowing bulk operations to be executed on the displayed rows [Requires Views module]
  • FeedsImport or aggregate data as nodes, users, taxonomy terms or simple database records
    • Feeds Extebsible Parser - A set of extensible parsers for Feeds [Requires Feeds module]
    • Feeds Tamper - Provides a small plugin architecture for Feeds to modify data before it gets saved [Requires Feeds module]
  • Bundle Copy - This module has export/import support for: Node types, Taxonomy, User, Field API fields, and Field groups

Fields and Forms

  • Link - Provides a standard custom content field for links
  • Date - This package contains both a flexible date/time field type Date field and a Date API that other modules can use
  • Location - Allows real-world geographic locations to be associated with Drupal nodes, including people, places, and other content
  • Entity Reference - Provides a field type that can reference arbitrary entities
  • Block Reference - Defines a field type that creates a relationship to a block and allows the block to be displayed as the content of the field
  • File (Field) Paths - Allows you to automatically sort and rename your uploaded files using token based replacement patterns to maintain a nice clean filesystem
  • Transliteration - Provides one-way string transliteration (romanization) and cleans file names during upload by replacing unwanted characters
  • Conditional Fields - User interface to the new States API, plus the ability to modify fields appearance and behavior on certain conditions when viewing content
  • Field Permissions - Allows site administrators to set field-level permissions to edit, view and create fields on any entity
  • Field Group - All fieldable entities will have the possibility to add groups to wrap their fields together. Fieldgroup comes with default HTML wrappers like vertical tabs, horizontal tabs, accordions, fieldsets or div wrappers
  • Webform - Allows for the creation of user friendly forms and surveys in Drupal complete with email receipts and data export

Popular Drupal 8 Contrib Modules

Popular Drupal 8 Contrib Modules root Wed, 07/12/2017 - 15:25
Drupal Version
Tags

Please see the introduction to contrib (third-party) modules before installing anything listed on this page.

The following information is provided as-is with no warranty or guarantees of any kind!  While members of the campus community have recommended the following modules for their listed purposes, it's perfectly possible you could blow up your Drupal website if you don't know what you're doing and install them incorrectly or alongside other modules that are incompatible.

Most descriptions are borrowed from the module's home page on the Drupal.org website.

Below is a list of popular contrib modules that have been ported to Drupal 8 and appear to work properly.  Do note that not all have "production" releases yet.

  • Admin Toolbar (admin_toolbar) - Replacement for the Drupal 7 Admin Menu module
  • CAS (cas) - For GT Account Username authentication (logins) to sites
  • Paragraphs (paragraphs) - API base for creating nested layout designs
  • Redirect (redirect) - Add 301 redirects automatically when page URLs change; log and manage 404 errors
  • Webform (redirect) - Has been rebuilt from the code base of YAMLForm for Drupal 8.  In production release, but very different compared to the Drupal 7 version.

Location and Gmap

Location and Gmap
Category
esembrat3 Thu, 10/02/2014 - 08:59
Drupal Version
Tags

Location and gmap modules provide embedded Google Maps for Drupal websites. 

However, the documentation and readme for configuring both of these modules is sparse, if available. Most documentation on how to utilize these modules as a pairing exist in knowledgebase entries and bug reports, which makes development using these two modules a chore.

Installing and configuring these modules takes a few main steps.

Installation

  1. Download Location and Gmap from Drupal, using the most recent stable releases for Drupal 7.
  2. Add these modules to your sites/all/modules folder.
  3. Log in to the website you wish to add these modules to.
  4. Enable these modules.

Configuration: Google

  1. Using a Google account, access the Google API Console.
  2. Create a new project.
  3. Under APIs & auth -> APIs, enable Geocoding API (for the Geocoding service of Location) and Google Maps Javascript API v3 (for Gmap). 
  4. Create a server key (for Geocoding), making sure to restrict the IPs to your server.
  5. Create a browser key (Gmap), making sure to restrict the referers to your domain(s).

Configuration: Drupal

  1. Log in as an administrator to your website.
  2. First, edit Location at: admin/config/content/location
  3. Under 'Geocoding Options', enable 'Google Maps' for United Statres.
  4. Under 'Configure parameters', enter the server key from above into the 'Google Geocoding API Server Key'. 
  5. Click 'Save Configuration'.
  6. Second, edit Google Maps at: admin/config/services/gmap
  7. Under 'Google Maps API Key', enter the browser key from above.
  8. Click 'Save Configuration'.

Configuration: Field

  1. Create a content type which utilizes a Location field.
  2. On the field options, disable the postal code, as this feature tends to break geolocation in some instances.
  3. Save the field.
  4. Test by creating a new node!

Rich Text (WYSIWYG) Editors

Rich Text (WYSIWYG) Editors root Tue, 12/04/2012 - 14:14
Drupal Version

A "rich text" or "WYSIWYG" (What You See is What You Get) text editor gives your content editors a way to create and maintain content using an interface that looks and feels a lot like using a word processor.  Formatting is applied using button controls, so the content editor doesn't have to know anything about HTML and can immediately see what the content is going to look like after it has been saved.

Drupal 8 comes with the CKEditor text editor built-in, though it is a minimal version, so site administrators may wish to install additional features through CKEditor plugins.

Drupal 7 does not come with any kind of rich text editor.  There are two popular add-on options commonly used on campus:

  • CKEditor Drupal module and CKEditor library:  This popular editor is easy to set up and gives you a wide range of flexibility in what your content editors can create.

  • Georgia Tech GT Editor module:  This module is actually built around CKEditor, but provides a great deal more control over what content editors can create, preventing them from doing things that might be dangerous (embedding JavaScript, for example.)


Rich Text Editor Guides and Resources

Drupal 8 CKEditor Enhancements, Tips and Tricks

Drupal 8 CKEditor Enhancements, Tips and Tricks kp37 Thu, 01/26/2017 - 16:15
Drupal Version
Tags

Drupal 8 includes the popular What You See is What You Get (WYSIWYG) editor CKEditor, but out of the box it only provides the 'minimal' configuration, which is missing a lot of the features you may have come to enjoy when implementing CKEditor in Drupal 7 using the CKEditor module and the full version of CKEditor.

Fortunately, there are a few easy ways to make CKEditor much more useful.  To start, the Drupal core team has assembled a list of add-on modules that implement popular CKEditor plugins, which makes it very easy to add official CKEditor features to your site:

  CK Editor Modules and Plugins | Drupal.org

    Important:  Most if not all of these modules do not include the actual plugin.  You will need to go to ckeditor.com and download the matching plugin, then create a 'libraries' directory at the root of your Drupal 8 installation and unpack the plugin into that directory.  For example, for the 'font' plugin, you should end up with a 'libraries/font' directory, which would have a file named 'plugin.js' in it, along with any other supporting files for the plugin.

    When downloading a plugin, you will need the version that works with CKEditor 4.10.1, as that is what comes with Drupal 8.6.x.  For future versions of Drupal, to determine what version of CKEditor you have, go to a page with the CKEditor editor visible, then open your browser's developer console and type:

    alert(CKEDITOR.version);

    In addition to the plugin based modules referenced above, the following special purpose Drupal 8 / CK Editor modules may also be of interest:

    • Editor Advanced Link - Adds additional properties (title, class, id, target, rel) to the Link properties box
    • Editor File - Adds the ability to upload files directly into CKEditor (just like you can now do with Images)

    Here are a few more tips and tricks for enhancing CKEditor:

    Where Did Image Properties Go?

    One thing you won't find in any of the lists above is a means of bringing back the extensive set of image properties available in CKEditor under Drupal 7, and there's a reason for this.  The designers of Drupal 8 want you to upload properly sized images and let Drupal handle their placement, so that they can be as responsive as possible.  This is actually a good thing in retrospect, as it's going to minimize the situations where a content editor uploads a giant 3000+ pixel image and then uses the size properties to make it fit on the screen.

    That said, you're probably going to want a way to float images left and right.  That ability still exists and is enabled via Configuation -> Content authoring -> Text formats and editors.  Modify one of your text formats and look for the "Align images" checkbox under "Enabled Filters".  The explanation for the option isn't very informative, but enabling it will enable options on the CKEditor image placement pop-up to left or right align (float) the image.

    You'll also want to enable "Caption images" directly below "Align images", as it provides a very useful feature for entering automatically positioned and formatted visible image captions.

    Expanding CKEditor's Default Window Height

    Editor's Note: All current versions of Drupal 8 now support CKEditor's dynamic height feature, which automatically grows the height of the editor box based on the number of lines of text it contains.  So, the following is no longer needed, but has been left here in case someone should still want to force the default height to be larger.

    One feature lost in Drupal 8 is the ability to set the number of rows on a textarea field and have CKEditor expand to fill that space.  However, you can still manually set the height of CKEditor, but you have to do it by creating a simple module.  We won't go into how to write a module here, as there are plenty of tutorials out there covering this basic topic.  Once you have the skeleton of a bare bones module in place, add this function to it, replacing 'xxxxxx' with the machine name of your module:

    function xxxxxx_editor_js_settings_alter(array &$settings) {
      foreach (array_keys($settings['editor']['formats']) as $text_format_id) {
        if ($settings['editor']['formats'][$text_format_id]['editor'] === 'ckeditor') {
          $settings['editor']['formats'][$text_format_id]['editorSettings']['height'] = '600px';
        }
      }
    }

    This will set your CKEditor window height to 600px tall.  Just change 600 to another value if you prefer the window to he taller or shorter.

    Adding a Font Size Drop-Down

    While it is not recommendable to add a font selection drop down on Georgia Tech sites, many content editors want to be able to make lines of text bigger, and if you don't give them a way to do it correctly, they'll make those lines headings, which creates accessibility problems.

    The easiest way to fix this is to add the CKEditor Font plugin using the CKEditor Font module. Once installed you can edit any of your text formats and add the 'S' button (for font 'S'ize) to the button bar.  However, if you want to be fully accessibility compliant, you should also change the available size list from point sizes to percentages.  That can be done by creating another bare bones module (see the Window Height section above) and putting the following code into it:

    function xxxxxx_editor_js_settings_alter(array &$settings) {
      foreach (array_keys($settings['editor']['formats']) as $text_format_id) {
        if ($settings['editor']['formats'][$text_format_id]['editor'] === 'ckeditor') {
          $settings['editor']['formats'][$text_format_id]['editorSettings']['fontSize_sizes'] ='80%/80%;90%/90%;Normal/100%;110%/110%;120%/120%;130%/130%;140%/140%;150%/150%';
       }
      }
    }

    Note: if you want to change both the font size menu and the window height, you can (and should) combine the code into a single function in a single module.  Just add the innermost assignment line from one of the code snippets to the other snippet.

    Getting CKEditor to Use Your Theme CSS

    By default CKEditor uses a very basic set of CSS, so the text you create and edit won't look exactly like it will when displayed by your Drupal site's theme.  However, you can tell CKEditor to use your site's CSS so that the editing experience better reflects reality.

    To do this, you will need to be using a custom sub-theme.  In your sub-theme's .info.yaml file, add the following lines:

    ckeditor_stylesheets:
      - css/fonts.css
      - css/general.css

    YAML is very picky about spacing, so take care to get it right:  it's two blank spaces (no tabs allowed), then a dash, then one more space.  Of course, replace fonts.css and general.css with whichever CSS files are needed to implement your theme's special text formatting.  You can have any number of CSS lines underneath the 'ckeditor_stylesheets:' heading.

    If you add this to a theme that is already active, be sure to flush all of your caches to get the change to take effect.

    Installing and Using CKEditor in Drupal 7

    Installing and Using CKEditor in Drupal 7 esembrat3 Fri, 02/22/2013 - 10:52
    Drupal Version
    Tags

    There are two parts to installing CKEditor for Drupal 7 (Drupal 8 comes with it already installed):

    1. The CKEditor Drupal module, which is placed in the sites/all/modules folder.
    2. The CKEditor library, which is placed INSIDE the sites/all/libraries folder.

    After installing the module and library, enable the module and it should take effect immediately.

    If you want to customize your CKEditor settings, look in the administrative configuration area under Content Authoring -> CKEditor.


    Additional Resources for Using CKEditor in Drupal 7

    Creating a True WYSIWYG Environment in CKEditor

    Creating a True WYSIWYG Environment in CKEditor eh94 Thu, 09/11/2014 - 12:42
    Drupal Version

    If you'd like the look and feel of your body text field to better mimic the look and feel of your site's theme when editing pages then you'll need to configure the CSS settings for the appropriate CKEditor profiles to use your theme's CSS.

    1. Go to Configuration -> Content authoring -> CKEditor
    2. Select the Edit link under the OPERATIONS row for the appropriate CKEditor profile (advanced, basic, etc.)
    3. Under the CSS accordion fieldset change the Editor CSS drop-down to use "Define CSS"
    4. In the CSS file path field you'll need to enter the path to the CSS file(s) of your theme. If you'd like it to use the CSS from the main GT theme, enter the following:
      /sites/all/themes/gt/css/reset.css?v=1,/sites/all/themes/gt/css/default.css?v=1,/sites/all/themes/gt/css/typography.css?v=1,/sites/all/themes/gt/css/editor.css?v=1

      Note the query string at the end of each CSS file listed (i.e., "?v=1") If you are experimenting with adding links to your own stylesheets and are finding your changes aren't showing up, just change the value in the query string, save the CKEditor settings, and next time you edit a page your changes will most likely show up. By changing the query string value you'll get CKEditor to reload the stylesheet.

    See Adding Classes to the CKEditor Styles Dropdown List if you'd like to add new custom styles there as well.

    Adding Classes to the CKEditor Styles Dropdown List

    Adding Classes to the CKEditor Styles Dropdown List afrank30 Thu, 01/23/2014 - 10:15
    Drupal Version

    If you want your editors to be able to easily apply your custom CSS classes via the Styles drop-down list in the GT Editor:

    1. Copy the js/ckeditor.styles.js file from the GT Theme (version 7.x-2.2 and above) into your subtheme folder.
    2. Add your own CSS styles to this file. The CKEditor documentation explains how this works.
    3. Go to Configuration -> Content authoring -> CKEditor
    4. Select the Edit link under the OPERATIONS row for the appropriate CKEditor profile (advanced, basic, etc.)
    5. Under the CSS accordion fieldset change the Predefined styles drop-down to "Use theme ckeditor.styles.js"
    6. Flush your browser's caches to get CKEditor to pick up the new file.  You'll need to flush your browser's caches each time you update this file.

    If you'd rather not rely on users caches expiring or telling them to flush their caches, you can use another technique to specify your styles file:

    1. Go to Configuration -> Content authoring -> CKEditor
    2. Select the Edit link under the OPERATIONS row for the appropriate CKEditor profile (advanced, basic, etc.)
    3. Under the CSS accordion fieldset change the Predefined styles drop-down to "Define path to ckeditor.styles.js"
    4. Set the Predefined styles path to point to your custom styles file.  Add "?v=XXX" where XXX is some random value.  Change this value each time you make changes to your styles file.  This change will trigger web browsers to consider the file to be updated and to ignore the version held in the browser cache.

    NOTE: If you implement a custom ckeditor.styles.js file,  you'll need to remember to integrate into this file any changes to the standard styles introduced by any newer version of the GT Theme.

    CKEditor Companion Modules

    CKEditor Companion Modules esembrat3 Wed, 01/09/2013 - 10:27
    Drupal Version

    The Drupal community on campus has found a number of modules which help with using CKEditor:

    IMCE

    Versions: Drupal 7 and 8

    ​IMCE can be used for managing images, and you might even use imce for files, as well.

    Installation instructions for IMCE:

    1. Download, install, and configure IMCE.
    2. Remove the default Image button.
    3. Add the IMCE button.
    4. Enable the option "Plugin for inserting files from imce without image dialog".
    5. Enable the option "Plugin for inserting Drupal embeded media".

    LinkIt

    Versions: Drupal 7 and 8

    LinkIt can be used for managing URL links to pages on the site and outside of the site.

    Installation instructions for LinkIt:

    1. Download, install, and configure LinkIt
    2. Remove the default URL button.
    3. Add the LinkIt button.
    4. Check "Support for Linkit module".

    Image Resize Filter

    Versions: Drupal 7

    From the Drupal.org site:  Image Resize Filter makes it easy to resize images, especially when combined with a WYSIWYG editor such as tinyMCE, CKeditor etc. Users never have to worry about scaling image sizes again, just insert an image and set it's height and width properties in HTML (this is done automatically by WYSIWYG editors) and the image is resized on output to match the HTML.

    Embedding Digital Videos in CKEditor / GT Editor

    Embedding Digital Videos in CKEditor / GT Editor afrank30 Tue, 03/31/2015 - 10:23
    Drupal Version

    Embedding Georgia Tech MediaSpace Repository Content

    A good solution for the Georgia Tech MediaSpace (Kaltura) repository has not been developed yet.  In the meantime, an experimental MediaSpace embed module is available for Drupal 7 and Drupal 8 from the developer who created the embed module for the now retired OIT Digital Media Repository.  Use at your own risk!

    After installing either module, you will have to add the new input filter to your preferred text formats.  Make sure to set the ordering so that the filter comes last after all other filters.  This ensures that the filter's Javascript code does not get filtered out by any of your other text filters.

    Embedding OIT Digital Media Repository Content

    The OIT Digital Media Initiatives (DMI) repository has been retired.  Please use the Georgia Tech MediaSpace repository (see previous section) for all of your media repository needs.

    Embedding YouTube and Vimeo Videos

    Option #1 - Video Embed Field (Drupal 7 or 8)

    1. Download, install, and enable the Video Embed Field module.
    2. Add the new video field type to one or more of your Drupal Content Types.
    3. Content editors can now add videos to nodes of those content types by inserting the right linking details into the video field.
    4. WebWash provides a tutorial about video styles you can create with the Video Embed Field module.

    Option #2 - Video Filter (Drupal 7)

    1. Download, install, and enable the Video Filter module.
    2. In the administrative configuration area of Drupal under Content authoring -> Text formats, configure each text format that you want to be able to use embedded videos.
      1. Enable the video filter.
      2. In the Filter processing order section, move the video filter down to the bottom of the list so that it is applied after all other filters.
      3. Don't forget to save your changes.
    3. On pages that use one of these configured text formats, you can now insert a video shortcode to create an embed of a supported video type.  See the download page at the link above for the full list of supported video services and formats.
    4. Example shortcode for embedding a video:

    [ VIDEO::http://www.youtube.com/watch?v=98nNpzE6gIs::aVideoStyle ]
    

    Option #3 - Ivan Allen College oEmbed Support Module

    1. Install the IAC Support for oEmbed Formats for Drupal 8 module
    2. Add the new "Embed remote content with oEmbed links" input filter to your preferred text formats
    3. Where you want to place a YouTube video, just paste in the video's oEmbed URL (see the oEmbed module's instructions for full details)

    Embedding HTML, JavaScript or PHP Code on a Page

    Embedding HTML, JavaScript or PHP Code on a Page
    Category
    afrank30 Fri, 02/13/2015 - 14:09
    Drupal Version

    The Easy Way for IFRAME and JavaScript Embeds

    If your site uses multiple roles so that your content editors do not have full administrator privileges, then the easy way may be all you need:

    The "Full HTML" format on an out-of-the-box installation of Drupal 8, or on Drupal 7 with CKEditor installed without the WYSIWYG plugin should already allow for IFRAME embeds and JavaScript embeds.  If you haven't added any tools to restrict this, then you're all set.

    For more restrictive CKEditor configurations, such as the GT Editor version of CKEditor for Drupal 7, you'll need to add a new text format (Configuration -> Content authoring -> Text formats and editors) that at a minimum allows IFRAME embeds.  If the service you want to embed from also requires you to include a snippet of JavaScript, then you'll need to enable that for your new text format as well.  You'll then want to restrict this format to site administrators (which should hopefully be a separate role from that of your site's day-to-date content creators and editors).  You can then add blocks where needed and use this new text format so that you can add your embed code to the block.

    The Absolutely Wrong Way for PHP Code

    Do not try to use the PHP Code Filter module under any circumstances!  This module used to let you put PHP Code directly into CKEditor and have it get processed when the page is displayed.  It is very unsafe and can't even be turned on in Drupal 7 unless you upgraded to Drupal 7 from an earlier version that had it turned on.  In addition, the module has been completely removed from Drupal 8.  If you are already using this method for custom PHP, you should look into switching to one of the following methods as soon as possible.

    The Preferred Way for PHP Code

    By far, the recommended way of adding custom PHP Code to a page of a Drupal site is by creating a custom module, which is a type of plugin that adds extra functionality to your Drupal site.  This does require a reasonable amount of PHP coding experience and time to get familiar with how to code for Drupal.  The Drupal organization has made some tutorials available to help get you started:

    For a lot of cases, the right approach is to create a module that implements its own dynamic block(s).  These will act like a custom block that you create in the Block Layout interface, only the content will be generated by your module instead of being entered through the Drupal user interface.  Thus, you could implement a block that has your external embed code or custom PHP code output as its content, then place that block on whichever page you want the output to show.

    The Alternate Method (PHP, IFRAMEs, JavaScript) (Drupal 7)

    The following method is a little more round-about, but doesn't require as much coding knowledge as the previous method.  The main downside is that it may be difficult for someone in the future to figure out where your custom PHP or embed code has been stored, since this is a non-standard and uncommon method.  It also sort of goes against design standards, which say that template files really should not contain any actual content, but rather should contain framework for content provided to them by the system using that template.

    1. Create a normal block (not a Super block!), and don't type anything other than spaces into the Body field.
    2. Write down the block's ID number, which will show in the URL after you save the block and go back to that block's "Configure" page. For example, in the URL http://example.gatech.edu/admin/structure/block/manage/block/30/configure, the block id is the number between "block" and "configure", in this case, 30.
    3. Add this block to a page on your site, preferably a test page that no one will find, and keep that page open in your web browser.
    4. In the subtheme for your site, usually within its "templates" folder, create a file that will only effect this specific block.  For our example block #30, the file would be named block--block--30.tpl.php
    5. Inside this file, first paste the code for a generic block template file (Drupal 7) from the View source sub-section of the File section of the Drupal block API documentation page (Abbreviated source example copied below).
    6. If you want to completely overwrite what people might type into the Body field of this block, then replace the <?php print $content ?> line. Otherwise, decide if your embed code should appear below or above whatever the Body field's content.

    Sample Block Template Code (Drupal 7)

    <?php

    /**
     * @file
     * Default theme implementation to display a block.
     * For variables definition, visit:
     * https://api.drupal.org/api/drupal/modules!block!block.tpl.php/7
     */
    ?>
    <div id="<?php print $block_html_id; ?>" class="<?php print $classes; ?>"<?php print $attributes; ?>>

      <?php print render($title_prefix); ?>
    <?php if ($block->subject): ?>
      <h2<?php print $title_attributes; ?>><?php print $block->subject ?></h2>
    <?php endif;?>
      <?php print render($title_suffix); ?>

      <div class="content"<?php print $content_attributes; ?>>
        <!-- DELETE PRINT LINE BELOW IF OVERWRITING BODY OF BLOCK -->
        <?php print $content ?>
        <!-- START EMBED CODE HERE -->
        <!-- END EMBED CODE HERE -->
      </div>
    </div>

    GT Editor Site Administrator Documentation [Drupal 7]

    GT Editor Site Administrator Documentation [Drupal 7] root Fri, 07/07/2017 - 14:56
    Drupal Version
    Tags

    The Georgia Tech GT Editor module for Drupal 7 is built around CKEditor, but provides a great deal more control over what content editors can create, preventing them from doing things that might be dangerous (embedding JavaScript, for example.)

    This is a community supported project, meaning it is not officially supported by OIT or Institute Communications.


    GT Editor Guides and Tutorials

    Installing GT Editor in Drupal 7

    Installing GT Editor in Drupal 7 afrank30 Thu, 01/23/2014 - 10:05
    Drupal Version
    Tags

    Below are instructions for installing and configuring the GT Editor feature, which extends the CKEditor rich text editor to add additional tools for image, file, and video management, as well as security settings that filter out unacceptable code.

    Editor's Note:  These instructions are for version 7.x-2.3 of GT Editor.

    Video introduction

    Watch an overview of GT Editor in minutes 1:39 to 1:45 of this video from our November 2013 GT Build Day.

    Train Your Editors

    Training guides can be found under the "Basic Training for GT Editor" section of this site.

    Prerequisites (Things to Install First)

    User Roles and Content Types

    This feature assumes you are using the three user roles and three content types created by GT Tools

    Libraries

    You must install the CKEditor Library (currently version 4.4.3-full) in sites/all/libraries.

    GT Modules and Themes

    You should also install these GT features/themes:

    Drupal Contrib Modules

    You should also install (in sites/all/modules) these contributed Drupal modules:

    GT Editor Installation

    Once you have installed all of the above items, you can then install the GT Editor module like you would any other module.

    Multi-sites and Path Issues

    If you install GT Editor on a multi-site, you will need to change a number of path settings (as they are designed for a single, root site).  Here are some of the locations to change paths:

    • "Predefined styles path" at admin/config/content/ckeditor/edit/basic
    • "File system" for public, private, and temporary file directories at admin/config/media/file-system

    My Links Menu (A.K.A. "Editor menu of POWER")

    GT Editor, when installed, creates a new My Links menu for the Editor role.  Here are the links that GT Editor (as of version 7.x-2.3) adds to this menu:

    • add or change Events (Mercury)
    • get new Events (Mercury cache)
    • find Pages (list)
    • change Menu links
    • new Page
    • new Horizontal layout
    • new Vertical layout
    • new Multipurpose layout
    • new Block
    • move Blocks

    You will need to alter the new link "get new Events (Mercury cache)",  as the default link goes to "http://mysite.gatech.edu/?clearcache=1". You need to change "mysite" to whatever your site's actual domain name is. This link makes it easier for editors to clear their cache in Mercury, to force updated events and news to show up in their Mercury blocks almost as soon as they are added to the Mercury system.

      Allowing Additional CSS Classes in GT Editor

      Allowing Additional CSS Classes in GT Editor
      Category
      afrank30 Thu, 01/23/2014 - 10:01
      Drupal Version
      Tags

      Are you adding design elements with CSS and want editors to be able to use your new CSS classes within GT Editor?  You may have discovered that those classes are being stripped out when the page is saved.  What's happening is that GT Editor operates on a whitelist principle to keep your site and its content safe. You must add any elements, classes, etc. that you want to use to the editor's whitelist - otherwise, it will assume the worst and remove them when you save a page.  GT Editor strips all non-whitelisted classes and elements using the WYSIWYG Filter module. This module is configured within each text format (such as the "basic text editor" format that comes standard in GT Editor).

      The Easy Way: Use Standard "gt-ed-*" Class Naming

      The latest versions of GT Editor (7.x-2.0-beta1 and above) will allow any CSS class that starts with "gt-ed-".  So, if you don't mind adding CSS classes that use this naming format, you're done.

      Create Your Own Text Format

      If you want to use CSS classes that aren't in the "gt-ed-" naming format, you will need to create your own text format (at admin/config/content/formats). This way, any changes you make to the format won't be overwritten when you update the GT Editor.

      It is recommended that you copy the settings from the existing basic text editor text format into your new format, and THEN make changes. If you take this approach, you'll need to remember to integrate changes to this format from each new GT Editor version.

      To add to the whitelist of classes, look under your text format's WYSIWYG Filter settings at: admin/config/content/formats/text_editor_basic. You will see sections called Rules for Class Names and Rules for Element IDs where these filters are configured.

      Unhiding the CKEditor Text Format Selector

      Unhiding the CKEditor Text Format Selector afrank30 Thu, 01/23/2014 - 10:21
      Drupal Version

      CKEditor normally shows a Text format drop-down selector just below the editing window, but the GT Editor hides this selector to streamline the editing experience.  However, there can be cases where you want to use other Drupal text formats for special cases (e.g. embedding a Twitter or Facebook feed).

      The GT Subtheme has CSS code that hides the drop-down, which you can find at sites/all/themes/gt_subtheme/css/gt_subtheme.css.  The lines that hide the text format dropdown box are:

      
              div.form-item-log,
      	.preview h3,
      	.preview .node-teaser,
      	body.page-admin-structure-block-add .form-item-regions-seven,
      	body.page-admin-structure-block-manage-block .form-item-regions-seven,
      	fieldset#edit-body-und-0-format,
      	fieldset#edit-field-body-1-und-0-format,
      	fieldset#edit-field-body-2-und-0-format,
      	fieldset#edit-field-body-3-und-0-format
      	{
      	   display: none;
      	}
      

      Changing the Default Format Without Displaying the Text Format Selector

      If you have created your own text format and want your editors to use it instead of the "basic text editor" format, you should change the order of the text formats so that yours is first/on top at admin/config/content/formats.

      GT Editor Paragraph Image Wrapping Problem

      GT Editor Paragraph Image Wrapping Problem esembrat3 Tue, 11/08/2016 - 08:25
      Drupal Version

      Some Georgia Tech Drupal users have encountered a bug where CKEditor/WYSIWYG settings were wrapping standalone images in paragraph tags.  To fix this problem, follow the two steps below.

      Step 1. Adjust Your Theme's template.php.

      In your theme’s template.php file, add:

      /**
      * Implements hook_wysiwyg_editor_settings_alter()
      */

      function THEMENAME_wysiwyg_editor_settings_alter(&$settings, $context) {
        if ($context['profile']->editor == 'ckeditor') {
          $settings['autoParagraph'] = FALSE;
        }
      }

      Be sure to replace "THEMENAME" with the actual machine name of your theme.  For the standard GT theme, the function name would be gt_wysiwyg_editor_settings_alter

      Step 2. Adjust Your Text Format.

      In your browser, go to {domain}/admin/config/content/formats and modify each text format that your site is actively using.  F or your specified text formats (here I’m listing the Advanced one), located at , make sure that the option "Convert line breaks into HTML (i.e. <br> and <p> )" is turned off.

      Web Forms on Drupal Sites

      Web Forms on Drupal Sites afrank30 Wed, 10/01/2014 - 09:51
      Drupal Version
      Tags

      This section is for guides, tips, and tricks for creating and managing web based submission forms on Drupal sites.  The most popular tool for forms is the Webform module, but tips and tricks for other form tools can be provided here as well.

      Please note that due to European Union General Data Protection Regulation rules, when collecting personal information it is best to host your form on the campus licensed Qualtrics service, which has been approved for collecting personal data.  If you collect personal data on your unit's website, you and your unit are responsible for making sure that you follow all of Georgia Tech's data policy rules and regulations.

      If you are not collecting any personally identifiable information that isn't covered by any other privacy or secrecy policy, then you are free to host such a form wherever you like.  That said, we'd still strongly recommend not using third-party services that aren't under a Georgia Tech contract.  See the Resources for Webmasters page on "outside web hosting solutions" for an explanation of the issues with outside services.


      Web Forms Tips and Tricks

      Adjusting the 'From' Address in Webform Generated Emails

      Adjusting the 'From' Address in Webform Generated Emails esembrat3 Thu, 11/19/2015 - 09:17
      Drupal Version

      A bug exists in Webform 3.x that can prevent you from changing the "From" address in an automated email template.  There is an existing Drupal.org discussion about this issue: https://www.drupal.org/node/1804214#comment-9661515

      Drupal 7 Fix

      1. Visit Configuration -> Content -> Webform (admin/config/content/webform).
      2. Uncheck the Use Reply-To header option
      3. Save your changes.

      Securing Web Forms

      Securing Web Forms afrank30 Tue, 01/26/2016 - 09:20
      Drupal Version
      Tags

      If not properly secured, forms can easily be used by hackers and automated "bot" programs to gain access to information within our sites, deface a site, or or even gain access to all the sites on a shared server.  The following is a non-exhaustive list of tips for making any web-based form more secure.

      Form Safety Tips

      • Never ask for sensitive information or information you don't need. Examples include birth date, credit card number, student data (including GTID), and other sensitive data.
      • Protect your form with CAS login (for campus) or with CAPTCHA (for people without GT accounts).
      • Remove old data and forms.
      • Regularly archive and then delete old submissions and forms
        • Go in every month or semester and download the old submissions to a spreadsheet, and then delete those submissions from the website.
        • Close or remove web forms when they are no longer in use.
      • Use HTTPS for your site.

      User Interface/Experience (UI/UX) Tips, Tricks, and Tools

      User Interface/Experience (UI/UX) Tips, Tricks, and Tools esembrat3 Wed, 11/08/2017 - 10:24
      Drupal Version

      User Interface (UI) design refers to the forward facing look and feel of a website.

      User Experience (UX) design refers to how users will interact with and navigate through a website.

      This section provides details about useful tips, tricks, and tools relating to both areas of website design.  Accessibility is related to UI and UX, but is covered in its own section of the handbook.

      Field Boilerplate Help Text

      Field Boilerplate Help Text esembrat3 Thu, 05/24/2018 - 14:09
      Drupal Version

      Per Georgia Tech's accessibility requirements, certain fields likely need additional explanatory text accompanying them:

      Video Fields (e.g. YouTube)

      Any publicly available video must be captioned for end-users. YouTube's automatic captions are not enough to meet full guidance: any automatic captions must be manually reviewed and corrected.

      Please see the Video Captioning and Audio Transcripts page of the Resources for Webmasters website for more information.

      Image Field

      Any non-decorative image must have alternative text describing the visual component of the text.

      Please see the Ivan Allen College's Web Accessibility Primer for additional information on alternative text for images.

      Administrative Tips and Tricks

      Administrative Tips and Tricks root Wed, 07/12/2017 - 15:32
      Drupal Version

      This section collects useful tips and tricks for administering a Drupal website.


      Guides and Resources

      Using Node Convert to Change a Node's Content Type

      Using Node Convert to Change a Node's Content Type afrank30 Tue, 07/22/2014 - 14:03
      Drupal Version
      Tags

      Editor's Note: Node Convert has not been ported to Drupal 8, but a replacement module called Convert Bundles is under development.  At the time of writing, Convert Bundles was still in alpha testing, so it isn't ready for prime time yet, but is worth watching for future developments.

      The Node Convert module can be used to switch between different page layouts without losing existing content.  One example is changing a Basic page so that it uses a Horizontal Landing Page layout.

      Overview of Process

      1. After backing everything up, install the Node Convert module in the usual way.
      2. Go to People -> Permissions and set permissions for your different user roles.
      3. Optionally, if you have a LOT of content to convert, or are just feeling super fancy, you can also create "node convert templates".

      Set Permissions for Users, Based on Their Role

      In your site's Administration interface, go to the page where you manage which features people can use on your site. In Drupal 7, this can be found at People -> Permissions (admin/people/permissions). The main roles usually needing permissions for converting layouts are Editor and Super Administrator.

      Editor Permissions

      Give the "Editor" role permission to convert To AND From each of the four (4) main page layouts, by checking the boxes next to these specific permissions:

      • convert from page
      • convert to page
      • convert from horizontal_landing_page
      • convert to horizontal_landing_page
      • convert from multipurpose_page
      • convert to multipurpose_page
      • convert from vertical_landing_page 
      • convert to vertical_landing_page

      Super Administrator Permissions

      Give the "Super Administrator" role all of the same permissions as an Editor, but then also check the "administer conversion" box.

      (Optional) Make Templates for converting content in large batches

      If you need to convert a LARGE amount of content, you can make this easier by creating "Node Convert templates" (under "admin/structure/node_convert_templates" in Drupal 7).

      Read documentation and examples of how to create and use these templates at:

      Security Tips

      Security Tips afrank30 Tue, 08/27/2013 - 10:51
      Drupal Version
      Tags

      The pages in this section provide helpful tips and tricks for improving the security of your Drupal website.  In addition to the information here, be sure to look at our Best Practices for Configuring and Managing Drupal page, and browse through the User Authentication section for more security tips, including how to require user login before viewing specific pages.


      Security Resources

      Keeping your Site Safe

      Keeping your Site Safe afrank30 Tue, 08/27/2013 - 11:54
      Drupal Version
      Tags

      This page is now deprecated.  Please see the Best Practices for Configuring and Managing Drupal page for an enhanced list of security and site management tips.

      Editor's Note: These tips are based on notes from “Securing Drupal 7: Don’t get Hacked or Spammed to Death!” presented at the February 2013 Georgia Tech Drupal User's Group Meeting.  Please feel free update with additional tips for securing Drupal sites!

      Secure YOUR Code

      • Drupal.org Guide to Writing Secure Code
      • Be careful if you write a module or make code changes to a Theme!!
        • Separate/Comment any changes to Code.
        • Don't hack CORE!
      • Don't install non-recommended modules, libraries, or themes
        • Test anything you're not sure about in a separate sandbox instance of Drupal

      Secure Drupal Core

      Update Drupal Core When Needed

      • Make sure the Update manager module is ON and configured for security emails (admin/reports/updates/settings)
      • Apply every security patch after backing up EVERYTHING
        • Module updates are EASY in Drupal 7
        • Installatron makes CORE updates easier (but MUST backup .htaccess and robots.txt).
      • Drupal Security Review Contrib Module - Scans your installation for common security problems

      Properly Configure Modules and Module Settings

      • Turn off the following modules unless you really need them:
        • PHP filter (Always keep this one off!)
        • Tracker
        • Comments
      • Configuration -> Logging and errors -> Error messages to display:  Set to None
      • Configuration -> Logging and errors -> Error messages to display:  Set to 1000 (or 10,000 if you have a really busy site)
      • Configuration -> Media -> File system:  Consider making private if that works for your site

      Properly Configure User Account Settings

      • Check over the User Account settings (Configuration -> People -> Account Settings)
        • Self registration for user accounts is enabled by default!  Configure Who can register accounts? so that only Administrators can register accounts.
        • Set the default for When cancelling a user account to "Disable the account and keep its content.”, because deleting users who have created content could lead to access bypass.  Alternatively, validate whether or not the user had ever created any content, and reassign the content to someone else before deleting the user account.
        • Disable the setting Enable personal contact form by default
        • Disable the setting Enable signatures (because it applies to ALL)
        • Disable the setting Enable user pictures (because it applies to ALL)
      • Regularly review your list of users (admin/people)
      • Disable User #1 in Drupal 7 as it is not needed
        • Configure a regular user account with administrative powers and use it instead
        • Rename user #1 from something common like 'admin' or 'root' to make it harder for hackers to guess the username

      Properly Configure User Permissions

      • Review user permissions regularly (admin/people/permissions)
      • Give the ANONYMOUS and AUTHENTICATED roles only View published content, add more permissions only if NEEDED.
      • Only Developer/SuperAdmin roles should get any permission that stats with "Administer”
        • (Possible) Exception. You might give EDITORS "Administer” for: Blocks, Comments, Menus.
      • Contrib Modules for fine grained permissions:
        • Override Node Options,
        • Role Delegation
        • Field Permissions, etc.

      Properly Configure Filters

      NOTE: Tailor the following to the needs of your site - not all sites need such strict rules in place.

      • Drupal.org Guide to Configuring Text Formats
      • Do NOT allow these tags: SCRIPT, IMG, IFRAME, EMBED, OBJECT, INPUT, LINK, STYLE, META, FRAMESET, DIV, SPAN, BASE, TABLE, TR, TD
      • ORDER of Filters (plain text for ALL at TOP)
      • Filter Permissions (limit ANONYMOUS & AUTHENTICATED to plain, give EDITOR basic)
        • More filters details in the Contrib modules section below.

      Contrib (Third Party) Modules and Themes

      • Disable or un-install modules you are not using (UI & Devel modules, like Masquerade). Regularly audit sites for unused modules.
      • Criteria for evaluating contrib (Erik Webb):
        • supported version(s)
        • maintainer reputation
        • total usage
        • number of open issues
        • usage change over time
      • Criteria 2: allows PHP execution? Some modules that do are: Devel; CCK fields; Views; Webform

      Contrib: CAS and Captcha/Spamicide

      • For GTaccount holders, CAS module (requiring GT Logins for certain pages/forms) will usually be sufficient to protect individual content types/forms
        • admin/config/people/cas
        • Redirection > Specific pages
        • If ANONYMOUS users can Add content or can Login, MUST HAVE Captcha + Spamicide
      • Helpful Tool: StopSpamForum.com (esp if you Block IPs in your Drupal site).

      Contrib: Editor and More Filters

      • Because user content is dangerous, pay attention to settings for editing and file uploading modules.
      • Who can use IMCE to add files/images & which file extensions are allowed? (profile)
      • Who can use LinkIt to make a Link? (profile)
      • Use WYSIWYG Filter to strip out unwanted code
      • Limit buttons on CKEditor Toolbar
      • Use Plain Text for ANONYMOUS users and on most TextArea Fields.

      Contrib: Field Permissions and Privacy

      • Create unique names for every field that holds remotely-sensitive info. Why? Because permissions are by FIELD NAME regardless of content type
        • Example: field_user_address, if used on 2 different forms, has the SAME permissions on both forms.
      • Tip: Use bundle_copy module to make a generic Content Type with pre-set fields & display settings that’s easy to alter & copy.
      • Types of data NOT to store and NOT to share:
        • FERPA student data not in directory (directory = name, email, field/dept)
        • HIPAA health-related
        • Identity theft-prone (SSN, Birthdate, etc.)
      • Types of permissions for fields and content types:
        • create
        • edit OWN; view OWN (might be safe)
        • edit ANY; view ANY (editors or admins only)
        • delete OWN; delete ANY (be careful, admins only)

      Contrib: Webform

      • http://drupal.org/project/webform
      • NOT good at fine-grained permissions
      • Can have PHP execution vulnerabilities
      • You have MUCH better better access control & reporting options (Views), if you use Content Types, instead.
      • Content types are Safer, but harder to delegate to editors for set up.

      Contrib: Views

      • http://drupal.org/project/views
      • Very popular, will be Core in Drupal 8.
      • Allows you to report out on data in LOTs of ways
      • Must take care with PERMISSIONS, esp by Role, for each View, esp if any data is private or sensitive.
      • Be careful not to allow PHP in arguments, unless necessary.

      Contrib: Pathauto and Auto Label

      External Libraries and Code

      • SUGGESTIONS requested. HOW Can we: ?
        • Regularly check libraries for security notices (CKeditor, phpCAS, jquery.cycle, etc.).
        • Audit 3rd party code for security holes (such as superglobals like $_GET)
        • Audit libraries’ example code or other 4th party included packages.
        • Discover unneeded code to remove from libraries (and, of course, notate in README.txt file)

      Editor Support

      • Training, especially security implications of:
        • forms
        • comments
        • file types
        • tag choices in HTML
      • Regular audits of content + users
        • every semester
        • less files/revisions/people to look over if hacked
        • less chance of un-used file/account being co-opted

      Server and Monitoring

      • Not a good use of time to try to hide clues that a site runs on Drupal (http://drupal.org/node/766404)
      • Robots.txt (only works on good search engines)
      • .htaccess (can limit to on-campus or VPN access, Drupal already hides directories)
      • use HTTPS, instead of HTTP
      • Securing file permissions and ownership (settings.php, etc., http://drupal.org/node/244924)
      • Regular BACKUPS (and diffs for comparison)
      • Avoid installing multiple applications on same hosting account (i.e. Wordpress AND Drupal)
      • Avoid storing ANYTHING other than the Drupal install in the web ROOT (httpdocs).

      References

      Setting Up SSL For Drupal Sites on OIT Web Hosting

      Setting Up SSL For Drupal Sites on OIT Web Hosting esembrat3 Thu, 06/16/2016 - 09:24
      Drupal Version
      Tags

      Editor's Note: Information on Obtaining and SSL Certificate and Setting Up SSL on OIT Web Hosting with an External Domain Name has been moved to the Georgia Tech Resources for Webmasters website.

      Additional details about enabling SSL for Drupal can be found in Jimmy Kriegal's posting in GitHub about SSL and Drupal sites.

      Part I: SSL Certificate

      See if you need an SSL Certificate, and if so, obtain your SSL Certificate

      Part II: Configure Your Drupal Instance

      Edit Your Site's .htaccess File

      Add the following directly after "RewriteEngine On" in your site's .htaccess file:

      RewriteCond %{HTTP_HOST} ^www\.(.+)$ [NC]
        RewriteRule ^ https://%1%{REQUEST_URI} [L,R=301]

      Edit Your Site's settings.php File

      Find the line for "$base_url" (or add one if this setting is not defined), and set it to the the fully qualified domain name of your site, like so:

      $base_url = "https://foobar.gatech.edu/";

      Important Note:  The settings.php file is usually protected from editing, so you may have to modify its access permissions before you can modify it.  Try editing it from the File Manager in your hosting account's Plesk Control Panel, as this may make it easier to override those protections.

      Move or Symlink Your Site to /httpsdocs

      Read the Enable SSL for your OIT Hosting Account post to see what kind of hosting account you have.  If you have a new-style account with only a /httpdocs/ directory, then all you need to do is add the following to your .htaccess directly below the lines you added in the "Edit Your Site's .htaccess File" section above:

      RewriteCond %{HTTPS} !=on
      RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L]

      If you have an old-style account with both /httpdocs/ and /httpsdocs/ directories, you'll need to do one of the following:

      1. If your Drupal site is not managed by Installatron, you can just move everything from /httpdocs/ to /httpsdocs/, then create a .htaccess file in your /httpdocs/ directory with the following in it:

        Redirect / <YOUR-SITE-DOMAIN-NAME-HERE>/ 301

      2. If your Drupal site is managed by Installatron, then you don't want to move it (unless you're comfortable with taking it out of Installatron first, then re-adding it to Installatron after the move.) In this case, you can take a different approach of symlinking /httpsdocs/ to /httpdocs/.

        1. Remove the /httpsdocs/ directory completely (you should be able to do this now under the current release of the Plesk Control Panel system.

        2. Create the symlink of /httpsdocs/ to /httpdocs/, either through the File Manager in the Control panel, or if using SSH:

          $ cd /
          $ ln -s httpdocs httpsdocs

        3. Add the following to your .htaccess directly below the lines you added in the "Edit Your Site's .htaccess File" section above:

          RewriteCond %{HTTPS} !=on
          RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L]

      Restricting a Website to On-Campus Access Only

      Restricting a Website to On-Campus Access Only afrank30 Tue, 08/27/2013 - 10:49
      Drupal Version
      Tags

      You can restrict your site so that only people who are on-campus (or using the VPN) can access it. This is a great idea for internal-use-only sites and also for all of your development/test websites if you are not using a local stack.

      Using .htaccess Configuration

      Here's the code to put into the .htaccess file in the root directory of your site (on OIT Web Hosting, this goes under httpdocs or httpsdocs usually):

      RewriteEngine On
      RewriteCond %{REMOTE_ADDR} !^130.207.
      RewriteCond %{REMOTE_ADDR} !^128.61.
      RewriteCond %{REMOTE_ADDR} !^143.215.
      RewriteCond %{REMOTE_ADDR} !^192.93.8.
      RewriteCond %{REMOTE_ADDR} !^10.
      RewriteCond expr "! -R '172.16.0.0/12'"
      RewriteCond %{REQUEST_URI} !/vpn-message.html
      RewriteRule ^.* /vpn-message.html [R=303,L]

      The first three lines cover the main Atlanta campus, while the fourth line (192.93.8.) covers GT Lorraine in France, and the last 2 private VPN IP space.  The last RewriteCond line is needed to whitelist your message to off-campus users - otherwise they'll end up in an infinite redirect loop.  Also note the 303 redirect status on the last line: this tells the browser to check back with the server and not cache the redirect.  If you use 301 instead, then a user who connects from off-campus and gets your message file will continue to get it even if they then connect to the VPN.  Using 301 ensures that they'll actually get to your site once they've logged into the VPN.

      The method above will direct all outside users to /message.html on your site, where you can post a message about the site being for on-campus use only. An alternate method (shown below) will just give users a 403 Forbidden error, which might be good enough in many cases.

      For Apache 2.2 .htaccess

      Order deny,allow
      Deny from all
      ## All Atlanta Campus & VPNs
      Allow from 130.207.0.0/16
      Allow from 128.61.0.0/16
      Allow from 143.215.0.0/16
      Allow from 10.0.0.0/8
      Allow from 172.16.0.0/12
      ## GT Lorraine
      Allow from 192.93.8.0/24
      

      For Apache 2.4 .htaccess

      Require all denied
      ## All Atlanta Campus & VPNs
      Require ip 130.207.0.0/16
      Require ip 128.61.0.0/16
      Require ip 143.215.0.0/16
      Require ip 10.0.0.0/8
      Require ip 172.16.0.0/12
      ## GT Lorraine
      Require ip 192.93.8.0/24
      

      Using a Firewall

      If your website is not on OIT Web Hosting, then you can also limit access through firewalls:

      Software Firewall

      This kind of firewall you have to set up and maintain yourself, so you need to have some basic networking knowledge to get it configured correctly.  On the other hand, you can reconfigure it yourself whenever necessary.  On UNIX style systems (Linux, Mac OS X, etc.), you can use either  ipfilters or ipfw.  On Windows servers, Microsoft provides its own firewalling tools - check your Windows server documentation for more information.

      Hardware Firewall

      This kind of configuration has to be done via the GT Networking Firewall web application by someone authorized to make changes to the subnet that your server lives on.  The upside to this option is that you don't have to know anything about networking, and you don't have to worry about your firewall breaking when you run upgrades on your server's operating system.  The downside is that if you don't have access to mange the firewall for your subnet then you'll have to send your requests for changes up to whomever manages your subnet.

      User Authentication and Authorization

      User Authentication and Authorization root Tue, 12/04/2012 - 13:48
      Drupal Version

      Authentication and authorization are often confused with each other.

      Authentication is the process of securely identifying a user based on credentials presented (username, password, security token, etc.)  For website user authentication, Georgia Tech predominantly uses Central Authentication Service (CAS), often times referred to as the GT Login Service.

      Authorization is the process of determining what roles and/or privileges an authenticated user has been granted.  For user authorization, there are options available through both CAS SAML attributes and through LDAP queries.


      Authentication and Authorization Guides and Resources

      CAS Single Sign-On

      CAS Single Sign-On esembrat3 Fri, 03/15/2013 - 14:39
      Drupal Version

      Central Authentication Service (CAS) based single sign-on is the main method of doing authentication via GT Account Usernames for Drupal website logins.  Once users have logged into the GT CAS system, the can access any Georgia Tech website that utilizes CAS without having to enter their GT Account Username again, as long as they don't completely close their browser or clear their browser's cookie cache.


      CAS Guides and Resources

      Installing CAS

      Installing CAS root Tue, 12/04/2012 - 13:50
      Drupal Version

      There are two components needed to add CAS support to a Drupal website: the phpCAS Library, and two supporting Drupal modules.

      phpCAS Library

      This library is only needed for Drupal 7.  If you are installing the CAS module for Drupal 8, you can skip this section.

      1. Download and install the current, stable version of the phpCAS Library.  As of early 2017, the current version was phpCAS 1.3.4 – if you are using and older version, you should consider upgrading as soon as possible to get the latest security patches.
      2. Install it under the sites/all/libraries/ directory of your Drupal site.  Rename the top level directory to CAS so that you have the CAS.php file inside of sites/all/libraries/CAS/

      Drupal Modules

      You will need to configure CAS to talk to the Georgia Tech CAS service.

      1. Log into the special original user account (user #1) that you setup when creating your Drupal site.  This is the main administrative account that has full power over everything in your site.  If this account is the same as someone's GT Account Username, you should rename the account to something else (good names are "root" or "admin", which make it easy to identify the account later on.
      2. For Drupal 7, download and install the Libraries and CAS modules into your Drupal site's sites/all/modules/ directory, or if your site supports it, install them via the Install Module option in the Modules section of your site's administrative controls.
      3. For Drupal 8, download and install the External Authentication and CAS modules into your Drupal site's sites/all/modules/ directory, or if your site supports it, install them via the Install Module option in the Modules section of your site's administrative controls.
      4. Go to the Modules page of your site's administrative controls and enable (turn on) both modules.  Once you have enabled these modules DO NOT LOG OUT OF THE SITE until you have finished the remaining steps.  Otherwise, you will find yourself locked out of your site!
      5. For Drupal 7 only, go to the Permissions page of your site's administrative controls (found under the People section), and make sure that the following permissions are enabled for the highest level user role in your site (commonly "administrator", or for sites using the GT Profile, "super administrator") (Don't forget to save your changes!) :
        • CAS -> Administer CAS
        • User -> Administer Permissions
        • User -> Administer Users
      6. Go to the CAS settings page of your site's administrative controls (found under the Configuration -> People section) and configure your CAS settings (see Drupal version specific links below for more details).
      7. Add a new user to the site with the username and "CAS username" both being the same as your GT Account Username.  Set the other fields as needed (enter a random value for the password field) and give the account the highest access level available (usually 'administrator').  Don't forget to save the new account.
      8. In a different web browser from the one in which you are currently using (or via your browser's private browsing feature), browse to your Drupal site and verify that you can login with your personal GT Account Username and password.  You should not see the normal Drupal login prompt - if you are prompted at all, you should be taken to the Georgia Tech Login service and then brought back to the Drupal site after you've successfully logged in to your GT Account.
      9. Repeat step #7 above for each user who should have access to the site, setting the access level as appropriate for the individual user.

      CAS Configuration Guides

      Configure CAS (Drupal 6)

      Configure CAS (Drupal 6) root Tue, 12/04/2012 - 13:55
      Drupal Version

      The following settings should be adequate for most Georgia Tech developers using Drupal version 6. 

      The CAS configuration page can be found at: http://yoursite/admin/user/cas

      CAS Server Settings

      • CAS version — 2.0 or higher
      • CAS server — login.gatech.edu
      • CAS port — 443
      • CAS URI — cas
      • Check to see if a user is already logged in? — The function of this setting is unclear. It doesn't seem to do anything, but we (Communications & Marketing) leave it unchecked.
      • CAS PEM certificate verification — Do not verify the certificate
      • CAS PEM Certificate (phpCAS 0.6 or greater) — leave blank
      • Initialize CAS as proxy — unchecked
      • CAS PGT storage file format — Plain Text
      • CAS PGT storage path — leave blank
      • Enable CAS Single Sign Out (CAS server 3.1 or greater) — unchecked
      • CAS debugging output filename — leave blank

      User Account Settings

      • Is Drupal also the CAS user repository — unchecked
      • If Drupal is not the user repository, should cas hijack users with the same name? — You will probably want this box checked. This will allow you to create people's Drupal accounts before they log in. If you leave it unchecked, you will need to make user the following box is checked and you will have to get people to log in before you configure their accounts.
      • Should Drupal user accounts be automatically created? — If you want any GT user to be able to log into your site, you will want this box checked. If you want to pre-approve selected users, you will want to uncheck this box and make sure the previous box is checked. Warning: if you leave both this box and the previous box unchecked, there will be no way for CAS to associate its users with Drupal accounts.
      • Email Domain — mail.gatech.edu
      • Users cannot change email address — Checked, unless you want users to be able to use non-GT addresses.
      • Users cannot change password — checked
      • Auto-assign users to the role(s) — This is entirely up to you. Be warned, however: if you are allowing accounts to be created automatically and you are automatically endowing them with godlike powers, well, you might as well leave your house keys hanging from your mailbox while you're at it.

      Redirection Settings

      • Require CAS login for — You may specify protected pages if you have some portion of your site that is to be password-protected. If you are merely using CAS to authenticate site administrators, you make leave these fields blank.
      • Force redirection on initial login — If you want all users directed to a particular page upon login, check this box and enter the path in the following field.
      • Successful login message — We recommend the default unless you have specific other needs.
      • Redirect user on logout — https://login.gatech.edu/cas/login

      Miscellaneous Settings

      • Change password URL — https://passport.gatech.edu/
      • Registration URL — leave blank

      Login Form Settings

      • Add CAS link to login forms — Make CAS login default on login forms
      • CAS login invitation — default
      • Drupal login invitation — default
      • Redirection notification message — default

      Configure CAS (Drupal 7)

      Configure CAS (Drupal 7) root Tue, 12/04/2012 - 13:57
      Drupal Version

      The following settings should be adequate for most Georgia Tech developers using Drupal version 7.

      The CAS configuration page can be found at: http://yoursite/admin/config/people/cas

      CAS Server

      • Version — 2.0 or higher
      • Hostname — login.gatech.edu
      • Port — 443
      • URI — /cas
      • Certificate Authority PEM Certificate — /etc/pki/tls/certs/ca-bundle.crt

      Login Form

      • Add CAS link to login forms — Make CAS login default on login forms
      • CAS login invitation — Log In
      • Drupal login invitation — default
      • Redirection notification message — You will be redirected to the secure GT login page.
      • Successful login message — Logged in via GT as %cas_username.

      User Accounts

      • Automatically create Drupal accounts — unchecked/checked
        (Whether a Drupal account is automatically created the first time a CAS user logs into the site. If disabled, you will need to pre-register Drupal accounts for authorized users.)
      • Email address: username@ — gatech.edu
      • Roles — authenticated user
      • Users cannot change email address — checked
      • Users cannot change password — checked

      Redirection

      • Check with the CAS server to see if the user is already logged in? — unchecked
      • Require CAS login for — specific pages
        (Enter one page per line as Drupal paths. The '*' character is a wildcard. Example paths are 'contact' for the site-wide contact form, 'user' for the sitewide login page, 'forms/*' for every form you create under this fake directory.)
      • Excluded pages — default

      Login/Logout Destinations

      • Initial login destination — https://yoursite.gatech.edu/
        (Drupal path or URL. Enter a destination if you want the user to be redirected to this page on their first CAS login. An example path is "<front>" for the front page, or "user" for the user's page.)
      • Logout destination — <none>
      • Change password URL — https://passport.gatech.edu/
      • Registration URL — blank

      Miscellaneous & Experimental

      • Initialize CAS as proxy — unchecked
      • CAS debugging output filename — leave blank

      Configure CAS (Drupal 8)

      Configure CAS (Drupal 8) root Mon, 07/10/2017 - 14:08
      Drupal Version

      The following settings should be adequate for most Georgia Tech developers using Drupal version 8.

      The CAS configuration page can be found at: http://yoursite/admin/config/people/cas

      CAS Server

      • Version — 2.0
      • Hostname — login.gatech.edu
      • Port — 443
      • URI — /cas
      • SSL Verification — Verify using your web server's default certificate authority (CA) chain.

      All other sections are optional, but you will want to either:

      • Enable Login link enabled under the GENERAL SETTINGS section (to show a CAS login link on the regular Drupal login form/page).  This could be combined with the GATEWAY feature to speed up login for users already logged into their GT Account.
      • Post a link to /caslogin to your front page
      • Configure the FORCED LOGIN section, should you want to have visiting a path like /user automatically to log the user into CAS

      NOTE: The Drupal 8 CAS module uses a different login path (/caslogin) from what CAS used in Drupal 6 and 7, which was /cas .  However, you can easily alias /cas to point to /caslogin if you wish to maintain the old URL as a valid login path.

      An explanation on GATEWAY: this feature will check to see if the user is already logged into his/her GT Account and if so log him/her into the website.  If the user is not already logged in, then the user will simply access the site as a guest (anonymous) user.  For this reason, you must also enable the login link setting or post a login link to your front page to allow users to log into the site when they are not already logged into their GT Account.  (All GATEWAY does is to save users the trouble of selecting a login link when they've already logged into their GT Account.)

      Important: If you turn on both GATEWAY logins and Auto register users, then every Georgia Tech user who visits your site and is already logged into their GT Account will have a Drupal account created for them on your site.  This can result in your site ending up with thousands of user accounts, which can be a headache when it comes to managing the accounts of users who actually have special editing privileges on your site.  In general, you really don't want to configure a site this way unless you specifically want to allow all Georgia Tech community members to be able to create content and/or post comments to existing content.  An example of this kind of usage is this Georgia Tech Drupal community site.

      The FORCED LOGIN feature will require every visitor to have a Drupal account on your site and will log the visitor into their account when first accessing the site in a browser session.  Visitors who do not have a Drupal account will be denied access to the site.  You probably do not want to enable this for the whole site (unless the site is meant to be a private intranet), but it can be useful to enable FORCED LOGIN for subsections of a site (e.g. "/admin/*" to automatically force login when trying to access any administrative page.)

      Redirecting Users to the Campus CAS Logout Page

      Redirecting Users to the Campus CAS Logout Page root Tue, 12/04/2012 - 13:59
      Drupal Version

      Drupal and CAS utilize different logout functions. Sending the user to /logout will log the user out of your site only and just return the user to the front/home page.

      Sending the user to /caslogout will log the user out of your site and redirect the user to the logout page for CAS.

      One way to send users to the CAS logout page without hunting down and changing every script that calls logout is to set up /logout as an alias for /caslogout.

      Setting up the Alias

      • While logged in as an administrator, go to Configuration -> Search and metadata -> URL aliases -> Add alias (/admin/config/search/path/add)
      • Enter caslogout in the Existing system path field
      • Enter logout in the Path alias field
      • Select the Save button.

      Requiring User Login for Specific Pages

      Requiring User Login for Specific Pages afrank30 Fri, 06/05/2015 - 12:26
      Drupal Version

      If you are using the CAS module for user authentication, you can require users to be logged in to their GT accounts before they can access specific pages on your Drupal site.

      Enabling Restrictive Access (Drupal 7)

      1. Visit the CAS configuration page on your Drupal 7 site, at Configuration -> People -> CAS settings
      2. Under REDIRECTION, locate Require CAS login for and check the setting for specific pages.
      3. In the textbox under Specific pages, type in one page path per line (with no starting slashes)
      4. Select Save configuration at the bottom of the page once completed.

      Enabling Restrictive Access (Drupal 8)

      1. Visit the CAS configuration page on your Drupal 8 site, at Configuration -> People -> CAS
      2. Under FORCED LOGIN, locate Pages and type in one page path per line (include starting slashes)
      3. You may need to select the Enabled checkbox - untested and unclear as to whether Enabled has to be on when only forcing logins on specific pages.
      4. Select Save configuration at the bottom of the page once completed.

      Commonly Protected Paths

      Commonly protected paths include:

      • 'contact' for the site-wide contact form
      • 'user' for the site-wide login page
      • 'forms/*' for every form you create under this fake directory

      CAS Logout Error

      CAS Logout Error esembrat3 Mon, 08/24/2015 - 13:54
      Drupal Version

      Courtesy of Doug Curtis in OIT:


      People are receiving a 500 error when using the "GT Logout" link on a Drupal page.  It looks like the problem is that the Drupal CAS module is appending the "service=" query string to the end of the CAS logout URL.  The GT CAS server will accept "url=" query string but it doesn't accept the "service=" query string.  Previously, the CAS service would quietly ignore appended query strings it didn't recognize but that isn't currently the case.

      The way to fix this is to leave the "Logout destination" field blank in the phpCAS module's settings.  The "Logout destination" is supposed to be used to specify a URL to redirect the user to after the user has been logged out.  It is NOT supposed to be the URL for logging out of CAS.  By leaving the field blank, the application will be logged out of CAS but the user will still be authenticated in CAS.


      Updating the CAS Library to the Latest Version

      Updating the CAS Library to the Latest Version afrank30 Thu, 10/16/2014 - 09:41
      Drupal Version

      While the phpCAS library is pretty stable, its maintainers do still release updates periodically, and every now and then one of those updates is to fix a security issue. Below are step-by-step instructions for how to update your phpCAS library to the most current, secure version.

      For this example, we will update from version 1.3.2 to version 1.3.3, but the same steps should apply to updating between any versions of the phpCAS library (which allows logins with GTaccounts to our drupal sites).

      1. Download the latest version of phpCAS from the phpCAS website.
      2. If you don't want to use ssh/command line, "extract" the files from this compressed archive on your computer (Windows users can use the free 7-zip program to do so), which will create a folder called CAS-1.3.3, that has another CAS-1.3.3 directory and a package.xml file inside it.
      3. Change the name the second CAS-1.3.3 folder (that is inside the other) to CAS.
      4. Zip up that re-named "CAS" folder...usually by right-clicking and choosing either Compress "CAS" (on a Mac OS X computer) or Send to -> Compressed (zipped) folder (on a Windows computer).
      5. Now that you have a friendly zipped file, named "CAS.zip", find where the CAS library lives on your server. The best practices location on a Drupal site is under the "sites/all/libraries" folder (which often requires you to add the Libraries module to your Drupal site, first).
      6. Then, turn on your TEST site's maintenance mode (because, of course, you are not trying this out on your live site). For Drupal 7, you can enable this at: admin/config/development/maintenance
      7. Delete the current version of phpCAS that lives at sites/all/libraries, so that there is no "CAS" folder anymore.
      8. Upload your new CAS.zip file to your Test site's libraries folder, so that it looks like this: sites/all/libraries/CAS.zip.
      9. Check the box next to CAS.zip in your web hosting panel and then, from the menu of options at the top of your file list, choose More -> Extract Files and then select Okay.
      10. Once you see your new "CAS" folder, you can then delete the "CAS.zip" file from this directory and your library has been updated.
      11. Remove your Test site from maintenance mode and make sure it works correctly.
      12. If all goes well, follow the same process on your Live site.

      Using CAS to Retrieve GTED User Attributes

      Using CAS to Retrieve GTED User Attributes robert Wed, 07/29/2015 - 14:00
      Drupal Version

      CAS is capable of delivering some GTED attributes for the person logging in to Drupal, as part of the login process.  This means you don't have to configure and maintain an LDAP module nor manage an LDAP service account (read: no need to keep up with an expiring service account password).

      While Georgia Tech's CAS service will provide authentication for any site within the ".gatech.edu" domain, by default it won't release any attributes.  You'll have to request what attributes your application needs by filling out the OIT IAM Data Steward Request Form (this is the same web form that you use to request a GTED LDAP service account.)  Make sure you specify CAS authentication and whatever data you need under Data Request.

      Once that has been approved and CAS has been set up, configure Drupal to talk to CAS just as it's documented here on previous pages, except for the CAS Server Version, which needs to be set to SAML Version 1.1.  If the user's email address is one of the attributes you're requesting from CAS, then you'll want to leave the email address field under User Accounts blank.

      Now, under the Attributes tab, select the CAS Attribute Tokens button (not the "LDAP Attribute Tokens" if you have that).  It should show you a list of attributes Drupal is getting from CAS.  You may have to log out and log back in.  If you don't see the list, you may have to work with whoever handled your data steward request, sometimes these things take a bit of tweaking to get right.

      Still on the Attributes tab, select the Settings button.  You'll want Drupal to Fetch CAS Attributes "everytime a CAS user logs in" because, well, people's data changes all the time.  You'll probably also want to always Overwrite existing values from attributes, to make sure Drupal doesn't store any old data.  Under CAS ATTRIBUTE MAPPINGS, specify "[cas:name]" for the Username field and "[cas:attribute:email_primary]" (assuming you requested that) as the E-mail address field.

      LDAP Directory Information

      LDAP Directory Information esembrat3 Fri, 03/15/2013 - 14:42
      Drupal Version
      Tags

      Lightweight Directory Access Protocol (LDAP) is an open protocol for sharing directory information and can be used as an alternative to CAS to allow users to log in to a web application using their GT Account Username and password.  Unless your application doesn't support CAS, it's best to use it instead of LDAP, since LDAP requires obtaining a special GTED LDAP user account for your application.

      If you just want basic directory information for users without the ability to do user authentication, there is a public GT LDAP server called 'Whitepages' that can be queried from any server or workstation on-campus.


      LDAP Guides and Resources

      Whitepages GT Directory Server

      Whitepages GT Directory Server esembrat3 Fri, 01/11/2013 - 12:58
      Drupal Version

      There is a public-facing LDAP server from which you can pull general directory information from without authentication.  This server is only accessible from servers and workstations located on one of the Georgia Tech campus subnets.

      Connection Settings

      Use the default settings, unless otherwise stated beow:

      • LDAP Server Type - Open LDAP
      • LDAP Server - ldap://whitepages.gatech.edu
      • LDAP Port - 389
      • Binding Method - Anonymous Bind
      • Base DNs for LDAP users, groups, and other entires this server configuration - dc=whitepages,dc=gatech,dc=edu
      • AuthName attribute - uid
      • Email attribute - mail

      Testing Queries

      To test queries, see the OIT article on LDAP.

      Specific Clients

      • Mac Mail: LDAP Server: whitepages.gatech.edu (adding "ldap://" into the field causes the lookup to fail for me. --Sterling)

      LDAP and CAS Integration

      LDAP and CAS Integration esembrat3 Fri, 03/15/2013 - 14:42
      Drupal Version
      Tags

      Integration between LDAP and CAS allows you to grab user data fields and attributes available from the campus LDAP servers while still authenticating users via CAS. 

      Editor's Note:  As the CAS Attributes module is not participating in the Drupal security advisory policy, and the code is still in beta and hasn't been updated since 2013, we can't recommend using this technique, but we are providing the instructions below as a reference.  At this time, there is no usable version of CAS Attributes for Drupal 8, so this method is only usable currently for Drupal 7 sites.

      Drupal 7 Instructions

      1. Make sure the LDAP, CAS, and CAS Attributes modules are installed.
      2. Configure LDAP and CAS according to this handbook's instructions. Be sure to use the public-facing LDAP server for easiest setup.
      3. Go to the CAS Attributes settings page at Configuration -> People -> CAS -> Attributes (admin/config/people/cas/attributes)
      4. Open LDAP tokens in a second tab.
      5. Copy and paste the appropriate Tokens back to the profile fields on the CAS Attributes main settings page. 
      6. You may also want to use the Real Name module to replace displays of the user's username with a combination of other Profile fields.

      Use GTED to Automatically Add Users to Roles or Organic Groups

      Use GTED to Automatically Add Users to Roles or Organic Groups ma195 Wed, 04/16/2014 - 15:02
      Drupal Version
      Tags

      On campus we have GTED, the Georgia Tech Enterprise Directory, an LDAP server that stores lots of information about people.  Some is public, but a lot of it is private. With a departmental account, you can get a lot of information and feed it into Drupal to automatically set up groups of users.

      Requirements

      • Drupal 7
      • A departmental GTED account
      • Installing the following modules (in dependency order).   Note: All of the "LDAP *" modules are part of the LDAP module package.
        • CTools (ctools)
        • Entity API (entity)
        • Number - Drupal Core Module
        • LDAP Servers (ldap_servers)
        • LDAP User Module (ldap_user)
        • LDAP Query (ldap_query)
        • LDAP Authorization (ldap_authorization)
        • LDAP Authorization - Drupal Roles (ldap_authorization_drupal_role)
      • Organic Groups - optional, but we will include setup instructions; adding Organic Groups requires the following modules:
        • List - Drupal Core Module
        • Text - Drupal Core Module
        • Entity API (entity)
        • Entity reference (entityreference) - required for Organic Groups https://drupal.org/project/Entityreference
        • Organic groups UI - Sub-module of Organic Groups
        • Organic groups access control - Sub-module of Organic Groups
        • LDAP Authorization - OG (organic Groups) (ldap_authorization_og)

      Setup

      Create your Roles

      Go to /admin/people/permissions/roles or People -> Permissions -> Roles and create the roles you are going to populate. For this demo, we will create three: Employees, Faculty and Staff.

      Create your Organic Groups (Optional)

      Organic Groups requires a content type and a bit of setup. We will assume that this has been done already. For this demo, we will create three: OGEmployees, OGFaculty and OGStaff.

      Set Up LDAP

      Head to /admin/config/people/ldap or Configuration -> People -> LDAP Configuration

      Settings

      You can leave everything the same here, though you may want to check "Enabled Detailed Watchdog Logging" for testing.

      Servers

      Select the Add LDAP Server Configuration button.

      Connection Settings

      • Machine name and name can be whatever you want.
      • Check Enabled
      • Server Type is default
      • LDAP server is ldaps://r.gted.gatech.edu The ldaps:// in front is important!
      • LDAP Port is 636. This is the secure LDAP port.

      Binding Method

      • Binding Method for Searches should be Service Account Bind
      • DN for non-anonymous search is: uid=XXXXXX,ou=Local Accounts,dc=gted,dc=gatech,dc=edu with XXXXXX replaced by your departmental GTED login account

      LDAP User to Drupal User Relationship

      • The Base DNs for LDAP users, groups, and other entries will be ou=accounts,ou=gtaccounts,ou=departments,dc=gted,dc=gatech,dc=edu
      • AuthName attribute is uid. In GTED, your uid is your gt account.
      • Not including for now - Email Attribute is gtprimaryemailaddress

      LDAP Group Configuration

      This is where things get funky.

      The quick version:

      • Check A user LDAP attribute such as memberOf exists that contains a list of their groups.
      • Enter edupersonscopedaffiliation for Attribute in User Entry Containing Groups

      Save!

      Testing

      You should now have a GTED server set up. If it is not enabled, do that now.

      Now let's ake sure you can connect and read a record. Click test. Under "Testing Drupal Username" enter a GT account that is an active user in Drupal (preferrably your own) and click the "Test"

      You may see a bunch of error messages, but you should also see a lot of info about yourself.

      More Details

      LDAP supports groups, but GTED doesn't use them. What we do use is a field in the eduPerson schema named eduPersonScopedAffiliation. This can have multiple entries. Here's mine as an example:

      • member@gtaccounts
      • employee@gt
      • member@gt
      • credit-alum@gt
      • former-credit-student@gt
      • employee@psdept 490:arch-admin:college of arch adm & schools
      • member@psdept 490:arch-admin:college of arch adm & schools
      • employee@coa
      • member@coa
      • faculty@gt
      • faculty@coa
      • faculty@psdept 490:arch-admin:college of arch adm & schools

      Any of these can be used to sort people into a group. There are a lot more. Here's some examples from a grad student who is part of the HCI program, so they are a member of the College of Computing, College of Architecture, and Psychology departments.

      • credit-student@gt
      • student@gt
      • graduate-student@gt
      • masters-student@gt
      • student-employee@coa
      • student-employee@gt
      • member@coa
      • student@coc
      • member@coc
      • student@psych
      • student@coa
      • member@psych

      There's plenty of things that we can do with all this. My goal was to set up automatic grouping for our Intranet, so we could have things only visible to faculty, or staff, or students.

      User

      Leave this alone for now. We could use LDAP to behave like CAS and handle authentication and have users auto-created when verified by LDAP.  CAS works fine, so let's not mess with it.

      Authorization - Roles

      Add a Drupal Role Configuration.

      Make sure the GTED server is selected

      Check "Enable this Configuration"

      Uncheck "Only apply the following LDAP to drupal role configuration to users authenticated via LDAP." The basic GT Drupal install is using CAS for authentication.

      Enter your LDAP to Drupal in the "Mapping of LDAP to drupal role" box. The basic form for GTED will be the edupersonscopedaffiliation value, then the drupal group.

      So for our three Roles, the entries should be:

      employee@gt|Employees
      faculty@gt|Faculty
      staff@gt|Staff

      Click Add

      Back on the Authorization screen. First, make sure your config is enabled. Frequently it won't be if it was just created. If you need to, just edit and Enable it. Click test on the entry you just created.

      Enter your own GT Account, and a few others then test. If everything works, you should see entries in the "Authorization IDs" column for anyone who was filtered into a group.

      Authorization - Organic Groups

      This is very similar to the way that Roles are configured, except that the mappings correspond to the Organic Group name and role. For this demo we use:

      employee@gt|node:OGEmployees:2
      faculty@gt|node:OGFaculty:2
      staff@gt|node:OGStaff:2

      Note: As of 4/16/2014 there is a bug in LDAP Authorization of Organic Groups. If a user has the "Administer Organic groups permissions" which GT Super Administrators do, then they will not be added to the Organic Groups on login. It seems to work fine for users without OG Admin rights.  https://drupal.org/node/2064319

      Two-Factor Authentication

      Two-Factor Authentication esembrat3 Mon, 12/15/2014 - 08:07
      Drupal Version

      All Georgia Tech users who have been enabled for two factor authentication (2FA) are required to log into CAS with their two-factor token via the Duo 2FA service.  As of summer 2017, this includes virtually all campus employees, and will soon include all students.

      So, long story short, there is no reason to add your own two-factor authentication to your Drupal websites - you would, in effect, just be creating three-factor authentication, which would likely create more headaches than benefits.

      More information on the campus program can be found on the OIT Two-Factor Authentication website.

      Finding a Person's GT Account Username

      Finding a Person's GT Account Username afrank30 Wed, 08/05/2015 - 09:39
      Drupal Version

      The GT Account Username is the standard computer account for everyone at Georgia Tech.  It is used to access a variety of systems including TechWorks, BuzzPort, and Mercury, and can be used to access your Drupal site by installing the CAS module.   

      You may often find that need to add someone to a group in Mercury or to your Drupal site, and you need to know the person's GT Account Username.  Here are several ways that you can look up that information:

      Using Office 365

      [Instructions courtesy of Noel Moreno]

      • Go to the "People" area (click on the "waffle" in the upper left, then select "People").  
      • In the left column, check the radio button for "Directory".  
      • Enter the person's name, email address, partial name, etc. in the search box.  
      • Results are returned on the right.  Select the person of interest.  
      • In the data returned, the GT Account Username will in the person's "IM" value.  It will be "sip:[gt account]@gatech.edu".

      Using Zimbra Email

      • Compose a new fake email.
      • Click on the "To" button.
      • Search for the person. When you have found the person, DO NOT click on or select their name.  Instead, hover over their name in this directory, and their GT Account Username will be one of the fields shown.

      Using Command Line tools

      Note: Any command line tools to query data via the Georgia Tech "White Pages" (which both the Georgia Tech Directory Tools and the 'ldapsearch' examples use) will only work from on-campus or over the campus VPN.

      Creating a Georgia Tech Guest User Account

      Creating a Georgia Tech Guest User Account esembrat3 Wed, 01/09/2013 - 10:16
      Drupal Version

      If you have enabled CAS authentication to help keep your site secure, but have a limited number of non-GT users who need access to certain protected features of your Drupal site, you can create guest GT Account Usernames for them.

      Creating a New Guest User Account

      1. Log into PASSPORT (https://passport.gatech.edu)
      2. Under Sponsored Guests, choose Manage guests.
      3. Select the Create a new guest button and follow the instructions to create your guest user.
        • Only grant LAWN wireless or T-Square access if necessary.
        • Only grant permissions for the length of time the guest will need access (1-365 days).
      4. Write down the Guest's new GT Account Username and Password, so you can communicate it to them over the phone or in person (since it's not very safe to send passwords electronically).

      Solving Post-Migration Login Issues

      Solving Post-Migration Login Issues afrank30 Mon, 03/02/2015 - 10:32
      Drupal Version

      If you are unable to log in with CAS after migrating a site, make sure you copied the .htaccess file in the root of your site (httpdocs on OIT Web Hosting). 

      Please note that this file may be hidden to some file browsers. If so, configure your file browser to show hidden files.

      Technical Details

      CAS requires that Clean URLs be enabled. When Clean URLs is enabled, Drupal edits the .htaccess file to properly handle normal-looking URLs. 

      When a Drupal website is migrated without the .htaccess file, Drupal reverts to the ugly URL schema (i.e. http://drupal.gatech.edu?q=user/login). This has the side-effect of also disallowing CAS from working properly.

      CAS PEM certificate location

      CAS PEM certificate location
      Category
      esembrat3 Thu, 08/30/2018 - 09:48
      Drupal Version

      To use the CAS PEM certificate installed on websites hosted on OIT webhosting, please use the following path:

       /etc/pki/tls/certs/ca-bundle.crt

      Applying fix to resolve CAS redirect loop

      1. Login to Plesk via https://hosting.gatech.edu
      2. Click “Databases” in the side menu
      3. Click “phpMyAdmin” to edit your database
      4. Go to the “variable” table
      5. Look for a variable named “cas_cert”
      6. Click the “BLOB” link next to the variable name in the value column to download the “variable-value.bin” file
      7. When you open the file in Notepad++ (or your text editor of choice), you’ll see a line similar to this:                                               s:33:" /etc/pki/tls/certs/ca-bundle.crt";
      8. Delete the PEM path (DO NOT DELETE THE QUOTES!) and save the file
      9. Click the “Edit” link next to the “cas_cert” variable
      10. In the “value” row item, click the “Browse” button to upload the edited file
      11. You can now login to your website (if you still see the CAS authentication error message, click the “reload” button on your browser)

      Optimization and Performance

      Optimization and Performance esembrat3 Mon, 12/17/2012 - 11:51
      Drupal Version

      This section documents ways that you can optimize your Drupal site for better performance.


      Guides and Resources

      Drupal Core Optimization

      Drupal Core Optimization esembrat3 Wed, 01/09/2013 - 10:48
      Drupal Version

      A number of performance settings are recommended to cache Drupal data objects and speed up your site.

      Enable Caching and Aggragation Settings

      These settings can be enabled in Drupal 7 via the administrative control panel under Configuration -> Development -> Performance

      • Cache pages for anonymous users
      • Cache blocks
      • Compress cached pages
      • Aggregate and compress CSS files
      • Aggregate JavaScript files
      • Set Minimum cache lifetime = 15 minutes

      Disable and Remove Unnecessary Modules

      Several key internal functions in Drupal will scan all installed modules, so be sure to not only disable but also uninstall and remove any third-party (contrib) modules that you are not using.  This not only improves your site's speed but also helps to keep it better secured.

      Core modules should not be removed, since they'll just reappear the next time you do a core upgrade.  However, consider turning the following off to help speed up your site:

      • Statistics - You can offload this computation to Google Analytics
      • Syslog - We recommend using dblog instead.
      • Tracker - This can generate a lot of data, so turn it off unless you have a real need for knowing what individual users are doing.
      • Overlay - A potentially useful module, but can generate noticeable frontend lag.

      Additional Optimization Techniques

      Performance Modules

      Performance Modules esembrat3 Wed, 01/09/2013 - 10:51
      Drupal Version
      Tags

      There are also quite a few modules that attempt to cache resource-heavy actions on Drupal.

      Getting Started with Performance Module

      For most websites, core Drupal caching should be sufficient to keep CPU/memory usage down and keep your website running smoothly. However, for larger and more complex websites, additional caching and optimization will be needed.

      For your specific website (and its use cases, structure, and workflows), please browse through the modules below and see which module(s) may work for your website. 

      For questions, please contact the Georgia Tech Drupal mailing list and someone will be glad to help!

      Advanced CSS/JS Aggregation

      Availability: Drupal 7, Drupal 8

      From the module's Drupal.org page:  AdvAgg allows you to improve the frontend performance of your site. The performance benefits are achieved by using some of the features found in AdvAgg and its sub modules. Out of the box AdvAgg's frontend performance will be similar to cores.

      Boost

      Availability: Drupal 7

      Boost provides static page caching for Drupal enabling a very significant performance and scalability boost for sites that receive mostly anonymous traffic.  For shared hosting this is your best option in terms of improving performance.

      • Boost is not recommended for large websites (nodes >= 1000), as the caching process will take up the websites' allotment of CPU cycles. This will slow down the website to be unusable for end-users.
      • Boost can be used alongside Memcache API and Integration
      • No configuration for Boost is necessary beyond installing and enabling the module. 
      • Core caching in Drupal must be disabled for Boost to work properly

      CDN

      Availability: Drupal 7, Drupal 8

      CDN provides easy Content Delivery Network integration for Drupal sites. It alters file URLs, so that files are downloaded from a CDN instead of your web server.

      Before you begin, you will need to select a CDN provider. CDN have different costs and features depending on your needs. 

      • These CDNs are currently used on campus:
        • Keycdn.com - Used by the Office of International Education (Jimmy Kriigel)
          • http://oie.gatech.edu
          • http://pacific.gatech.edu
          • http://oxford.gatech.edu
      • This module is best used for websites with lots of traffic and lots of images and/or locally hosted videos.
      • KeyCDN has made a CDN Drupal Integration Tutorial available.
      • The CDN module has TEST Mode.  If you don't want to use the CDN to serve files to your visitors yet, but you do want to see if it's working well for your site, then enable testing mode.  Users will only get the files from the CDN if they have the permission to "Access files on CDN when in testing mode".
      • The "Far Future expiration" option doesn't work with the IMCE module.
        • Update: IMCE has a patch in their dev branch for this issue.
      • You can manually flush a CDN cache file by having the Display statistics Shows enabled and scrolling down to the bottom of the page and selecting "Touch" to purge the file.

      Entity Cache

      Availability: Drupal 7

      From the module's Drupal.org page:  Entity cache puts core entities into Drupal's cache API.  Due to the entity loading changes in Drupal 7, no core patches are required.

      Don't bother using this module if you're not also going to use Memcache API and Integration or Redis – the purpose of Entity Cache is to allow queries to be offloaded from the database onto alternative storage, and there are minimal, if any, gains from using it with the default database cache.

      Memcache API and Integration

      Availability: Drupal 7

      This module provides integration between Drupal and Memcached with the following features:

      • An API for using Memcached and the PECL Memcache or Memcached libraries with Drupal.
      • Memcache backends for the following systems (all drop-in):
        • Caching (memcache.inc)
        • Locking (memcache-lock.inc)
        • Sessions (memcache-session.inc) (D6 only)
      • A module that provides a comprehensive administrative overview of Drupal's interaction with Memcached and stats.
      • A set of tests that can be run to test your memcache setup.

      Memcache is ideal when there are lots of database reads and writes, as it is a cache for the data layer (this is also why it can so easily whitescreen your site when things go wrong). This article does a decent job of explaining the "whens" and "whys" of APC, Varnish and Memcached.

      Recommended Settings

      After enabling the memcache module, add this text to the bottom of your settings.php:

      $conf['cache_backends'][] = 'sites/all/modules/memcache/memcache.inc';
      $conf['lock_inc'] = 'sites/all/modules/memcache/memcache-lock.inc';
      $conf['memcache_stampede_protection'] = TRUE;
      $conf['cache_default_class'] = 'MemCacheDrupal';
      $conf['cache_class_cache_form'] = 'DrupalDatabaseCache';
      $conf['page_cache_without_database'] = TRUE;
      $conf['page_cache_invoke_hooks'] = FALSE;
      $conf['memcache_servers'] = array('localhost:11211' => 'default');

      You will need to adjust the module directories if your module is installed in a different directory.

      Troubleshooting

      In some cases, Drupal will white-screen after settings.php is edited to reflect the new memcache settings. If this occurs, please check your error log on Web Hosting.  If you see a 'Fatal Error', follow the directions below (taken from this Drupal.org thread):

      1. Backup your website.
      2. Download registry_rebuild and upload to sites/all/modules.
      3. Run registry_rebuild by navigating your browser to: [yourdomain]/sites/all/modules/registry_rebuild/registry_rebuild.php
      4. If no errors show up, your registry has been rebuilt.
      5. Delete the module from the sites/all/modules directory.

      Varnish HTTP Accelerator

      Availability: Drupal 7

      Varnish HTTP Accelerator provides integration between your Drupal site and the Varnish Cache, an advanced and very fast reverse-proxy system.  Basically, Varnish handles serving static files and anonymous page-views for your site much faster and at higher volumes than Apache, in the neighborhood of 3000 requests per second.

      Other Ways of Increasing Performance

      Other Ways of Increasing Performance esembrat3 Wed, 01/09/2013 - 10:52
      Drupal Version
      Tags

      Besides performance modules, there are several other methods for increasing the performance of your Drupal site.

      Disable Modules Only Needed During Development

      Only enable these modules while actively developing, and then turn them off the rest of the time.

      Track Your Site's Performance Baselines

      Locate and Fix PHP Errors/Warnings

      • Turn on verbose error reporting to find errors and warnings (check Apache error logs as well)
      • Perform performance testing of any custom coding.

      Optimize Javascript and Other Front-End Features

      Automating Drupal Cron on OIT Web Hosting

      Automating Drupal Cron on OIT Web Hosting esembrat3 Wed, 01/09/2013 - 10:49
      Drupal Version

      Unless you manually configure Drupal cron to be run by your web hosting server, it will be automatically run when someone visits a page on your Drupal site after a certain amount of time has passed.  This method works perfectly fine, but can slow down the display of the page the user requested since the cron run will block page generation until it has finished.  This becomes more noticeable on site visited less frequently as more tasks can accumulate that need to be executed during a cron run.

      To keep this from happening, you can schedule Drupal cron to run automatically in the background.  On a web server that you fully control, you can use UNIX style cron to run the Drupal cron job.  You can also do this on OIT Web Hosting, but you have to configure the job via the Plesk Control Panel.

      Step by Step Instructions

      1. Log into your hosting account's Plesk control panel.
      2. On the main control panel page, navigate to Schedule Tasks, found in the right-hand sidebar menu.
      3. On the Scheduled Tasks page, select the Add button
      4. Fill out the form as follows (the example here will set up Drupal cron to run every eight hours):
        • Minute: 0
        • Hour: 0,8,16
        • Day of the Month / Month / Day of the Week: * (insert an asterisk)
        • In the text field, Command, enter the following:
          curl --silent --compressed http://YOURDRUPALSITE.gatech.edu/cron.php?KEY-FROM-ADMIN-REPORTS-STATUS-PAGE
          You can find the link to put at the end of this command (KEY-FROM-ADMIN-REPORTS-STATUS-PAGE) on your Drupal site's status report page at Reports -> Status report (admin/reports/status)

      Video Tutorial

      Logs and Logging Tools

      Logs and Logging Tools root Wed, 07/12/2017 - 14:27
      Drupal Version
      Tags

      Logging details about your site's usage can be very valuable, but if not configured properly, can also be a huge resource drain.  The following articles provide useful best practices for managing your Drupal site's logging functions.


      Logs and Logging Guides and Resources

      Errors, Warnings, and Log Settings

      Errors, Warnings, and Log Settings afrank30 Mon, 06/15/2015 - 09:42
      Drupal Version
      Tags

      Fix Errors Whenever Possible

      Although hiding error messages is important from a security perspective, errors and warnings mean that something isn't working correctly, and that could likely have a negative effect on your site.  It's best to try to fix them to fix them if you can (especially if they are in your own code), or for third-party contrib modules, report them to the module or project owner.

      PHP Message Types

      PHP, which Drupal runs under, can generate three types of messages:

      • Notices - Something to be aware of that you might want to do differently, but probably won't keep your site from working.
      • Warnings - More serious issues than Notices, but are not keeping your site from running.
      • Errors - A serious issue that has caused the site code to stop running before reaching a normal completion.

      In short, errors are problems that have to be fixed, because they are impeding use of your site.  Warnings and notices ought to be fixed, but notices may be things that you have a reason for doing in an unusual way.

      Drupal 7+ Message Settings

      To change the way your Drupal 7 or 8 site shows PHP messages, go to the  Configuration -> Development -> Logging and errors (admin/config/development/logging) administrative control page.

      The recommended settings for a live, production site are:

      • Error messages to display: None. 
      • Database log messages to keep: 100 (unless you need a longer audit trail)
      • Note: Do not enable the core syslog module if you are using OIT hosting.  According to the syslog module's documentation, it is not appropriate for shared hosting.  You should be able to find most useful debugging information by looking at the error logs, as described below.

      Error Logs on OIT Web Hosting

      If using OIT Web Hosting, you will find a record (or log) of errors the server is tracking in your Plesk control panel.

      From the main panel, go into the Logs section and look for the log file called "error_log". You can either view or download this file, which lists detailed error log messages.

      Other forms of web hosting will have their own logging areas where you can look for error logs.  Check with your server administrator to find out where the logs are on any non-OIT server that you might be using.

      One thing to keep in mind is that server error logs will only contain messages from PHP.  Any messages generated by Drupal itself will be found in the Drupal Error log, found in the administrative area of your site under Reports -> Recent log messages.

      Sample Error Messages on Web Hosting

      Here are some examples of error messages you might find in your hosting log:

      [Mon Jun 15 03:01:53 2014] [warn] RSA server certificate CommonName (CN) `hosting.gatech.edu' does NOT match server name!? 
      [Mon Jun 15 08:52:25 2014] [error] [client 130.207.000.00] File does not exist: /var/www/vhosts/mysite.gatech.edu/httpdocs/favicon.ico, referer: http://mysite.gatech.edu/node/77 
      [Mon Jun 15 09:03:20 2014] [warn] [client 130.207.000.00] mod_fcgid: stderr: PHP Warning:  chdir(): open_basedir restriction in effect. File() is not within the allowed path(s): (/var/www/vhosts/mysite.gatech.edu/:/tmp/:/usr/share/pear:/var/cache/hg:/opt/atomic/atomic-php55/root/usr/share/pear) in /var/www/vhosts/mysite.gatech.edu/httpdocs/custom-file.php on line 88

      Database Logging Configuration

      Database Logging Configuration afrank30 Mon, 04/07/2014 - 08:10
      Drupal Version
      Tags

      If using the "Database logging" module in core, be sure to keep only a small number of entries (1,000 seems reasonable).

      Until we have a solution that can feed syslog information from Drupal into regular system logs on OIT Web Hosting, we use the "Database logging" module in core to track errors, logins, and other system messages. This module stores its logs in the watchdog table.

      It is important to set this module to only keep a small number of log entries (such as 1,000), so that our database servers don't get overwhelmed.  You can change the settings for your Drupal 7 site at: Configuration -> Development -> Logging (admin/config/development/logging).

      Making Sure Access Logs Are Tamed

      Making Sure Access Logs Are Tamed
      Category
      kp37 Mon, 01/25/2016 - 19:17
      Drupal Version
      Tags

      It looks like there's a bug in Drupal 7 where, if you ever turn on and activate the Statistics module (enabling the logging of accesses to the database), and then decide to turn off the Statistics module, Drupal keeps on logging to the table that it creates (accesslog), and cron never clears anything out of that table, so it can just keep growing indefinitely.  On a busy site, this can result in multiple millions of entries in that table.

      Here's what you can do to check for this condition:

      1. If you know how to use something like phpMyAdmin to examine your database, look for an accesslog table (it may have a prefix on it, depending on how your copy of Drupal was set up).  If it exists, then your site has Statistics turned on, or did at some point in the past.  If the number of rows is huge, then you probably need to do the next step.
      2. If you know you need to fix this problem, or if you don't know how to use phpMyAdmin, you can do the following:
        1. Go into your Drupal site and turn on the Statistics core module.  
        2. Next, go to Administration -> Configuration -> System -> Statistics and look at the settings there.  Disable Enable access log, set Discard access logs older than to '1 hour', and then save the configuration.  
        3. Finally, go to Administration -> Reports -> Status report, and initiate a manual cron run to clear the accesslog table.  Note that this may fail to complete if you have over a million entries in the table.  If so, then you'll need to use phpMyAdmin or something similar to clear out the table.
        4. Once you've gotten past step 2.3, go back to your Modules page and disable Statistics.

      Of course, if you actually want to use the Statistics module, then make sure that Discard access logs older than is set to something other than 'never', so that the accesslog table doesn't grow indefinitely.

      Automation and Version Control

      Automation and Version Control esembrat3 Mon, 12/17/2012 - 11:51
      Drupal Version

      This section is for tips and tricks to help automate your Drupal site maintenance tasks, specifically using the Drush command line interface.  Also covered is the use of version control systems like GitHub.

      GitHub at Georgia Tech

      GitHub at Georgia Tech
      Category
      esembrat3 Mon, 02/24/2014 - 13:10
      Drupal Version
      Tags

      Georgia Tech staff, students, and faculty can now use a Georgia Tech instance of GitHub, a version/revision control system.  This service is available thanks to the College of Engineering's brilliant proof of concept with GitHub Enterprise, and the ensuing excited buy-in from the Office of Information Technology.

      What is GitHub and Why Should I Use Revision Control?

      GitHub is a proprietary hosted extension of the open-source Git version/revision control system commonly used for open-source software projects.  It is very useful for multi-developer projects, as it allows coordinating and tracking code changes and the orderly acceptance and integration of those changes into the master project.  Version control also makes it much easier to revert back to an earlier version of the software if it is discovered that accepted changes have caused unexpected problems.

      Or, to put it short, it'll save your bacon.  Figuratively, not literally.

      Support Policy

      OIT does not offer technical support or training for Git or GitHub usage.  If you want to learn how to use git, see below for many educational resources.

      Accessing Georgia Tech GitHub Enterprise

      Just go to https://github.gatech.edu and log in with your GT Account Username and password.

      GitHub User Software

      You can access repositories in GitHub using git from the command line of most Unix based operating systems (see GitHub's KB), but you can also use a variety of GUI (graphical user interface) applications, such as:

      Drupal List

      We have a Drupal community group in GitHub that allows users to share and collaborate on projects. Please add collaborative projects to the GT Drupal group on GitHub at Georgia Tech.

      Learn to Use git with GitHub Resources

      You can learn how to use git (and GitHub) with these tools from GitHub Enterprise, such as:

      • Guides: Tutorials, tips, and workflows to help you and your team learn about GitHub.
      • Classes: Monthly free, online classes about GitHub, Git, and the union of these two technologies (and free events following these online classes that allow you to get answers directly from GitHub Experts.)

      Learn to Use git with General Internet Resources

      The internet has lots of other great places to teach you about git. Here are a few:


      Local GitHub Guides and Resources

      Forking a GitHub Repository and Using Pull Requests

      Forking a GitHub Repository and Using Pull Requests
      Category
      cfort6 Wed, 04/27/2016 - 16:15
      Drupal Version
      Tags

      Forking creates a copy of a repository which you can work on. You can then submit a pull request to have your changes reviewed and integrated with the master repo. This is the order of operations:

      FORK > SYNC > BRANCH > COMMIT > PUSH > PULL REQUEST

      Download a PDF version of this guide.

      Forking a Repository

      Reference: https://help.github.com/articles/fork-a-repo/

      In Github, navigate to the repository to be forked and select “Fork” on the upper right. Select your own user name when prompted. This creates a copy of the repository for you on Github.

      Now you should see your fork. Copy the URL using this button:

      Open Terminal and type:

      git clone https://github.gatech.edu/ORG_NAME/Repo-Name

      Here (after clone) you should paste the URL you copied at the beginning of this step. This creates a local copy of your clone on your machine under your current directory.

      Connect your Fork to the Master

      Next, sync your fork with the master to ensure that any changes going on with the master will be reflected in your local fork/clone.

      Navigate in Github to the original repository. Copy the URL as shown:

      • Open Terminal and change directories to the fork you cloned.

        cd (enter)
        ls (look for your cloned fork/repository name)
        cd Fork_Name
        git remote -v

        git remote add upstream https://github.gatech.edu/ORG_NAME/Repo-Name

      • Alternately, you can both add and fetch (sync with) your master by using this instead:

        git remote add -f upstream https://github.gatech.edu/ORG_NAME/Repo-Name

      • Verify your upstream repository is syncing.

        git remote -v

      Syncing Your Fork

      Reference: https://help.github.com/articles/syncing-a-fork/

      You probably want your fork to mirror the latest changes being made to the main repository. If you used “git remote add -f upstream” in the previous step, this is already done. If you used “git remote add upstream” and now you need to fetch upstream to sync your fork, you can use this method.

      • In Terminal, change to the directory of your local clone and fetch upstream to sync with the original master repository.

        cd Fork_Name
        git fetch upstream
      • Check out your fork’s local master branch.

        git checkout master
        git merge upstream/master

      Branch Your Fork

      Now Branch your issue locally.

      In Terminal:

      git checkout -b name_of_your_new_branch

      Committing Changes to Your Fork

      • Change your files as needed.

      • In Terminal,

        git status

        This will confirm that git is watching your modifications.

      • Add the files to staging (substitute your file name or names)

        git add path/file_name

      • Then commit

        git commit -m “First commit”

      You will get feedback saying how many files were changed and how.

      Note for newbies: A branch may contain many commits. Name your branch to reflect what you’re working on and name commits to reflect more specific changes.

      Pushing Your Changes to GitHub

      In Terminal,

      git push origin name_of_your_new_branch

      Now you should see your branch show up in Github.

      Making a Pull Request

      Reference: https://help.github.com/articles/using-pull-requests/

      • Select your branch in Github. Select “New pull request”

        You can enter details about the changes you are suggesting. You can also select a branch to send the request to, if it’s not the master branch.

      • When you’re ready, select “Create pull request” at the bottom.

        After you send a pull request, any commit that’s pushed to your branch will be automatically added to your pull request, which is useful if you’re making additional changes.

      Drush (Drupal Shell)

      Drush (Drupal Shell) esembrat3 Mon, 12/17/2012 - 13:05
      Drupal Version
      Tags

      Drush (Drupal Shell) is a great Drupal "module" to accomplish many administrative tasks via the command-line. It is not a module in the normal sense, because it's not enabled/disabled from the Drupal admin. Instead, it actually lives anywhere on your local system and is run like any other local executable. Here are some of its key features from the Drush Drupal.org page:


      A few core drush features:

      • The Drush Package Manager allows you to download, enable, disable, uninstall, update modules/themes/profiles/translations from the command line in a very simple way (apt-get style) - just type e.g. drush dl views and drush enable views in a Drupal directory to install the Views project!
      • Additionally, the Drush Package Manager also allows you to update all your modules with just one command - drush update.
      • Drush Core: several useful utilities for site administrators and developers (e.g. drush cron or drush cache clear)
      • Drupal SQL Commands help you issue queries to any of your databases (i.e. is multi-site aware) and even helps you migrate databases between your environments.
      • Drush simpletest commands make it easy to run unit tests from the command line and email results to your dev team.
      • Drush now supports aliases which let's you perform actions on separate Drupal installations.  This is very useful for multi-site configurations.

      Drush Guides and Resources

      Updating Modules via Drush

      Updating Modules via Drush esembrat3 Mon, 12/17/2012 - 13:06
      Drupal Version

      If you have to perform module updates on your Drupal site, then Drush is the way to go. Drush will help you to update all modules on your site(s) quickly and painlessly.

      Prerequisites

      • SSH/shell access
      • Somewhat higher than basic Unix/Linux command-line experience

      Process

      Drush has many commands and options. These commands need to be run from the directory where the settings.php file for your site is, i.e.

      /path/to/drupal/sites/default

      /path/to/drupal/sites/gpburdell.gatech.edu

      For the purpose of updating your modules you will basically use it like below:

      drush update

      This is interactive and will give you a listing of all the modules that need to be updated for a given site. You can then choose to update them all or continue.  Unless you are certain you want to do all of your updates at once, I suggest you use this command to see what updates are needed, then use the below command to update a few of the modules separately at one time. For short you can also use use "drush up".

      drush update modulename0 modulename1

      This let's you specify a list of modules you want to update.

      drush updatedb

      This command will perform any updates to the database schema for your modules.  This is run automatically after every Drush update. For short you can also use "drush updb".

      If you have multi-sites then after you do a Drush update you may have to move to your other multi-site folder to do a drush updatedb to update any changes to the database schema.

      Best Practices

      • Limit the number of modules you use on your Drupal sites as much as possible.
      • Try to keep modules that are shared by more than one multi-site in the sites/all/modules folder.
      • Always check the release notes for any new modules to see if installing them will require any other changes or dependencies.

      Gotchas

      • Drush expects a backup directory to be present in the root of your Drupal installation like /path/to/drupal/backup where it backs up the previous version of the module to.  Make sure you have write access to this directory.
      • If you had any modified files in the previous module directory you will need to copy those back to the correct place after the module is updated.  Luckily everything will be in the backup directory.
      • Depending on permissions you may need to run Drush as the super user.  Ask your system administrator for sudo access if needed.

      Using Drush on OIT Web Hosting

      Using Drush on OIT Web Hosting aa17 Mon, 03/18/2013 - 17:00
      Drupal Version

      If you are hosting a Drupal website on OIT Web Hosting, you can SSH into your host, but you cannot run the command-line tool Drush from your SSH session because OIT doesn't allow PHP to be run directly from the SSH command line of Web Hosting accounts.  However, this doesn't mean that you cannot use Drush at all with OIT Web Hosting – you just have to work around this limitation.

      Disclaimer

      THESE INSTRUCTIONS ARE COMPLETELY, 100%, NO, EVEN 1000%, NOT SUPPORTED IN ANY OFFICIAL WAY BY OIT WEB HOSTING.  No warranty expressed or implied.  Always back up your site and database(s) before trying these instructions.  These instructions, though tested on several sites, may break your site, cause data loss, or even make your dog not like you any more.  Be careful!

      Process

      Essentially, you will run Drush locally on your computer, but have it operate on an OIT Web Hosting site.  To do this, you will need to:

      1. Establish an SSH tunnel for the database connection, and
      2. Mount your site's files over ssh via SSHFS.

      Note: The instructions presented below are for using Drush on a Mac. If you want to try this from a Windows computer, both SSH (<) and SSHFS (WebDrive) clients are available for Windows.

      Prerequisites

      • Drush, installed locally – Installation instructions are available at the Drush Docs site.  If you have the Acquia Dev Deskstop installed, you already have Drush.  You can also install it via homebrew.

      • An SSH client – Suggested products are:

        • On a macOS / Mac OS X system: Terminal or iTerm
        • On a Windows system: SecureCRT
      • An SSHFS client to let you mount a remote filesystem over SSH – Suggested products are:

      • Access to your site via SSH – You must know the password for your site's (unfortunately named) FTP Login account, which you can set/reset via your web hosting administration panel in the Web Hosting Settings screen.  (Note as of the 2015/16 Plesk upgrades, you can now set up and use an SSH key instead of needing the SSH/FTP password.)

      • Be on campus or have access to the campus VPN Service, as OIT Web Hosting does not allow SSH directly from off-campus.

      Steps to Drush Bliss

      In the instructions below, foo.gatech.edu is a placeholder for your site's actual hostname, and foo is a placeholder for your site's SSH/FTP account. Replace these with your site's hostname and SSH/FTP account where appropriate.  Also, these instructions assume you are using Transmit as your SSHFS client.  Configuration screens for WebDrive will be similar.

      1. Install Drupal, if you haven't already... via source, Installatron, etc.
      2. Edit your httpdocs/sites/default/settings.php file, changing the databases array's host and port entries to read:
         'host' => php_sapi_name() == 'cli' ? '127.0.0.1' : 'mysql.localhost',
         'port' => php_sapi_name() == 'cli' ? '3307' : '3306',
      3. Create a file named dbip.php in your sites httpdocs directory: 
        <?php 
        if (array_key_exists('REMOTE_ADDR', $_SERVER) 
           && ((substr($_SERVER['REMOTE_ADDR'], 0,7) == '128.61.') 
           || (substr($_SERVER['REMOTE_ADDR'], 0,8) == '130.207.') 
           || (substr($_SERVER['REMOTE_ADDR'], 0,8) == '143.215.') 
           || (substr($_SERVER['REMOTE_ADDR'], 0,9) == '192.93.8'))) 
           { 
            echo gethostbyname('mysql.localhost'); 
           } 
        ?>
        
      4. On your local machine, in a terminal window, open up an SSH tunnel through your Web Hosting server to your Web Hosting account's database host:
        ssh -N foo@foo.gatech.edu -L 3307/`curl -s http://foo.gatech.edu/dbip.php`/3306
      5. Use an SSHFS client to mount your site's httpdocs directory. For Transmit, use the SFTP connection and choose Mount as Disk:


         
      6. In a terminal, navigate to the mount point ( /Volumes/foo.gatech.edu/ ) and run drush status to test your configuration. You should see the message "Database : Connected and Drupal bootstrap: Successful."
      7. When you are finished using Drush on your site, remember to close (control-C) the SSH command doing the tunneling and unmount your site's filesystem (drag it to the Trash).

      MySQL Databases for Developers

      MySQL Databases for Developers
      Category
      afrank30 Wed, 11/26/2014 - 09:23
      Drupal Version
      Tags

      This section contains selected resources and guides for dealing with the MySQL databases that are integral to every Drupal website.


      MySQL Resources and Guides

      Creating a MySQL Database

      Creating a MySQL Database
      Category
      afrank30 Wed, 11/26/2014 - 09:21
      Drupal Version

      Creating a new MySQL database for a site hosted on OIT Web Hosting can be a little confusing.  Below are the steps for getting a database set up and configured properly via the Web Hosting Plesk control panel, as well as generic steps for creating a new database on any MySQL instance that has phpMyAdmin installed.

      MySQL Database Creation on OIT Web Hosting

      1. Visit http://hosting.gatech.edu/ and select the website you want to work with from the list of sites that you manage.
      2. Select the Databases management link.
      3. On the Databases management page, select the Add New Database link.
      4. Fill in the fields on the Add New Database form, and be sure to copy down everything for future reference.  Use the password generate to generate a secure password (select the 'Show' button to see the generated value so that you can copy it down.)
      5. Select the OK button to create your new database.
      6. Back on the Databases management page, you should see a listing in the table for your new database.  The Webadmin link on that row will let you access your database via phpMyAdmin.

      Video Tutorial (1:13)

      MySQL Database Creation on a Standard Apache HTTPD Server Via phpMyAdmin

      1. Log into phpMyAdmin on your server with the master (root) user account for your mySQL instance.
      2. Select the Databases tab.
      3. In the box under Create database, enter the name for your new database and select the Create button.
      4. Select the Users tab and create a new user with a unique name and password.  Be sure to write down the name of the database you create, as well as the username and password you make for it. (As always, try to choose a fairly-secure database username and password and do NOT use your GTaccount - jdoe3).
      5. Once the account is created, grant it access to the database that you created.  You'll probably want to give the account all privileges for the database except "grant", as you usually don't want the account to be able to give out access to other accounts.

      Video Tutorial (0:39)

      MySQL Database Connection Tools

      MySQL Database Connection Tools
      Category
      afrank30 Wed, 09/04/2013 - 09:54
      Drupal Version

      You can view any MySQL database on an OIT Web Hosting website using many different GUI based applications. Below are a few implementations that have been used by members of our community:

      General Instructions

      OIT has an FAQ entry explaining how to connect to your hosting database, which also discusses using phpMyAdmin to view your database(s) from your hosting control panel (which doesn't require any additional software).

      Rochester University has a nice tutorial on using phpMyAdmin with MySQL.

      Elsewhere in this handbook is a  more in-depth post on SSH tunneling.

      The general information you'll need, if you choose to connect with a more graphical software application, is:

      • the domain name of the site your database uses (example: mydepartment.gatech.edu)
      • the SSH or FTP Login account name and password for this site
      • the host your database lives on: for OIT Web Hosting, use "mysql.localhost" instead of plain "localhost".
      • the database account's username and password (this will be different from the SSH/FTP login account and password)
      • the port for your database: 3306

      MySQL Workbench

      Andrew Dugenskei (a member of the GT Drupal community) has a preference for MySQL Workbench.

      Fortunately, MySQL Workbench (available for Mac OSX and Windows) makes it very easy to communicate with OIT web hosted databases and it is free. If you're on campus, no other software is needed. If you're off campus, you just need to first make sure you are connected to the VPN.

      Below is a screen capture from the Workbench connection manager with some pseudo values. Once the correct values are entered, connecting to an OIT databases is a just a click away.

       

      From the above screen capture and based on the Workbench Tutorial, you can use these settings.

      Under the Connection Tab, Choose "Standard TCP/IP over SSH" and then enter these parameters for your site:

      • SSH Hostname: mydepartment.gatech.edu (port name ":22" at end is optional)
      • SSH Username: myFTPaccount (for your SSH or "Local FTP" account on Web Hosting)
      • SSH Password: myFTPpassword (for your SSH or "Local FTP" account on Web Hosting)
      • MySQL Hostname: mysql.localhost (for web hosting, just use this instead of worrying about which server you're on)
      • MySQL Server Port (leave same): 3306
      • Username: database_user (for this database only)
      • Password: database_password (for this database only)
      • Default Schema: leave blank

      Navicat (Mac, Windows, Linux)

      Mike Alberghini (a member of the GT Drupal community) has a preference for Navicat because the software:

      • Has a good GUI
      • Handles multiple databases well,
      • Has Mac OS X support
      • Is 40% off for educational users
      • Saves connection info for ssh tunnels and start them as needed to connect to servers

      Screenshots of a successful Web hosting database connection with Navicat are below. 

      For Navicat, use the following settings on the "General" tab:

      • Connection Name = My Department Site
      • Hostname/IP Address = mysql.localhost (this is important for you to connect to Web Hosting)
      • Port (leave same) = 3306
      • User name = This is the username for your DATABASE's user.
      • Password = This is the password for your DATABASE's user.

      To finish your connection with Navicat, use the following settings on the "SSH" tab:

      • Use SSH tunnel = check YES
      • Hostname/IP Address = mydepartment.gatech.edu
      • Port (leave same) = 22
      • Username = This is the username of the web hosting FTP account for this site.
      • password = This is the password for the web hosting FTP account for this site.

      Sequel Pro (Mac)

      Adam Arrowood (a member of the GT Drupal community) has a preference for Sequel Pro because the product:

      • Has a nice GUI, ssh tunneling, etc. as found in other similar products.
      • Runs (only) on Mac OS X.
      • Is a free product.

      Code Snippets

      Code Snippets bwaye3 Fri, 03/14/2014 - 20:53
      Drupal Version

      This section is for sharing sample code that does useful things for site administrators and developers.  Please do not add anything directly to this page, but rather create a sub page for each individual snippet.

      Adding Multiple Jump Links to GT Super Blocks

      Adding Multiple Jump Links to GT Super Blocks
      Category
      esembrat3 Tue, 07/26/2016 - 08:06
      Drupal Version

      To allow more than one jump link on each Superblock, a quick hack is needed.

      Please note:  This is not guaranteed to work with future versions of Super Block, so proceed at your own risk.

      Prerequisites

      Log in to GT Github and download the templates/node--super-block.tpl.php file from the gt_ae project.

      Adding Multiple Jump Links

      1. On your website, edit the content type Super Block.
      2. Select Manage Fields.
      3. Select Edit, to the right of Jump Link (field_nbsb_jump_link).
      4. Under Number of Values, increase the value from 1 to your desired number (supports up to unlimited).
      5. Add the templates/node--super-block.tpl.php file to your subtheme's templates/ folder.
      6. Clear caches.
      7. Test to see if it works.

      Embedding Live Streaming Video from OIT

      Embedding Live Streaming Video from OIT afrank30 Tue, 12/15/2015 - 08:56
      Drupal Version
      Tags

      Editor's Note:  The following instructions may be out-of-date now, but are left here for future educational reference.

      Below is sample code for embedding a live stream from OIT's JW Player and Wowza server onto your Georgia Tech Drupal site, and includes sample code to embed live captions, which are required for accessibility compliance.  For more information, visit the test live stream site.

      Overview

      The safest way to include this code on a page on a Drupal site is to not use an unfiltered text format, but instead to use a block template file within your subtheme. Below is sample embed code for a live stream video and live captioning of an event. NOTE: a certificate has been added to the streaming server and the code below has been modified to allow embedded secure streaming on a secure page. This code will also work on an insecure page.

      The following words will need replaced with real values in the below code. Contact the IT person controlling the streaming to find out what those values should be.

      • [[EXAMPLE-STREAMING-SERVER]]
      • [[EXAMPLE-PLAYER-SERVER]]
      • [[STREAM-NAME]]

       

      • Streaming Sample Code

              <!-- START Live streaming video code: OIT JWPlayer and OIT Wowza server -->
              <h3 id="live-video">Live Video</h3>

              <script type="text/javascript" src="https://[[EXAMPLE-PLAYER-SERVER]].gatech.edu/player/jwplayer.js"></script>
              <style>
                  /* This is just to overwrite styling on the theme that resizes the object to be so small. It should be inserted directly before the standard embed code. If you have more than one video embed on a page, you'd need to add this for each one, incrementing the '0' after player_swf_ accordingly.
                  */
                  <!-- #player_swf_0 { height: 100% !important; } -->
              </style>

              <p id="alternate-video">
              <ul>
                  <li><a href="https://support.jwplayer.com/customer/portal/articles/1597259-keyboard-shortcuts">Keyboard controls ('c' toggles captions)</a></li>
                  <li>If having difficulties with the video, try the <a href="https://www.google.com/chrome/browser" title="Download Chrome">Chrome web browser</a>.</li>
                  <li>To access captions on Android, download the <a href="https://www.videolan.org/vlc">VLC Player app</a>, open <a href="https://[[EXAMPLE-STREAMING-SERVER]].gatech.edu:/live/[[STREAM-NAME]]/playlist.m3u8?DVR">this stream link</a>, and then choose "Closed captions 1" as the Subtitle track.</li>
              </ul>
          </p>

          <div id="player">

              <script type="text/javascript">
                  var player = jwplayer("player");
                  player.setup({
                      file: "https://[[EXAMPLE-STREAMING-SERVER]].gatech.edu:/live/[[STREAM-NAME]]/playlist.m3u8",
                      image: "https://[[EXAMPLE-PLAYER-SERVER]].gatech.edu/assets/small_bling_desktop_2560x1440.jpg",
                      hlshtml: true,
                      width: "100%",
                      aspectratio: "16:9",
                      autostart: true,
                      stretching: "uniform",
                  });

                  player.on("captionsList", function () {
                      player.setCurrentCaptions(1);
                  });
              </script>

          </div>
          <!-- END Live streaming video code -->

      Deprecated Captioning Sample Code

      Please note that the code below is no longer recommended - please use the code above instead.

      The code is available in cases of live captioning an event on a budget. As an example, you could display your stenographer's live captions during a presentation, using only a web browser and a large-screened monitor.

      At the bottom of a template file, you would include embed code for live captioning:

      <!-- START Live caption code: Feed from your Caption Company based on instructions at https://streamtext.zendesk.com/entries/21705252-embedding-streaming-text-with-streamtext-into-your-web-pages -->

      <h3>Live Captions</h3>
          <div class="live-caption">
          <iframe id="stFrame" title="Live Caption iframe" src="http://www.streamtext.net/text.aspx?event=[[CAPTION-ID]]&chat=false&header=false&indicator=false&footer=false&fs=30&spacing=1.75&bgc=262626&fgc=ffe08b&ff=Roboto,Verdana,serif" style="width:100%;min-height:400px">
          </iframe>
         </div>

      <!-- END Live caption code -->

      Read more about easy control options for this captioning embed at the Streamtext site.

      Listing Enabled Modules Using a bash Script

      Listing Enabled Modules Using a bash Script
      Category
      afrank30 Tue, 09/30/2014 - 11:14
      Drupal Version
      Tags

      A shell script that prints out a list of enabled modules in all accessible databases, designed for ssh use when you need to check multiple Drupal 6 or 7 databases at one time.

      Editor's Note:  A similar concept would work just as well for Drupal 8, but the database table names and structures have changed in Drupal 8, so you would need to adjust the script accordingly.  Also, be aware that this script will not work on any Drupal instance where you have used a custom table prefix for all of your Drupal site tables.

      With thanks to Abdul Manaf on DBA.stackexchange for the basic code.


      # mysql credential
      user="root"
      pass="pwd"
      
      all_dbs="$(mysql -u $user -p$pass -Bse 'show databases')"        
      
      # Exclude databases you don't want to check, such as non-Drupal 6 or 7 dbs.
      # Then output database name and an alphabetized list of Enabled modules.
      for db in $all_dbs
           do
              if [[ "$db" != "information_schema" &&
                  "$db" != "mysql" &&
                  "$db" != "performance_schema" &&
                  "$db" != "test" ]] ; then
                  echo '====================='
                  echo "DATABASE: $db (ENABLED Modules)"
                  echo "---------------------------"
                  mysql -u$user -p$pass $db -sN -e "SELECT name FROM system WHERE status = 1 AND type = 'module' ORDER BY name ASC;" 
              fi 
           done
      

      Listing Enabled Modules Using phpMyAdmin

      Listing Enabled Modules Using phpMyAdmin
      Category
      afrank30 Tue, 09/30/2014 - 11:40
      Drupal Version
      Tags

      Below is SQL code that prints out SQL statements that you can copy and paste back into phpMyAdmin (or any MySQL management tool that can connect to your Drupal database).  These statements will help you get a list of enabled modules, when you need to check multiple Drupal 6 or 7 databases at one time.

      With thanks to Aaron Brown on DBA.stackexchange for the basic code.

      Be careful to copy the backquotes/backticks (that look a little like left-leaning apostrophes) exactly.


      SELECT CONCAT('SELECT \`name\` FROM ', schema_name, '.\`system\` WHERE \`status\` =\'1\' AND \`type\` =\'module\' ORDER BY \`name\` ASC;')
      FROM information_schema.schemata
      WHERE schema_name NOT IN ('information_schema','mysql','performance_schema','test', 'excluded_database');
      

      This will print out a series of SQL statements, like the one below, which you could paste into the SQL tab of phpmyAdmin, in order to create lists of enabled modules.  This can be helpful if you don't have ssh access to your site, but still want an easy way to get a simple text list of enabled modules.

      SELECT `name` FROM ms6_sample1.`system` WHERE `status` ='1' AND `type` ='module' ORDER BY `name` ASC; SELECT `name` FROM ms7_sample2.`system` WHERE `status` ='1' AND `type` ='module' ORDER BY `name` ASC;

      PHP 7 Upgrading Resources

      PHP 7 Upgrading Resources kp37 Tue, 10/23/2018 - 16:19
      Drupal Version

      PHP 5.6 (the last version in the PHP 5 line) reached its end-of-life on December 31, 2018. In addition, PHP 7.0 also reached its end of life in December, 2018. As a result all OIT Web Hosting accounts are now on PHP 7.1 or later. However, PHP 7.1 reaches its end-of-life on December 1st, 2019.

      Units who have their own web servers are strongly urged to get them updated to PHP 7.2 if they haven't done so already. OIT will be updating the Web Hosting servers to PHP 7.2 between October 1st and 8th, 2019.

      Helpful Tips and Information

      Drupal Module Status Chart

      Drupal Module Status Chart kp37 Wed, 10/24/2018 - 14:56
      Drupal Version

      The following table, initially provided by the College of Computing (many thanks!) attempts to summarize the details of a large number of commonly used Drupal 7 modules and any known issues with their latest full (not development) version under PHP 7. In addition, Kevin Pittman of the College of Liberal Arts has added Drupal 8 compatibility details and removal recommendations, to help site administrators decide what to do as they review the modules installed their Drupal 7 sites.

      In general, a module is recommended for removal ASAP if it is no longer being maintained and not covered by Drupal's security advisory policy. While not flagged with a removal recommendation, modules without a Drupal 8 version should be scrutinized to see if they are truly needed on a current Drupal 7 site, since there is likely not going to be a future support path for those modules.

      Notes on the Drupal 8 column:

      • In Core - The module is now part of the official Drupal 8 system and does not have to be downloaded and installed separately under Drupal 8
      • Functionality In Core - The functionality provided by the module can be found in some form or fashion within Drupal 8
      • In Development - Someone is working on porting the module to Drupal 8, but there is not a stable and production usable version yet
      • In Release Candidate - A development version has reached a state where it could be used (with caveats) in production, but careful review by the site administrator is recommended
      Module Machine Name Category Latest Version Removal Recommended? Drupal 8 Version Covered by Security Advisory Last Update (Non-Dev) Key issue/bug info Date Checked Notes
      404 Navigation navigation404 Other 7.x-1.0

      No

      In Core Y 2011-01-07     If you create and configure a 403 and 404 page within Drupal, you don't need this module and can remove it. 7.x-1.x-dev - updated on 5/9/14
      Accordions accordions User interface 7.x-1.0-alpha4 Yes N/A N 2013-04-23     No further development
      No longer developed by its maintainers.
      Adaptive Image adaptive_image Other 7.x-1.4 No Functionality in Core Y 2012-02-24   2018-10-05 a few PHP related issues: https://www.drupal.org/project/issues/adaptive_image?text=&status=Open&priorities=All&categories=All&version=7.x&component=All
      Address Field addressfield Fields 7.x-1.2 No Functionality in Core Y 2015-10-07 Patch for 7 compatibility issue https://www.drupal.org/project/addressfield/issues/2628592 2018-10-05 used? Needed? Replaced by Address module in D8.
      Admin admin Administration 7.x-2.0-beta3 No Use admin_toolbar N 2014-12-19   2018-11-08  
      Administration menu admin_menu Administration 7.x-3.0-rc5 No Use admin_toolbar N 2014-12-19 7.1 issue (https://www.drupal.org/project/admin_menu/issues/3000678)
      7.2 - incompatibility by rc5 (https://www.drupal.org/project/admin_menu/issues/3000373)
      7.2 issue patched (https://www.drupal.org/project/admin_menu/issues/2929025).
      2018-10-05 couldn't replicate 7.1 issue locally.
      Administration views admin_views Administration 7.x-1.6 No In Core Y 2016-08-02   2018-10-05 Included in D8 core.
      Admin Tools admin__tools Administration 7.x-1.1 No In Core Y 2016-08-02   2018-11-08 Included in D8 core.
      Advanced help advanced_help Other (Administration, Utility) 7.x-1.4 No In Development Y 2018-04-14 No major or critical issues 2018-10-05 This module is incompatible with the Fast 404 module. Installing Fast 404 will produce 404 (File not found) errors if you try to look up README.txt-files.
      Alpha Pagination alpha_pagination Views 7.x-1.7 No No Y 2017-09-21      
      Automatic Nodetitles auto_nodetitle Other 7.x-1.0 No No Y 2011-06-07   2018-10-05  
      Back To Top back_to_top Other (Content, Content Display) 7.x-1.5 No Yes Y 2015-12-16   2018-10-05  
      Better Exposed Filters better_exposed_filters Views 7.x-3.6 No In Development Y 2018-09-03 Remove usage of deprecrated each() function for PHP 7.2+ future proofing    
      Block Class block_class Other (Content ,Content Display, Theme Enhancements) 7.x-2.4 No Yes Y 2018-07-27 No major or critical issues 10/5/018  
      Block Class Styles block_class_styles Other 7.x-2.6 No No Y 2016-01-13 No major or critical ssues   This module has not been ported to Drupal 8. Refer to this issue to find out its progress.
      Block reference blockreference Fields 7.x-2.7 No Functionality in Core (EntityReference) Y 2018-02-15   2018-10-05 used? Required for GT Super blocks module, which we want to avoid using.
      Block Title Link block_titlelink Other (Content Display, Theme Enhancements) 7.x-1.5 No No Y 2015-08-19 Block Title Link not working with PHP 7.*   This module is currently being ported to Drupal 8, but is not usable yet. Help us by following this issue. Couldn't replicate issue on local dev environmentThis module is currently being ported to Drupal 8, but is not usable yet. Help us by following this issue. Couldn't replicate issue on local dev environmentThis module is currently being ported to Drupal 8, but is not usable yet. Help us by following this issue. Couldn't replicate issue on local dev environment
      Bootstrap Business bootstrap_business Other 7.x-1.1 No In Development Y 2014-10-21 No major or critical issues    
      Brightcove brightcove Video 7.x-6.x-dev No Yes Y 2018-01-30 PHP 7 error with variable reuse $client.    
      Calendar calendar Date/Time 7.x-3.5 No In Development Y 2014-10-14   2018-10-05 only used if have Event content type (likely connected to Mercury)
      CAPTCHA captcha Spam control 7.x-1.5 No In Development Y 2017-09-06 PHP 7 - sometimes float instead of integer passed to srand() and mt_srand() in image_captcha_image()   This issue has been Closed(fixed) - [7.x-1.x-dev]
      CAS cas Central Authentication Service 7.x-1.7 No Yes Y 2018-02-12 Library issue. 2018-10-05 Older versions of associated phpCAS library may have outdated PHP calls. Highly recommended (and for security updates) to upgrade to the latest phpCAS library.
      CAS Attribute Tokens cas_attributes Central Authentication Service 7.x-1.0-rc3 Yes No N 2013-11-13   2018-10-05 used?
      CCK cck CCK 7.x-3.0-alpha3 Yes No N 2013-12-12   2018-10-05 most moved into Core in D7, only used for a migration
      Chaos tools ctools Chaos tool suite 7.x-1.14 No Yes Y 2018-02-24 7.1 PHPCS warning (https://www.drupal.org/project/ctools/issues/2979350)
      patched incompatibility for a reserved word (https://www.drupal.org/project/ctools/issues/2941069)
      other patches (https://www.drupal.org/project/ctools/issues/2635876)
      (https://www.drupal.org/project/ctools/issues/2713377)
      2018-10-05  
      CKEditor ckeditor User interface 7.x-1.18 No In Core Y 2017-06-26      
      CKEditor Image ckeditor_image User interface 7.x-1.2 No In Core Y 2013-07-09     Drupal 8 has its own image plugin and supports center align.
      Collapsiblock collapsiblock User interface 7.x-2.0 No Yes Y 2018-06-10      
      Context context Context 7.x-3.7 No In Development Y 2016-05-18 7.2+ issue patch for create_function (https://www.drupal.org/project/context/issues/2946595) 2018-10-05 used?
      Content Access content access Content Access 7.x-1.2-beta2 No In Development Y 2013-04-15 There are open security issues: Private files downloadable when node access is denied, needs support 2018-11-05 Content access makes use of Drupal's node access API. However, it's recommended to use only one module that does so.
      CSS Injector css_injector Other (Theme Enhancements) 7.x-1.10 No No Y 2013-12-17 No Major or critical issues    
      Custom Breadcrumbs custom_breadcrumbs Other 7.x-2.0-beta11 Yes No N 2014-09-09     This module has not been ported to Drupal 8. Refer to this issue to find out its progress.
      Custom Search custom_search Search 7.x-1.20 No In Development Y 2015-12-18   2018-11-08  
      Date date Date/Time 7.x-2.10 No In Core Y 2017-04-07 version 2.11 planned to have 7.1 fixes, will need to update to this when it is released 2018-10-05 Included in D8 core (mostly).
      Dates dates Date/Time 7.x-1.0-alpha1 Yes No N 2012-10-20   2018-11-08 may be able to uninstall module and still leave preset date formats behind
      Diff diff Other (Administration, Content Display, Utility) 7.x-3.3 No Release Candidate Y 2016-12-20 Deprecating PHP4 style constructors    
      Display Suite ds Display Suite 7.x-2.16 Yes No Y 2018-07-03 error (https://www.drupal.org/project/ds/issues/2986390) 2018-10-05 used?
      Editable Views editableviews Views 7.x-1.0-beta10 Yes No N 2015-07-28      
      Email email Fields 7.x-1.3 No Yes Y 2014-04-10   2018-10-05 included in D8 core.
      Entity API entity Other 7.x-1.9 No In Core Y 2/142018     This module has been included with Drupal 8 core. Refer to this issue for more information.
      Entity Reference entityreference Fields 7.x-1.5 No In Core Y 2017-08-16 Warning only (https://www.drupal.org/project/entityreference/issues/3006199) 2018-10-05  
      Entity Rules entity_rules Other 7.x-1.0-alpha4 Yes No N 2013-12-09      
      Entity to Text entity2text Other (Content Display) 7.x-1.x-dev Yes No N 2015-09-01      
      Entity tokens entity_token_display   7.x-1.x-dev Yes No N 2015-09-01   2018-11-08  
      Entityform entityform Entityform 7.x-2.0-rc4 No No (Use Webform) Y 2017-05-08 7.1 patch (https://www.drupal.org/project/entityform/issues/2834738) 2018-10-05  
      Exclude node title exclude_node_title Other 7.x-1.9 No No Y 2015-06-26 No major or critical issues    
      External Links extlink User interface 7.x-1.20 No Yes Y 2018-04-20      
      Fast Permissions Administration fpa Administration 7.x-2.6 No No Y 2014-08-22   2018-10-05 duplicate of filter_perms (but less-intuitive UI)
      Features features Features 7.x-2.10 No Yes (But you won't need it) Y 2016-04-18 7.2 issues (https://www.drupal.org/project/features/issues/2931464
      https://www.drupal.org/project/features/issues/2957125
      https://www.drupal.org/project/features/issues/2642642)
      2018-10-05  
      Features Extra features_extra Features Extra 7.x-1.0 No Yes (But you won't need it) Y 2016-04-18   2018-11-08  
      Feed Import feed_import Feeds 7.x-3.4 No No Y 2015-01-07   2018-10-05 Should just be for initial content import, not ongoing use. Not nearly as well supported or used as Feeds module.
      Feeds feeds Feeds 7.x-2.0-beta4 Yes In Development N 2017-09-24   2018-10-05 used? Make sure in ongoing use, not just for initial content import.
      Feeds Tamper feeds_tamper Feeds 7.x-1.2 No In Development Y 2017-12-10 7-related issues (https://www.drupal.org/project/feeds_tamper/issues/2875221 - not really broken?
      https://www.drupal.org/project/feeds_tamper/issues/2567431 - has patch
      https://www.drupal.org/project/feeds_tamper/issues/2863574 - has patch)
      2018-10-05 check if this is actually used or just left behind from testing/dev
      Feeds XPath Parser feeds_xpathparser Feeds 7.x-1.1 Switch to Feeds Extensible Parser (feeds_ex) No (Use Feeds Extensible Parser) Y 2015-07-03 recommends using Feeds Extensible Parsers instead. 2018-10-05 used?
      Field collection field_collection Fields 7.x-1.0-beta12 Yes (Switch to Paragraphs) No N 2016-11-17 7.2 issues (https://www.drupal.org/project/field_collection/issues/2979033
      https://www.drupal.org/project/field_collection/issues/2992575)
      2018-10-05 poorly-supported/-integrated module. Deprecated in D8 for paragraphs
      Field Collection Table field_collection_table Other (Content, Content Display, Fields) 7.x-1.0-beta5 Yes (Switch to Paragraphs) No N 2017-02-21 No major or critical issues   This module has not been ported to Drupal 8. Refer to this issue to find out its progress.
      Field formatter settings API field_formatter_settings Other 7.x-1.1 No In Core Y 2013-09-09 no major or critical issues    
      Field Group field_group Fields 7.x-1.6 No In Development Y 2017-11-03 PHP7 patched in current version (https://www.drupal.org/node/2649648) 2018-10-05  
      Field Permissions field_permissions Fields 7.x-1.0 No In Release Candidate Y 2016-10-16   2018-10-05  
      Field Validation field_validation Fields 7.x-2.6 No In Development Y 2015-06-20   2018-10-05  
      File Entity file_entity Media 7.x-2.22 No In Core (as Media) y 2018-06-14      
      File Field Sources filefield_sources Fields 7.x-1.11 No In Development Y 2018-02-07   2018-10-05  
      Filter permissions filter_perms Administration 7.x-1.0 No No Y 2012-05-16   2018-10-05 duplicate of fpa (but easier UI than fpa); not sure if it uninstalls cleanly
      Flex Slider flexslider Flex Slider 7.x-2.0-rc2 Yes No N 2017-02-12   2018-10-03 No major issues. This site is running it on PHP 7.2, https://www.centralbaptistchurchah.org/
      Flex Slider Views Slideshow flexslider_views_slideshow Flex Slider 7.x-2.x-dev Yes No N   Flexslider Not Rendering the Thumbnails Field flexslider broken on plugin cache clear   This is the FlexSlider Views Slideshow module which used to be included in FlexSlider by default.
      Flickr flickr Flickr 7.x-1.8 No In Development Y 2015-08-06 No major or critical issues 2018-10-03  
      Form block formblock Other (Content) 7.x-1.0-alpha1 Yes No N 2014-07-18 No major or critical issues    
      Github Flavored Markdown gfm Input filters   Yes No N   No major or critical issues 2018-10-03  
      Global Redirect globalredirect Path management 7.x-1.6 No No (Use Redirect) Y 2018-02-15     Update:
      For Drupal 8 please use the redirect module. This project is deprecated for D8
      Google Analytics google_analytics Statistics 7.x-2.5 No Yes Y 2018-07-13      
      Google CSE google_cse Other 7.x-2.5 No No Y 2017-04-26 No major or critical issues    
      GT Content Types gt_content_types GT 7.x-2.9                  
      GT Tools gt_tools GT 7.x-2.9              
      GT Super block gt_ct_super_block GT 7.x-2.9              
      GT Theme gt GT 7.x-2.9              
      Hide the Toolbar Hide the Toolbar toolbar_admin_menu 7.x-1.0 No In Development Y     2018-11-08  
      Htaccess htaccess Hide the Toolbar 7.x-2.6 No In Development Y     2018-11-08  
      HTML Mail htmlmail Mail 7.x-2.70 No In Development Y 2018-02-23   2018-10-04  
      Image Link Formatter image_link_formatter Fields 7.x-1.1 No No Y 2016-05-26   2018-10-05  
      Image resize filter image_resize_filter Input filters 7.x-1.16 No In Development Y 2015-08-01 PHP Fatal error: Call to a member function getDirectoryPath() on a non-object image_resize_filter/image_resize_filter.module on line 334
      all other issues are more than a year old.
      2018-10-03  
      Image URL Formatter image_url_formatter Other (Content, Fields) 7.x-1.4 No No Y 2013-09-10 No major or critical issues    
      IMCE imce Media 7.x-1.11 No Yes Y 2017-05-27 No major or critical issues 2018-10-05 IMCE may have problem working with Google Analytics and Secure pages modules. Just make sure to add *imce* path to the exceptions list of these modules. If IMCE has issues with your custom theme, try enabling admin theme under Common Settings of IMCE admin page or use ThemeKey Module
      IMCE Mkdir imce_mkdir Media 7.x-1.0 No No Y 2011-10-20 No major or critical issues 2018-10-05 This module has not been ported to Drupal 8. Refer to this issue to find out its progress.
      Inline Entity Form inline_entity_form Fields 7.x-1.8 No In Release Candidate Y 2016-04-16   2018-10-05  
      Insert insert Other ( Content Display, Fields, Filters/Editors, JavaScript Utilities, Media) 7.x-1.4 No Yes Y 2017-09-17 No unresolved issues
      Warning: A non-numeric value encountered in aggregateVariables(), https://www.drupal.org/project/insert/issues/2861946
         
      Job Scheduler job_scheduler Other 7.x-2.0 Yes In Development N 2018-02-13 scheduler does not sometimes run 2018-10-03 Bug -
      7.x-2.0-alpha3
      jQuery Update jquery_update User interface 7.x-2.7 No In Core Y 2015-10-20     7.x-3.0-alpha5 - updated on
      29 March 20177.x-3.0-alpha5 - updated on
      29 March 2017
      Libraries libraries Other 7.x-2.5 No In Development Y 2018-09-10 Version Callback functions that pass parameters by reference not permitted in PHP 7 [7.x-2.x-dev]
        - https://www.drupal.org/project/libraries/issues/2779591

      Upgrade to 7.x-2.3 breaks WSIWYG editor - https://www.drupal.org/project/libraries/issues/2725769

      Finds no library after update [7.x-2.4] -
      https://www.drupal.org/project/libraries/issues/2999116

      Warning after updating [7.x-2.4] - https://www.drupal.org/project/libraries/issues/2998821
        Upgrade to latest version in PHP5, as the upgrade process will break in PHP7, but the already-upgraded module should work okay.
      Lightweight Directory Access Protocol - LDAP ldap Lightweight Directory Access Protocol 7.x-2.4 No In Development   2013-08-13 No major or critical issues 2018-10-04  
      Link link Fields 7.x-1.5 No In Core Y 2018-05-13   2018-10-05 Included in D8 core.
      Linkit linkit Other 7.x-3.5 No Yes Y 2016-01-10   2018-10-04  
      Mailchimp mailchimp Mail 7.x-4.x         https://www.drupal.org/project/mailchimp/issues/2998627 if private fields are being used.    
      Mail System mailsystem Mail 7.x-2.35 No Yes Y 2016-07-12 https://www.drupal.org/project/mailsystem/issues/2770619 2018-10-04  
      Markdown filter markdown Input filters 7.x-1.5 No Yes Y 2016-05-31 No major or critical issues   currently being refactored. #2952435: Merge in the CommonMark project
      Masquerade masquerade Other 7.x-1.0-rc7 Yes In Development N 2014-03-09 Your not allowed to masquerade as the selected user - https://www.drupal.org/project/masquerade/issues/2269927   7.x-1.x-dev
      - updated on 11/2/167.x-1.x-de
      Media media Media 7.x-2.21 No In Core Y 2018-08-17 No major or critical issues 2018-10-05 This module has been included with Drupal 8 core. Refer to this issue for more information. Known Issues
      Accessibility: Media 1.x does not have an out-of-the-box solution for handling HTML attributes, including alt.
      Audio/Video: Media 1.x does not include any way to 'display' audio and video media files out of the box. The use of MediaElement or MediaFront is recommended.
      Non images and WYSIWYG: There are several known issues in both Media 1.x and 2.x when embedding non-image media via the WYSWIYG. The use of Entity Embed is recommended.
      Media Field mediafield Media   Yes No N     2018-10-05 obsolete and unsupported.
      Media: oEmbed media_oembed Media 7.x-2.7 No No Y 2016-06-28   2018-10-05  
      Menu attributes menu_attributes Other 7.x-1.0 No No Y 2016-02-15      
      Menu Block menu_block Other 7.x-2.7 No Yes Y 2015-06-30 Fatal Error: Call to undefined function menu_block_configure_form_follow_validate()
      https://www.drupal.org/project/menu_block/issues/2574457

      Menu block templates doesn't applies - https://www.drupal.org/project/menu_block/issues/2950339
        7.x-2.x-dev - updated on 7/8/17
      Menu CSS Names menu_css_names Other 7.x-1.0-beta2 Yes No N 2016-01-07      
      Mercury Reader hg_reader GT 7.x-2.7              
      Module filter module_filter Administration 7.x-2.1 No Yes Y 2017-06-09   2018-10-05  
      Name Field name Fields 7.x-1.10 No In Development (also see Webform) Y 2015-11-25   2018-10-05 used? Do we need this much name detail?
      Node clone node_clone (clone) Other (Content Utility) 7.x-1.0 No No Y 2015-11-19 No major or critical issues   /This module is currently being ported to Drupal 8, but is not usable yet. Help us by following this issue.
      Node Convert node_convert Other 7.x-1.2 No No Y 2014-06-12      
      Nodeaccess nodeaccess Access control 7.x-1.4 No In Development Y 2014-10-06   2018-10-05 Don't know that we use this much.
      Nodeblock nodeblock Other 7.x-1.7 No Functionality In Core (also see EntityBlock) Y 2015-12-02 Required by GT Content types and GT Super Block 2018-10-05 Other node block modules:
      http://groups.drupal.org/node/93499

      7.x-1.x-dev - updated on 4/14/17
      Options element options_element User interface 7.x-1.12 No No Y 2014-04-17 PHP 7.1: A non well formed numeric value encountered in _form_options_from_text() line 404 2018-10-08  
      Organic groups og Organic groups 7.x-2.10 No In Development Y 2018-06-28   2018-10-05  
      Override node options override_node_options Permissions 7.x-1.14 No Yes Y 2018-03-31      
      Pathauto pathauto Other 7.x-1.3 No Yes Y 2015-10-07 PHP Fatal error: Class 'MigrateDestinationHandler' not found -
      [7.x-1.x-dev] - https://www.drupal.org/project/pathauto/issues/2609618PHP Fatal error: Class 'MigrateDestinationHandler' not found -
      [7.x-1.x-dev] - https://www.drupal.org/project/pathauto/issues/2609618
        7.x-1.x-dev - updated on 8/16/17
      Pathologic pathologic Input filters 7.x-3.1 No In Development Y 2015-11-23 mulitlingual links with Pathologic https://www.drupal.org/project/pathologic/issues/348421. Pathologic rewrites + to %2b in url Detection of HTTPS status for protocol-relative URLs doesn't work 2018-10-03  
      Phone phone Fields 7.x-1.0-beta1 Yes In Core N 2014-01-14   2018-10-05 duplicate field to telephone; will not migrate as well to D8
      Plupload integration module plupload Media 7.x-1.7 No No Y 2014-11-07   2018-10-05 Drupal 7 version provides integration between Drupal and Plupload library via form element. You only need the 7.x version if another module tells you to download it. This module has a pre-release version for Drupal 8. To find out more, follow this issue or download below.
      reCAPTCHA recaptcha Spam control 7.x-2.2 No Yes Y 2016-07-23      
      Redirect redirect Other 7.x-1.0-rc3 No Yes Y 2015-07-08 PHP Fatal error: Class 'RedirectController' -
      https://www.drupal.org/project/redirect/issues/2849531PHP Fatal error: Class 'RedirectController' -
      https://www.drupal.org/project/redirect/issues/2849531
        7.x-2.x-dev - updated on 10/5/18
      Redirect UUID uuid_redirect Other 7.x-1.0-alpha1 Yes No N 2012-04-26     7.x-1.x-dev - updated on 5/10/12
      References references Fields 7.x-2.2 No In Core Y 2017-04-18 7 patch available (https://www.drupal.org/project/references/issues/2923099) 2018-10-05 used? Poorly-integrated (entityreference is more future-proof)
      Revisioning revisioning Other 7.x-1.9 No In Core Y 2014-06-26     7.x-1.x-dev - updated on 5/3/18

      This module has been included with Drupal 8 core7.x-1.x-dev - updated on 5/3/18

      This module has been included with Drupal 8 core
      Rules rules Rules 7.x-2.11 No In Development Y 2018-05-18 Remove usage of deprecrated each() function for PHP 7.2+ future proofing   This issue is closed (duplicate) - [7.x-2.x-dev]
      Search Restrict search_restrict Other 7.x-1.0 No No Y 2011-07-09     Alternative:
      search_config

      7.x-1.x-dev - updated on 7/10/11
      Select (or other) select_or_other Fields 7.x-2.24 No In Development Y 2018-07-25   2018-10-05 active 3.x alpha version. Likely used with webform module
      Simplified formats simplified_formats Other 7.x-1.0-beta1 Yes No N 2013-10-08      
      Social Share social_share Social media 7.x-2.5 No In Development Y 2017-01-24      
      Special menu items special_menu_items Other 7.x-2.0 No In Core Y 2012-09-04     7.x-2.x-dev - updated on 5/12/15
      Strongarm strongarm Other 7.x-2.0 No In Core Y 2012-06-13     7.x-2.x-dev - updated on 6/7/11
      Superfish superfish User interface 7.x-2.0 No Yes Y 2015-11-25      
      Table of Contents tableofcontents Input filters 7.x-2.x-dev Yes No N 2018-03-19 Critical Issue: PHP Fatal error: Unsupported operand types in ${drupalroot}/includes/theme.inc on line 1074 ,https://www.drupal.org/project/tableofcontents/issues/1955448 2018-10-03  
      Telephone telephone Fields 7.x-1.0-alpha1 Yes In Core N 2014-01-14   2018-10-05 duplicate field to phone; backport of D8 core module
      Token token Other 7.x-1.7 No Yes Y 2017-01-25 Tokens Missing (No tokens available - admin/help/token) - upgrade of PHP 5.3.3 to PHP 7.0.10
      https://www.drupal.org/project/token/issues/2822160

      Error : Cannot use string offset as an array in _token_token_tree_format_row() [7.x-1.x-dev] - https://www.drupal.org/project/token/issues/2825841
         
      Token tweaks token_tweaks Other 7.x-1.x-dev Yes No N 2014-01-27      
      Transliteration transliteration Other 7.x-3.2 No No, but Planned to Go Into Core Y 2014-03-17 Possible regression: WSOD and PHP Fatal Error when transliterating files [2015] -
      https://www.drupal.org/project/transliteration/issues/161516
         
      Twitter Block twitter_block Other 7.x-2.3 No In Development Y 2015-09-15      
      Universally Unique ID uuid UUID 7.x-1.2 No In Core Y 2018-07-19 PHP7 compatibility   This issue has been Closed(works as designed) - [7.x-1.x-dev]

      This module doesn't need to be ported to Drupal 8. All core entities in D8 support UUIDs. The UUID URL is currently under development for a future release of Drupal 8 core.
      Video Embed Field video_embed_field Media 7.x-2.0-beta11 Yes Yes N 2015-09-07   2018-10-05  
      View Unpublished view_unpublished Permissions 7.x-1.2 No In Development Y 2014-10-30      
      Views views Views 7.x-3.20 No In Core Y 2018-04-14 Parameter 3 to views_ui_build_form_state() expected to be a reference, value given in views_ui_ajax_form() [7.x-3.x-dev] - https://www.drupal.org/project/views/issues/2810431

      PHP 7 incompatibility in views_plugin_style_mapping [7.x-3.x-dev] - https://www.drupal.org/project/views/issues/2850719
        Reviewed & tested by the community
      Views Accordian views accordian Views Accordian 7.x-1.1 No In Core Y 2018-11-05     Reviewed & tested by the community
      Views Bulk Operations views_bulk_operations Views 7.x-3.5 No Yes Y 2018-05-09 PHP 7.1 upgrade fail - https://www.drupal.org/project/views_bulk_operations/issues/2953645

      PHP 7.2+ future proofing, remove usage of deprecated ""create_function()"" - https://www.drupal.org/project/views_bulk_operations/issues/2946220
         
      Views Data Export views_data_export Views 7.x-3.2 No In Development Y 2017-04-05      
      Views Field View views_field_view Views 7.x-1.2 No No Y 2015-09-18 PHP 7.1 Warning non-numeric value   7.x-1.x-dev
      Views Responsive Grid views_responsive_grid Views 7.x-1.3 No In Core Y 2013-04-05     7.x-1.x-dev - updated on 2/13/17
      Views Slideshow views_slideshow Views 7.x-3.9 No Yes Y 2017-06-08 PHP 7.1 causes error [8.x-4.x-dev] - https://www.drupal.org/project/views_slideshow/issues/2834156

      Fatal error when using top / bottom widgets with PHP 7.1 [7.x-3.x-dev] - https://www.drupal.org/project/views_slideshow/issues/2835052
        These issues have been closed(fixed).
      Views Slideshow: Cycle views_slideshow_cycle; views_slideshow_cycle2 Views   Yes In Development N       Drupal 8 only
      Void Menu void_menu Menu (Path Management) 7.x-1.9 No No Y 2014-05-30   2018-10-05 no major or critical issues, https://www.drupal.org/project/issues/void_menu?categories=All
      Webform webform Webform 7.x-4.18 No Yes (Full rewrite - read docs for details) Y 2018-10-01 Fatal error: Cannot use lexical variable $value as a parameter name in components/select.inc on line 765   [7.x-4.x-dev]
      This issue has been closed(fixed).[7.x-4.x-dev]
      This issue has been closed(fixed).[7.x-4.x-dev]
      This issue has been closed(fixed).[7.x-4.x-dev]
      This issue has been closed(fixed).
      Webform Rules webform_rules Webform 7.x-1.6 No No   2013-03-16      
      Webform Term Options webform_term_opts Webform 7.x-4.0 No No Y 2014-05-02     Using this module might not be your best option. Consider using Entityform with a Term Reference field instead.
      Webform Validation webform_validation Webform 7.x-1.15 No No Y 2018-10-01      
      WYSIWYG Filter wysiwyg_filter Input filters 7.x-1.6-rc9 Yes In Core N 2017-10-24 No major or critical issues 2018-10-04 minimally maintained, maintenance fixes only (This module has been included with Drupal 8 core)"

      Troubleshooting: Questions and Answers

      Troubleshooting: Questions and Answers klp Thu, 04/21/2016 - 17:21
      Drupal Version

      This section is for general developer and administrator questions that commonly come up and their answers - particularly questions that don't really fit under any of the other existing topics.  Please list one question per sub-page and follow the format of the first question about Drupal Sites on OIT Web Hosting Unable to Send Emails.

      If you need some generic advice about how to deal with a Drupal site that has stopped working (e.g. the dreaded "white screen of death"), Kevin Pittman has written a fairly comprehensive guide called "So, You Blew Up Your Drupal 8 Site - Now What?".  It's written for Drupal 8, but all of the concepts apply to earlier versions – the specific details will just be a little different.


      Questions and Answers

      A Drupal Site on OIT Web Hosting is Unable to Send Email

      A Drupal Site on OIT Web Hosting is Unable to Send Email esembrat3 Wed, 04/22/2015 - 15:11
      Drupal Version

      Issue

      Email from a Drupal website on OIT Web Hosting is being delivered to non-Georgia Tech email addresses, but is failing on Georgia Tech email addresses (@gatech.edu).

      Solution

      To fix this issue, ensure that the From: email address in Drupal (set in Configuration -> Site Information) is a valid Georgia Tech email address.

      More details, per OIT Web Hosting:

      Since this problem has come up more frequently, I’ll clarify what the issue is:

      outbound.gatech.edu requires that if you are sending to *@*.gatech.edu address that the OIT MX servers handle (which is most of them), the “From:” address has to be a valid Georgia Tech address. Along with this, if the “From:” address isn’t valid, there is no way for outbound.gatech.edu to send a bounce message back.

      This is a requirement of the OIT MX servers and isn’t related to anything that Web Hosting restricts.  In fact, on the Web Hosting servers, the message shows as sent, but that just means it was sent on to outbound.gatech.edu.

      After Upgrading to Drupal 7.50 (or Later), I Get Missing Module Warnings

      After Upgrading to Drupal 7.50 (or Later), I Get Missing Module Warnings afrank30 Fri, 07/15/2016 - 14:31
      Drupal Version

      Issue

      After upgrading to Drupal 7.50 (or later), you start seeing red error messages that read "The following module is missing from the file system...".

      Drupal 7.50 began scanning more carefully for module and theme files, including files for modules and themes that had been disabled, but not uninstalled.  Unfortunately, many Drupal site administrators have disabled and deleted modules in the past without running the uninstall process, and once the module has been deleted, you no longer have a way to uninstall it.

      Solution

      • If the module listed is "mymodule", then the issue is most likely with the GT Tools module (specifically, the GT Content Types sub-module of GT Tools).  Upgrade your site to the latest version of GT Tools, and that should fix the problem.

      • For other modules and themes, the easiest solution is to download a copy of the module or theme in question, install it back into your website's filesystem, then go to Modules -> Uninstall on the administration menu bar and uninstall that module.  You can then delete the module or theme from your filesystem.

      • If you cannot obtain the a copy of the module again (e.g. it was a locally written custom module, and all copies have been deleted), you can suppress the error messages by updating your database (WARNING: Back up your database before attempting this proceedure!)

        Via whichever MySQL tool you prefer to use (e.g. phpMyAdmin), run the following SQL commands against your Drupal database (replace 'XXXX' with the relative path from the Drupal site root directory to the module or theme in question -- e.g., "sites/all/modules/ctools"):

        DELETE FROM `system` WHERE filename like 'XXXXXX';
      • If the missing object is a Drupal profile (e.g. "gt_profile" or "gt_install"), then fixing the problem is a little trickier.  Please see the article on fixing a missing profile in Drupal 7.

      After Upgrading to the GT 2.9 Theme, Formatting Breaks on Slideshow Carousel, Super Blocks or other Content Types

      After Upgrading to the GT 2.9 Theme, Formatting Breaks on Slideshow Carousel, Super Blocks or other Content Types
      Category
      afrank30 Mon, 04/02/2018 - 09:40
      Drupal Version

      Issue

      After updating to the 2.9 version of the GT Theme, the formatting is broken for custom content types (such as Super Blocks and Slideshow Carousels), usually those created via the Features module. Often the types show CSS classes as text instead of as visual styling.

      Example of broken Super Blocks

      super blocks showing css classes as text instead of styling

      Solution

      Find the theme_registry_alter function in your feature's .module file and make the following replacement

      Replace:

      $theme_registry['template-file']['path'] = drupal_get_path('module', 'gt_ct_carousel_slider') . "/templates/";

      With:

      // Defined path to the current module.
        $module_path = drupal_get_path('module', 'gt_ct_carousel_slider');
        // Find all .tpl.php files in this module's folder recursively.
        $template_file_objects = drupal_find_theme_templates($theme_registry, '.tpl.php', $module_path);
        // Iterate through all found template file objects.
        foreach ($template_file_objects as $key => $template_file_object) {
          // If the template has not already been overridden by a theme.
          if (!isset($theme_registry[$key]['theme path']) || !preg_match('#/themes/#', $theme_registry[$key]['theme path'])) {
            // Alter the theme path and template elements.
            $theme_registry[$key]['theme path'] = $module_path;
            $theme_registry[$key] = array_merge($theme_registry[$key], $template_file_object);
            $theme_registry[$key]['type'] = 'module';
          }
        }

      For more information, see Using template (.tpl.php) files in your own module on the Drupal.org website.

      Drupal 8.8 Upgrade Generates Temporary Directory Warning in Status Report

      Drupal 8.8 Upgrade Generates Temporary Directory Warning in Status Report kp37 Tue, 03/17/2020 - 12:24
      Drupal Version

      Issue

      You've upgraded your Drupal 8 site to 8.8+ and now get the following warning in your site's Status Report.

      Deprecated configuration
      You are using deprecated configuration for the temporary files path. Your temporary directory configuration
      matches the OS default and can be safely removed.

      Cause

      Drupal 8.8 changed some of the configuration handling for the temporary file path, moving storage of that path into a config system key.  However, that key is not directly editable, and under certain odd circumstances can get populated with the default system temporary directory path.

      Solution

      Warning: the following is minimally tested, and while it seems to work, be cautious and consider testing on a copy of your site first.  At a minimum, back up your database before trying this to be safe.

      Putting the following into a module file temporarily and pulling up any page in the site should clear the value of the config key:

      \Drupal::service('config.factory') -> getEditable('system.file') -> clear('path.temporary') -> save();

      If the warning message then disappears from your Status Report, you can remove the above line from wherever you put it.

      Drupal Throws SimpleXMLElement Errors After Upgrading to 7.61 (or Later)

      Drupal Throws SimpleXMLElement Errors After Upgrading to 7.61 (or Later) ms123 Mon, 01/07/2019 - 14:15
      Drupal Version

      Per Kevin Pittman's insight posted on the GTDUG Team:

      With Drupal 7.61, be aware that you're now likely to see a bunch of "SimpleXMLElement" errors on the Modules Update screen. This is caused whenever a module's project status data can't be retrieved. 

      Causes

      There are two cases that will have to be addressed:

      1. If you (or someone else) built a custom module and included a "project=" line in the .info file without also including a proper "project status url=" line as well (or, you have that line, but it doesn't point to a valid XML file)

      2. You are running any GT modules from Institute Communications (GT Tools, etc). Most instances of these are looking for the "project status url" at http://drupal.gatech.edu/, which we been redirecting to the new location of the repo, http://repo.drupal.gatech.edu/ ever since we upgraded the GT Drupal Users group site a couple years ago. Unfortunately, the updated code in Drupal 7.61 doesn't handle the redirect correctly any more.

      Fixes

      There is a quick, but behind-the-scenes fix for both problems:

      1. Edge case fix: For custom modules, remove the line "project=" and "project status url=" entries from the module's .info file unless you actually have a valid Drupal style repo set up with a valid project status XML file.

      2. Common fix: for all of the GT modules you are running (including Mercury Reader [hg_reader]), edit the .info file and change the "project status url" server from drupal.gatech.edu to repo.drupal.gatech.edu and save. Don't change anything else on that line -- just the server.

      The upside is that the errors shouldn't interfere with running updates of regular third-party modules, but should any updates be pushed out for GT modules, you won't get them on your site until you manually patch your existing module as described above.

      How Do I Change a Site's Host Name / Domain Name?

      How Do I Change a Site's Host Name / Domain Name? klp Tue, 05/17/2016 - 15:28
      Drupal Version

      Issue

      Below is a quick summary of what you need to do if you are changing your Drupal site's host name / domain name without moving it to a new web hosting location.

      If you are moving the site to another location, then you'll also need to see the Site Migration section for additional guides.

      Solution

      1. First, go ahead and request that your new host name be created in DNS and pointed to your existing web server.  You'll need to know the host name and/or IP address of your existing server to provide to your DNS administrator.  If you don't know either, then provide the current host name for your website, and your DNS administrator should be able to determine the web server hostname and IP address from it.

      2. Configure your web server to recognize the new host name.  If you are using an automated web hosting solution like OIT's Web Hosting, then go into your control panel and add the new host name as a domain alias for your hosting account.

      3. Check your site for links hard coded to your old host name:
        • The quickest way of doing this (though it does require some advanced knowledge) is to dump your database out to an SQL file and do a search through that file for instances of your old host name and then identify the pages that need to be updated.  
        • Alternatively, you could go through every page, opening each one up for editing, and check the page source for every inline link and every inline image.  

        If you don't fix these links, then users will be silently switched over to the old hostname when they follow those hard coded links, and when you eventually delete the old hostname from DNS, those links will simply break.

      4. If you want to force everyone to view your site through the new host name (which is important for Search Engine Optimization), you can add something like the following to your .htaccess file, where oldsitename.gatech.edu and newsitename.gatech.edu are replaced with the appropriate values:

          RewriteCond %{HTTP_HOST} ^oldsitename.gatech.edu [NC]
          RewriteRule ^ http%{ENV:protossl}://newsitename.gatech.edu%{REQUEST_URI} [L,R=301]
        

      On a Site's Status Report, Drupal Complains About a Missing Profile

      On a Site's Status Report, Drupal Complains About a Missing Profile kp37 Tue, 07/11/2017 - 14:04
      Drupal Version

      Issue

      You are seeing a red error message in Drupal stating that a Drupal profile is missing from the file system.  Common examples are "gt_profile" and "gt_install", but the issue could happen with any profile.

      Much like with the more common missing theme or module file issue, it is possible that a previous Drupal site administrator deleted the directory for the Drupal profile used to install your Drupal site from the filesystem.  S/he may have thought that the profile was not needed after site installation, but Drupal does actually expect it to be there, and will throw error messages on some of the administration pages if those files are missing.  More often than not, the issue is just that someone simply forget to copy a custom profile directory over when applying a Drupal core update.

      Compounding the issue is that Drupal behaves a bit poorly when it can't find the assigned custom profile directory, and partially disables the profile in the database.  This prevents you from correcting the problem by just replacing the missing files (which is the simple solution for missing modules and themes).

      Solution

      If you have a copy of the missing profile, copy the files back into the right place in the filesystem, then try running the following against your Drupal database (be sure to make a database backup first) from your preferred MySQL administration tool (e.g. phpMyAdmin), replacing 'XXXX' with the path under the 'profiles' directory to your custom profile:

      UPDATE `system` SET status=1 WHERE filename like 'profiles/XXXX';

      If you do not have a copy of the missing profile, you can reset the site to the default profile:

      UPDATE `system` SET status=1 WHERE filename like 'profiles/standard/standard.profile';
      REPLACE `variable` SET `value`='s:8:"standard";' WHERE `name`='install_profile';

      If you still see error messages about your old custom profile, try running the following SQL command, replacing 'XXXX' with the path under the 'profiles' directory to your custom profile:

      DELETE FROM `system` WHERE filename like 'profiles/XXXX';

      Drupal 8 Guides, Tips and Tricks

      Drupal 8 Guides, Tips and Tricks klp Mon, 03/14/2016 - 15:46
      Drupal Version

      Drupal 8 Pages of Note

      Where applicable, Drupal 8 knowledge is being added throughout the rest of the Developers Handbook.  The following highlights some useful pages found elsewhere in the handbook.


      Drupal 8 Guides


      Drupal 8 Tips and Tricks

      This section is for tips and tricks specific to Drupal 8, which is quite different from it's predecessors, Drupal 7 and 6.  Topics posted here will eventually be migrated into the main sections of this handbook after some mainstream adoption of Drupal 8 on campus has occurred.

      Drupal 7 began forcing mySQL to act like a traditional SQL server so that all SQL code used in Drupal will be highly compatible with other database systems like PostgreSQL or SQLite.  This means that mySQL statements that syntactically work in other contexts may produce errors under Drupal 7 or 8.  Drupal 8 adds the 'ONLY_FULL_GROUP_BY' restriction, which can potentially cause custom mySQL code that worked in Drupal 7 to fail with errors in Drupal 8.

      Here's the exact settings being used in Drupal 8: 

      • SET sql_mode = 'ANSI, STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE, ERROR_FOR_DIVISION_BY_ZERO, NO_AUTO_CREATE_USER, ONLY_FULL_GROUP_BY'

      The mySQL Reference Guide has full details on these SQL modes and their effects.  (See especially the section on STRICT mode and ONLY_FULL_GROUP_BY mode.)


      Here's how to whitelist HTML tags in your module output that are normally stripped out by the XSS filter:

          $tagList = array('input');
        
          return array(
            '#markup' => $buffer,
            '#allowed_tags' => array_merge(\Drupal\Component\Utility\Xss::getAdminTagList(), $tagList),
          );

      And here's how to allow data URLs in your module output for displaying images with data that you've already pulled in from a data source (code updated 2017-12-11 to a better format that avoids whitescreening in certain use cases):

        $allowedProtocols = \Drupal\Component\Utility\URLHelper::getAllowedProtocols();
        $allowedProtocols[] = 'data';
        \Drupal\Component\Utility\URLHelper::setAllowedProtocols($allowedProtocols);
      

      Here's a quick reference guide to working with the new configuration management system.  You'll need this if you want to build a module that adds its own configuration to Drupal during its installation process:

      Simple Configuration API | Drupal.org


      Add additional tips and tricks here.

      Creating an Accessible Media Library Photo Gallery

      Creating an Accessible Media Library Photo Gallery
      Category
      kp37 Tue, 08/25/2020 - 16:11
      Drupal Version

      Media Library in recent versions of Drupal 8 and Drupal 9 offers a lot of great functionality for managing and reusing images (and other media types), but out-of-the-box it has a notable accessibility issue.

      If you try to configure an image media type so that the user can select the thumbnail image and get the full-size version, the option for this (setting "Link image to" to "File") gives you only a link around the image, with no way to include the media item's built-in Name field.  Worse, the link will be presented to screen readers with the image's alternate text, which may not be appropriate for link text, and training content managers on how to handle this special usage of the alternate text field would be an uphill battle.

      Correcting this problem requires both changing your media type configuration and adding a custom template:

      Media Type Configuration

      1. Edit your Media type and switch to the Manage display tab
      2. Move the Thumbnail and Name fields up above the "Disabled" separator, but leave Image enabled as well.
      3. Configure the Thumbnail settings as desired, then configure Image with the "URL to image" format pointing to the "original image".
      4. Save your changes.

      Custom Template Configuration

      First, create a template file named "media--XXXXX--default.html.twig" where "XXXXX" is the machine name of your Media Type.  Place the following inside it:

      {%
        set classes = [
          'media-library-item',
          'media-library-item--grid',
        ]
      %}
      
      <div{{ attributes.addClass(classes) }}>
        <a href="{{ content.field_media_image.0['#markup'] }}">
          {{ content.thumbnail }}
          <span class='visually-hidden'>Full Size Version of Image "</span> {{ content.name }} <span class='visually-hidden'>"</span>
        </a>
      </div>

      If you put your template into a sub-theme, then just flush your caches and it should take effect.  If you put your template into a module, then add the following to your .module file:

      function YYYYY_theme($existing, $type, $theme, $path) {
        return [
          'media__XXXXX__default' => [
            'base hook' => 'media',
          ],
        ];
      }

      Replace "XXXXX" with the machine name of your media type, and replace "YYYYY" with the machine name of your module.  Flush your caches, and the template should take effect.

      Drupal 8 Layout Builder

      Drupal 8 Layout Builder
      Category
      kp37 Tue, 01/07/2020 - 18:31
      Drupal Version

      Useful modules

      List of potentially useful Layout Builder Extensions within the Layout Builder Ecosystem:

      • Layout Builder Restrictions - 8.x-2.4 as of 12/11/2019
        Lets you restrict which block types appear in Layout Builder's Add Block panel - very useful

      • Layout Builder Modal - 8.x-1.0-alpha2 as of 7/31/2019
        This module lets you add and configure existing blocks in a modal in the Layout Builder UI.

      • Layout Builder Styles - 8.x-1.0-beta1 as of 7/19/2019
        This module allow site builders to select from a list of styles to apply to layout builder blocks and layout builder sections.

      • Layout Builder Kit - 8.x-1.0-beta1 as of 10/21/2019
        An assortment of pre-built block types for use with Layout Builder

      • Layout builder library - 8.x-1.0-beta1 as of 6/17/2019
        Provides a layout library allowing content editors to pick from a list of pre-defined layouts.

      Please see the Drupal 8 documentation for a complete list of contributed modules compatible with Layout Builder.

      Local modules

      Locally written modules:

      Drupal Twig Stubs

      Drupal Twig Stubs
      Category
      esembrat3 Mon, 04/01/2019 - 15:10
      Drupal Version

      Twig stubs and code-samples to aid your Twig template development.

      External Resources

      • Twig data stubs (from the Ivan Allen College's web development resources website)

      Check for (non-)empty fields

      Check for (non-)empty fields
      Category
      esembrat3 Mon, 04/01/2019 - 15:11
      Drupal Version

      Satisfies a comment on drupal.org:

      Someday I would like to spend the time to make a list of the various field types and the best way to check whether they are empty so I can stop Googling this thread every few months.

      Basic field

      Expensive (render) check

      {% if content.field|render is not empty %}
           {{ content.field }}
      {% endif %}

      Note that this can be an expensive (resource-wise) check to make.

      Basic check

      {% if node.field.value %}
        {{ content.field }}
      {% endif %}

      Entity Reference fields

      {% if content.field['#items'].getValue() %}
          {{ content.field }}
      {% endif %}

      Note

      This should be compiled over on drupal.org in the near future, anyways.