modules/lockdown/INSTALL.txt

// $Id$

REQUIREMENTS
------------
This module requires Drupal 6.x and PHP 5.2.x (or newer).


INSTALLATION
------------

  1. Copy all the module files into a subdirectory called
     sites/all/modules/lockdown/ under your Drupal installation directory.

  2. Go to [Administer >> Site building >> Modules] and enable the Lockdown
     module. You will find it in the section labelled 'Security'. (Also
     enable any of Lockdown's submodules that you find relevant.)

  3. Go to [Administer >> User management >> Permissions] to configure the
     module's permissions.

     WARNING: Be careful to whom you give out the "administer lockdown"
     privilege! Users with this permission can circumvent Lockdown's
     security policies, so do be sure that you trust both their integrity
     and competence.

  4. Go to [Administer >> Site configuration >> Lockdown] to review and
     change the module's configuration options.

     By default, two lockdown levels have been created for you when
     installing this module: 'Online' and 'Offline'. Feel free to delete
     these if you wish to create customized lockdown levels. (Note that the
     currently-active lockdown level can't be deleted, so if you wish to
     delete the default lockdown levels, you must first create a new custom
     level and activate it.)

  5. If you have installed the Rules module (which is highly recommended),
     go to [Administer >> Rules >> Rule sets] to configure the actions
     executed when the lockdown level is changed. This module provides a
     default rule set for each lockdown level that you create.

     WARNING: Given that this module adds several powerful but potentially
     dangerous Rules actions (including one to erase the Drupal database!),
     you may wish to exercise a certain prudence in granting the "administer
     rules" privilege to users.

  6. (See README.txt for information on submitting bug reports.)


SEE ALSO
--------

  * The Rules module unlocks the full power of Lockdown by enabling you to
    configure conditionally-executed actions that can be triggered when
    lockdown levels are activated and deactivated:

    <http://drupal.org/project/rules>

  * The Messaging Framework allows Lockdown alerts to be sent out using
    XMPP, SMS or Twitter, in addition to e-mail:

    <http://drupal.org/project/messaging>

  * The OpenPGP and GnuPG modules provide PGP-compatible encryption for
    Drupal's outgoing e-mails:

    <http://drupal.org/project/openpgp>
    <http://drupal.org/project/gnupg>

  * The Bitcache distributed storage system makes it trivial to quickly and
    securely disseminate data through a private network of Drupal sites:

    <http://drupal.org/project/bitcache>

  * The Secure Pages module ensures that important pages on your Drupal site
    are always used only over an SSL-secured connection instead of plain old
    unencrypted HTTP:

    <http://drupal.org/project/securepages>

  * The Password Policy module makes sure that the users of your Drupal site
    use sufficiently strong passwords so as to lessen the threat of
    inadvertent user account compromise:

    <http://drupal.org/project/password_policy>
1	// $Id$
2
3	REQUIREMENTS
4	------------
5	This module requires Drupal 6.x and PHP 5.2.x (or newer).
6
7
8	INSTALLATION
9	------------
10
11	1. Copy all the module files into a subdirectory called
12	sites/all/modules/lockdown/ under your Drupal installation directory.
13
14	2. Go to [Administer >> Site building >> Modules] and enable the Lockdown
15	module. You will find it in the section labelled 'Security'. (Also
16	enable any of Lockdown's submodules that you find relevant.)
17
18	3. Go to [Administer >> User management >> Permissions] to configure the
19	module's permissions.
20
21	WARNING: Be careful to whom you give out the "administer lockdown"
22	privilege! Users with this permission can circumvent Lockdown's
23	security policies, so do be sure that you trust both their integrity
24	and competence.
25
26	4. Go to [Administer >> Site configuration >> Lockdown] to review and
27	change the module's configuration options.
28
29	By default, two lockdown levels have been created for you when
30	installing this module: 'Online' and 'Offline'. Feel free to delete
31	these if you wish to create customized lockdown levels. (Note that the
32	currently-active lockdown level can't be deleted, so if you wish to
33	delete the default lockdown levels, you must first create a new custom
34	level and activate it.)
35
36	5. If you have installed the Rules module (which is highly recommended),
37	go to [Administer >> Rules >> Rule sets] to configure the actions
38	executed when the lockdown level is changed. This module provides a
39	default rule set for each lockdown level that you create.
40
41	WARNING: Given that this module adds several powerful but potentially
42	dangerous Rules actions (including one to erase the Drupal database!),
43	you may wish to exercise a certain prudence in granting the "administer
44	rules" privilege to users.
45
46	6. (See README.txt for information on submitting bug reports.)
47
48
49	SEE ALSO
50	--------
51
52	* The Rules module unlocks the full power of Lockdown by enabling you to
53	configure conditionally-executed actions that can be triggered when
54	lockdown levels are activated and deactivated:
55
56	<http://drupal.org/project/rules>
57
58	* The Messaging Framework allows Lockdown alerts to be sent out using
59	XMPP, SMS or Twitter, in addition to e-mail:
60
61	<http://drupal.org/project/messaging>
62
63	* The OpenPGP and GnuPG modules provide PGP-compatible encryption for
64	Drupal's outgoing e-mails:
65
66	<http://drupal.org/project/openpgp>
67	<http://drupal.org/project/gnupg>
68
69	* The Bitcache distributed storage system makes it trivial to quickly and
70	securely disseminate data through a private network of Drupal sites:
71
72	<http://drupal.org/project/bitcache>
73
74	* The Secure Pages module ensures that important pages on your Drupal site
75	are always used only over an SSL-secured connection instead of plain old
76	unencrypted HTTP:
77
78	<http://drupal.org/project/securepages>
79
80	* The Password Policy module makes sure that the users of your Drupal site
81	use sufficiently strong passwords so as to lessen the threat of
82	inadvertent user account compromise:
83
84	<http://drupal.org/project/password_policy>