You are here

README.txt in Environment Indicator 7.2

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 6 README.txt
  3. 7 README.txt
-- SUMMARY --

Environment Indicator adds a coloured strip to the site informing the user which
environment they are in (Development, Staging Production etc).

For a full description visit the project page:
  http://drupal.org/project/environment_indicator
  
Bug reports, feature suggestions and latest developments:
  http://drupal.org/project/issues/environment_indicator


-- REQUIREMENTS --

* CTools


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

You may configure the environment at /admin/settings/environment-indicator

You can also override settings in settings.php, allowing you to have different
settings for each of your environments. If you choose to detect your environment
using settings.php, then all configuration variables can be overridden in
settings.php, but the most common three are:

  - environment_indicator_overwrite
      A boolean value indicating whether the Environment Indicator should use
      the settings.php variables for the indicator. On your production
      environment, you should probably set this to FALSE. e.g:
      $conf['environment_indicator_overwrite'] = FALSE
  - environment_indicator_overwritten_name
      The text that will be displayed on the indicator. e.g:
      $conf['environment_indicator_overwritten_name'] = 'Staging'
  - environment_indicator_overwritten_color
      A valid css color. e.g:
      $conf['environment_indicator_overwritten_color'] = '#ff5555'
  - environment_indicator_overwritten_position
      Where your indicator may appear. Allowed values are "top" and "bottom".
      e.g:
      $conf['environment_indicator_overwritten_position'] = 'top'
  - environment_indicator_overwritten_fixed
      A boolean value indicating whether the Environment Indicator should be
      fixed at the top/bottom of the screen. e.g:
      $conf['environment_indicator_overwritten_fixed'] = FALSE
  - environment_indicator_favicon_overlay
      A boolean value indicating whether the Environment Indicator should
      overlay the favicon with the current environment's information. e.g.:
      $conf['environment_indicator_favicon_overlay'] = TRUE

-- ACQUIA CLOUD INTEGRATION --

Copy the file in samples/environment-indicator.sh to your
hooks/[your-environment]/post-code-deploy folder and give it execution
permissions. Replace [your-environment] by your environment site alias or use
'common' to use it in all your environments (recommended). This integration
relies on the presence of the environment variable AH_SITE_ENVIRONMENT.

You can read more about Cloud Hooks in
https://github.com/acquia/cloud-hooks/blob/master/README.md

-- CONTACT --

Author maintainers:
* Tom Kirkpatrick (mrfelton), www.systemseed.com. Branches 6.x-1.x, 7.x-1.x
* Mateu Aguiló (e0ipso). Branch 7.x-2.x


This project has been partially sponsored by:
* SystemSeed - Visit http://www.systemseed.com for more information. Branches
  6.x-1.x, 7.x-1.x
* Lullabot - Visit http://www.lullabot.com for more information. Branch 7.x-2.x

File

README.txt
View source
  1. -- SUMMARY --
  2. Environment Indicator adds a coloured strip to the site informing the user which
  3. environment they are in (Development, Staging Production etc).
  4. For a full description visit the project page:
  5. http://drupal.org/project/environment_indicator
  6. Bug reports, feature suggestions and latest developments:
  7. http://drupal.org/project/issues/environment_indicator
  8. -- REQUIREMENTS --
  9. * CTools
  10. -- INSTALLATION --
  11. * Install as usual, see http://drupal.org/node/70151 for further information.
  12. -- CONFIGURATION --
  13. You may configure the environment at /admin/settings/environment-indicator
  14. You can also override settings in settings.php, allowing you to have different
  15. settings for each of your environments. If you choose to detect your environment
  16. using settings.php, then all configuration variables can be overridden in
  17. settings.php, but the most common three are:
  18. - environment_indicator_overwrite
  19. A boolean value indicating whether the Environment Indicator should use
  20. the settings.php variables for the indicator. On your production
  21. environment, you should probably set this to FALSE. e.g:
  22. $conf['environment_indicator_overwrite'] = FALSE
  23. - environment_indicator_overwritten_name
  24. The text that will be displayed on the indicator. e.g:
  25. $conf['environment_indicator_overwritten_name'] = 'Staging'
  26. - environment_indicator_overwritten_color
  27. A valid css color. e.g:
  28. $conf['environment_indicator_overwritten_color'] = '#ff5555'
  29. - environment_indicator_overwritten_position
  30. Where your indicator may appear. Allowed values are "top" and "bottom".
  31. e.g:
  32. $conf['environment_indicator_overwritten_position'] = 'top'
  33. - environment_indicator_overwritten_fixed
  34. A boolean value indicating whether the Environment Indicator should be
  35. fixed at the top/bottom of the screen. e.g:
  36. $conf['environment_indicator_overwritten_fixed'] = FALSE
  37. - environment_indicator_favicon_overlay
  38. A boolean value indicating whether the Environment Indicator should
  39. overlay the favicon with the current environment's information. e.g.:
  40. $conf['environment_indicator_favicon_overlay'] = TRUE
  41. -- ACQUIA CLOUD INTEGRATION --
  42. Copy the file in samples/environment-indicator.sh to your
  43. hooks/[your-environment]/post-code-deploy folder and give it execution
  44. permissions. Replace [your-environment] by your environment site alias or use
  45. 'common' to use it in all your environments (recommended). This integration
  46. relies on the presence of the environment variable AH_SITE_ENVIRONMENT.
  47. You can read more about Cloud Hooks in
  48. https://github.com/acquia/cloud-hooks/blob/master/README.md
  49. -- CONTACT --
  50. Author maintainers:
  51. * Tom Kirkpatrick (mrfelton), www.systemseed.com. Branches 6.x-1.x, 7.x-1.x
  52. * Mateu Aguiló (e0ipso). Branch 7.x-2.x
  53. This project has been partially sponsored by:
  54. * SystemSeed - Visit http://www.systemseed.com for more information. Branches
  55. 6.x-1.x, 7.x-1.x
  56. * Lullabot - Visit http://www.lullabot.com for more information. Branch 7.x-2.x