You are here

Home » API reference » Environment Indicator 8.2

README.txt in Environment Indicator 8.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 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 --

* None.


-- INSTALLATION --

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


-- CONFIGURATION --

You may configure the environment at /admin/config/development/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'] = '#F55'
  - 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

-- 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. 

  2. -- SUMMARY --

  3. 

  4. Environment Indicator adds a coloured strip to the site informing the user which

  5. environment they are in (Development, Staging Production etc).

  6. 

  7. For a full description visit the project page:

  8.   http://drupal.org/project/environment_indicator

  9.   

  10. Bug reports, feature suggestions and latest developments:

  11.   http://drupal.org/project/issues/environment_indicator

  12. 

  13. 

  14. -- REQUIREMENTS --

  15. 

  16. * None.

  17. 

  18. 

  19. -- INSTALLATION --

  20. 

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

  22. 

  23. 

  24. -- CONFIGURATION --

  25. 

  26. You may configure the environment at /admin/config/development/environment-indicator

  27. 

  28. You can also override settings in settings.php, allowing you to have different

  29. settings for each of your environments. If you choose to detect your environment using settings.php, then all configuration variables can be

  30. overridden in settings.php, but the most common three are:

  31. 

  32.   - environment_indicator_overwrite

  33.       A boolean value indicating whether the Environment Indicator should use

  34.       the settings.php variables for the indicator. On your production

  35.       environment, you should probably set this to FALSE. e.g:

  36.       $conf['environment_indicator_overwrite'] = FALSE

  37.   - environment_indicator_overwritten_name

  38.       The text that will be displayed on the indicator. e.g:

  39.       $conf['environment_indicator_overwritten_name'] = 'Staging'

  40.   - environment_indicator_overwritten_color

  41.       A valid css color. e.g:

  42.       $conf['environment_indicator_overwritten_color'] = '#F55'

  43.   - environment_indicator_overwritten_position

  44.       Where your indicator may appear. Allowed values are "top" and "bottom".

  45.       e.g:

  46.       $conf['environment_indicator_overwritten_position'] = 'top'

  47.   - environment_indicator_overwritten_fixed

  48.       A boolean value indicating whether the Environment Indicator should be

  49.       fixed at the top/bottom of the screen. e.g:

  50.       $conf['environment_indicator_overwritten_fixed'] = FALSE

  51. 

  52. -- CONTACT --

  53. 

  54. Author maintainers:

  55. * Tom Kirkpatrick (mrfelton), www.systemseed.com. Branches 6.x-1.x, 7.x-1.x

  56. * Mateu Aguiló (e0ipso). Branch 7.x-2.x

  57. 

  58. 

  59. This project has been partially sponsored by:

  60. * SystemSeed - Visit http://www.systemseed.com for more information. Branches

  61.   6.x-1.x, 7.x-1.x

  62. * Lullabot - Visit http://www.lullabot.com for more information. Branch 7.x-2.x