Build fix. Strip out "use strict" everywhere so that the perf dashboard works on...
[WebKit-https.git] / Websites / perf.webkit.org / Install.md
1 # Checking Out the Code and Installing Required Applications
2
3 The instructions assume you're using Mac OS X as the host server and installing this application at `/Volumes/Data/perf.webkit.org`.
4
5 You can choose between using Server.app or install the required tools separately
6
7 1. Install Server.app (if you don't want to use Server.app, install PostgreSQL: http://www.postgresql.org/download/macosx/)
8 2. Install node.
9 3. Install Xcode with command line tools (only needed for svn)
10 4. `svn co https://svn.webkit.org/repository/webkit/trunk/Websites/perf.webkit.org /Volumes/Data/perf.webkit.org`
11 5. Inside `/Volumes/Data/perf.webkit.org`, run `npm install pg` and `mkdir -m 755 public/data/`
12
13 # Testing Local UI Changes with Production Data
14
15 The front end has the capability to pull data from a production server without replicating the database locally on OS X (Yosemite and later).
16 To use this feature, modify `config.json`'s `remoteServer` entry so that "remoteServer.url" points to your production server,
17 and "remoteServer.basicAuth" specifies the username and the password that is used by the production sever.
18
19 Remove "basicAuth" entry for production servers that doesn't require a basic authentication (e.g. perf.webkit.org).
20
21 ```json
22 {
23     "url": "http://perf.webkit.org",
24     "basicAuth": {
25         "username": "webkitten",
26         "password": "webkitten's secret password"            
27     }
28 }
29 ```
30
31 Then run `tools/remote-cache-server.py start`. This launches a httpd server on port 8080.
32
33 The script caches remote server's responses under `public/data/remote-cache` and never revalidates them (to allow offline work).
34 If you needed the latest content, delete caches stored in this directory by running `tools/remote-cache-server.py reset`.
35
36
37 # Configuring Apache
38
39 ## Instructions if you're using Server.app
40
41  - Enable PHP web applications
42  - Go to Server Website / Store Site Files In, change it to `/Volumes/Data/perf.webkit.org/public/`
43  - Go to Server Website / Edit advanced settings, enable Allow overrides using .htaccess files
44  - httpd config file is located at `/Library/Server/Web/Config/apache2/sites/0000_any_80.conf` (and/or 0000_any_`PORT#`.conf)
45
46 ## Instructions if you're not using Server.app
47
48  - Edit /private/etc/apache2/httpd.conf
49
50      1. Change DocumentRoot to `/Volumes/Data/perf.webkit.org/public/`
51      2. Uncomment `LoadModule php5_module libexec/apache2/libphp5.so`
52      3. Uncomment `LoadModule rewrite_module libexec/apache2/mod_rewrite.so`
53      4. Uncomment `LoadModule deflate_module libexec/apache2/mod_deflate.so`
54
55  - In Mavericks and later, copy php.ini to load pdo_pgsql.so pgsql.so.
56     `sudo cp /Applications/Server.app/Contents/ServerRoot/etc/php.ini /etc/`
57  - In El Capitan and later, comment out the `LockFile` directive in `/private/etc/apache2/extra/httpd-mpm.conf`
58    since the directive has been superseded by `Mutex` directive.
59
60 ## Starting Apache
61
62 You can use apachectl to start/stop/restart apache server from the command line:
63
64 - Starting httpd: `sudo apachectl start`
65 - Stopping httpd: `sudo apachectl stop`
66 - Restarting httpd: `sudo apachectl restart`
67
68 The apache logs are located at `/private/var/log/apache2`.
69
70 ## Production Configurations
71
72  1. Update ServerAdmin to your email address
73  2. Add the following directives to enable gzip:
74
75         <IfModule mod_deflate.c>
76             AddOutputFilterByType DEFLATE text/html text/xml text/plain application/json application/xml application/xhtml+xml
77         </IfModule>
78
79  3. Add the following directives to enable zlib compression and MultiViews on DocumentRoot (perf.webkit.org/public):
80
81         Options Indexes MultiViews
82         php_flag zlib.output_compression on
83
84 ### Protecting the Administrative Pages to Prevent Execution of Arbitrary Code
85
86 By default, the application gives the administrative privilege to everyone. Anyone can add, remove, or edit tests,
87 builders, and other entities in the database.
88
89 We recommend protection via Digest Auth on https connection.
90
91 Generate a password file via `htdigest -c <path> <realm> <username>`, and then create admin/.htaccess with the following directives
92 where `<Realm>` is replaced with the realm of your choice, which will be displayed on the username/password input box:
93
94 ```
95 AuthType Digest
96 AuthName "<Realm>"
97 AuthDigestProvider file
98 AuthUserFile "<Realm>"
99 Require valid-user
100 ```
101
102 # Configuring PostgreSQL
103
104 Run the following command to setup a Postgres server at `/Volumes/Data/perf.webkit.org/PostgresSQL` (or wherever you'd prefer):
105 `python ./tools/setup-database.py /Volumes/Data/perf.webkit.org/PostgresSQL`
106
107 It automatically retrieves the database name, the username, and the password from `config.json`.
108
109 ## Starting PostgreSQL
110
111 The setup script automatically starts the database but you may need to run the following command to manually start the database after reboot.
112
113 - Starting the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_ctl -D /Volumes/Data/perf.webkit.org/PostgresSQL -l /Volumes/Data/perf.webkit.org/PostgresSQL/logfile -o "-k /Volumes/Data/perf.webkit.org/PostgresSQL" start`
114 - Stopping the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_ctl -D /Volumes/Data/perf.webkit.org/PostgresSQL -l /Volumes/Data/perf.webkit.org/PostgresSQL/logfile -o "-k /Volumes/Data/perf.webkit.org/PostgresSQL" stop`
115
116 ## Initializing the Database
117
118 Run `database/init-database.sql` in psql as `webkit-perf-db-user`:
119 `/Applications/Server.app/Contents/ServerRoot/usr/bin/psql webkit-perf-db -h localhost --username webkit-perf-db-user -f init-database.sql`
120
121 ## Making a Backup and Restoring
122
123 - Backing up the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_dump -h localhost --no-owner -f <filepath> webkit-perf-db | gzip > backup.gz`
124 - Restoring the database: `gunzip -c backup.gz | /Applications/Server.app/Contents/ServerRoot/usr/bin/psql webkit-perf-db -h localhost --username webkit-perf-db-user`