Update author/sponsor information
[project/environment_indicator.git] / README.txt
1
2 -- SUMMARY --
3
4 Environment Indicator adds a coloured strip to the side of the site informing
5 the user which 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/settings/environment_indicator
27
28 You can also override settings in settings.php, allowing you to have different
29 settings for each of your environments. All configuration variables can be
30 overridden in settings.php, but the most common three are:
31
32 environment_indicator_text
33     The text that will be displayed vertically down the indicator.
34     e.g: $conf['environment_indicator_text'] = 'DEVELOPMENT SERVER';
35     
36 environment_indicator_color
37     A valid css color.
38     e.g: $conf['environment_indicator_color'] = 'dark-red';
39     
40 environment_indicator_enabled
41     A boolean value indicating whether the Environment Indicator should be
42     enabled or not. On your production environment, you should probably set
43     this to FALSE.
44     e.g: $conf['environment_indicator_enabled'] = FALSE;
45
46
47 -- CONTACT --
48
49 Author maintainers:
50 * Tom Kirkpatrick (mrfelton), www.systemseed.com
51
52
53 This project has been sponsored by:
54 * SystemSeed - Visit http://www.systemseed.com for more information.