modules/project_issue_file_review/INSTALL.txt

// $Id: INSTALL.txt,v 1.27 2009/10/09 23:14:42 boombatower Exp $

AUTHOR
------

  Jimmy Berry ("boombatower", http://drupal.org/user/214218)

REQUIREMENTS
------------

  * CLI
    - SimpleTest
      > curl
    - PIFR slave
      > cvs
      > curl
  * Drupal 7
    - Recent libjpeg
  * PHP
    - Configuration
      > Memory limit (CLI and APACHE configurations) recommended: 256MB
      > PHP short tag support must be disabled.
    - Extensions
      > php-cli
      > php-common
      > php-curl
      > php-gd
      > php-mbstring
      > php-(database extension)
      > php-pdo
      > php-xml
  * PIFR server
    - Chart API
      > http://drupal.org/project/chart
    - Views
      > http://drupal.org/project/views
    - Tabs
      > http://drupal.org/project/tabs
    - Clean URLs
      > http://drupal.org/node/15365
  * PIFR client
    - Must run from the webroot.
      > Example: example.com should point to Drupal installation with PIFR,
        then example.com/checkout should point to the testing code checkout.

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

1.  Downloaded the latest PIFR release, install the code, and enable the PIFR
    module (admin/build/modules).

2.  Enabled PIFR Client and/or PIFR server depending on the role(s) the server
    will fulfill. Follow the additional setup instructions that apply to the
    roles selected.

PIFR SERVER:

1.  Visit admin/settings/chart and set the 'Global Background Color' to
    'FFFFFF00'.

PIFR CLIENT:

1.  Configure the client by filling in the appropriate values at
    admin/pifr/configuration.

2.  Create a symbolic link in the root of the Drupal installation to the site
    files directory and the "checkout" directory which should have been created
    when you enabled the client. The command to create the symbolic link, run
    from the Drupal root, should look like the following (where [site_folder]
    is replaced with the folder the client is running out of):

    ln -s ./sites/[site_folder]/files/checkout .

3.  Ensure that your server has the required PHP PDO exension, PHP version, and
    mysql version to support running Drupal 7. (Newer version of libjpeg, OS
    library, is required along with the PHP extension.)

4.  Set up a second database for the testing to occur in. The database
    information needs to be added to the settings.php with the key
    'pifr_checkout' file and should look something like the following.

    $db_url = array();
    $db_url['default'] = 'mysqli://user:password@localhost/drupal';
    $db_url['pifr_checkout'] = 'mysqli://user:password@localhost/drupal_checkout';

    Due to Drupal 7 requirements, the mysql user for the pifr_checkout database
    will also need permission to create temporary tables.
    (CREATE TEMPORARY TABLES)

    This second database is where the Drupal HEAD checkout will be installed
    and the actual testing will be performed. If possible, you should optimize
    the database for the rapid creation and deletion of tables.

    For SQLite the path is the only part used (see Drupal 7 for convention).
    Please ensure that the path points to a file inside the root of the
    checkout directory.

5.  You should set up a firewall to prevent malicious or buggy patches from causing
    issues on your server. Disabling the ability to send mail is also a good idea.

    The firewall rules should look something like the following:
      - Inbound:
        * HTTP - from testing.drupal.org.
      - Outbound:
        * HTTP - to testing.drupal.org and drupal.org.
        * CVS - to drupal.org HEAD CVS.

6.  Check the client configuration by visiting admin/pifr/configuration and
    correct any issues found.

7.  To test the client and determine what is wrong with it you can use the
    run tests locally tool (pifr/client/review/test). It will attempt to run
    the client through a complete test run as it will do when reviewing.

8.  Once the client is ready to be added to the master server list, it is time
    to setup cron. Cron needs to run on the client every 5-10 minutes for
    optimal efficiency.

9.  Add the test client to PIFR Server 'server list'.
1	// $Id: INSTALL.txt,v 1.27 2009/10/09 23:14:42 boombatower Exp $
2
3	AUTHOR
4	------
5
6	Jimmy Berry ("boombatower", http://drupal.org/user/214218)
7
8	REQUIREMENTS
9	------------
10
11	* CLI
12	- SimpleTest
13	> curl
14	- PIFR slave
15	> cvs
16	> curl
17	* Drupal 7
18	- Recent libjpeg
19	* PHP
20	- Configuration
21	> Memory limit (CLI and APACHE configurations) recommended: 256MB
22	> PHP short tag support must be disabled.
23	- Extensions
24	> php-cli
25	> php-common
26	> php-curl
27	> php-gd
28	> php-mbstring
29	> php-(database extension)
30	> php-pdo
31	> php-xml
32	* PIFR server
33	- Chart API
34	> http://drupal.org/project/chart
35	- Views
36	> http://drupal.org/project/views
37	- Tabs
38	> http://drupal.org/project/tabs
39	- Clean URLs
40	> http://drupal.org/node/15365
41	* PIFR client
42	- Must run from the webroot.
43	> Example: example.com should point to Drupal installation with PIFR,
44	then example.com/checkout should point to the testing code checkout.
45
46	INSTALLATION
47	------------
48
49	1. Downloaded the latest PIFR release, install the code, and enable the PIFR
50	module (admin/build/modules).
51
52	2. Enabled PIFR Client and/or PIFR server depending on the role(s) the server
53	will fulfill. Follow the additional setup instructions that apply to the
54	roles selected.
55
56	PIFR SERVER:
57
58	1. Visit admin/settings/chart and set the 'Global Background Color' to
59	'FFFFFF00'.
60
61	PIFR CLIENT:
62
63	1. Configure the client by filling in the appropriate values at
64	admin/pifr/configuration.
65
66	2. Create a symbolic link in the root of the Drupal installation to the site
67	files directory and the "checkout" directory which should have been created
68	when you enabled the client. The command to create the symbolic link, run
69	from the Drupal root, should look like the following (where [site_folder]
70	is replaced with the folder the client is running out of):
71
72	ln -s ./sites/[site_folder]/files/checkout .
73
74	3. Ensure that your server has the required PHP PDO exension, PHP version, and
75	mysql version to support running Drupal 7. (Newer version of libjpeg, OS
76	library, is required along with the PHP extension.)
77
78	4. Set up a second database for the testing to occur in. The database
79	information needs to be added to the settings.php with the key
80	'pifr_checkout' file and should look something like the following.
81
82	$db_url = array();
83	$db_url['default'] = 'mysqli://user:password@localhost/drupal';
84	$db_url['pifr_checkout'] = 'mysqli://user:password@localhost/drupal_checkout';
85
86	Due to Drupal 7 requirements, the mysql user for the pifr_checkout database
87	will also need permission to create temporary tables.
88	(CREATE TEMPORARY TABLES)
89
90	This second database is where the Drupal HEAD checkout will be installed
91	and the actual testing will be performed. If possible, you should optimize
92	the database for the rapid creation and deletion of tables.
93
94	For SQLite the path is the only part used (see Drupal 7 for convention).
95	Please ensure that the path points to a file inside the root of the
96	checkout directory.
97
98	5. You should set up a firewall to prevent malicious or buggy patches from causing
99	issues on your server. Disabling the ability to send mail is also a good idea.
100
101	The firewall rules should look something like the following:
102	- Inbound:
103	* HTTP - from testing.drupal.org.
104	- Outbound:
105	* HTTP - to testing.drupal.org and drupal.org.
106	* CVS - to drupal.org HEAD CVS.
107
108	6. Check the client configuration by visiting admin/pifr/configuration and
109	correct any issues found.
110
111	7. To test the client and determine what is wrong with it you can use the
112	run tests locally tool (pifr/client/review/test). It will attempt to run
113	the client through a complete test run as it will do when reviewing.
114
115	8. Once the client is ready to be added to the master server list, it is time
116	to setup cron. Cron needs to run on the client every 5-10 minutes for
117	optimal efficiency.
118
119	9. Add the test client to PIFR Server 'server list'.