Update the install guidelines for perf.webkit.org
authorzoltan@webkit.org <zoltan@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 10 Mar 2014 23:01:18 +0000 (23:01 +0000)
committerzoltan@webkit.org <zoltan@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 10 Mar 2014 23:01:18 +0000 (23:01 +0000)
https://bugs.webkit.org/show_bug.cgi?id=129895

Reviewed by Ryosuke Niwa.

The current install guideline for perf.webkit.org discourages the use of the installed
Server application. I've actualized the documentation for Mavericks, and modified the
guideline to include the instructions for Server.app also.

* Install.md:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@165411 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Websites/perf.webkit.org/ChangeLog
Websites/perf.webkit.org/Install.md

index 027746c..d71b7c4 100644 (file)
@@ -1,3 +1,16 @@
+2014-03-10  Zoltan Horvath  <zoltan@webkit.org>
+
+        Update the install guidelines for perf.webkit.org
+        https://bugs.webkit.org/show_bug.cgi?id=129895
+
+        Reviewed by Ryosuke Niwa.
+
+        The current install guideline for perf.webkit.org discourages the use of the installed
+        Server application. I've actualized the documentation for Mavericks, and modified the
+        guideline to include the instructions for Server.app also.
+
+        * Install.md:
+
 2014-03-08  Zoltan Horvath  <zoltan@webkit.org>
 
         Update perf.webkit.org json example
index 37ba7c3..1f18c4a 100644 (file)
@@ -1,9 +1,11 @@
 # Checking Out the Code and Installing Required Applications
 
-Note: These instructions assume you're using Mac OS X Mountain Lion as the host server, and assume that we're installing
-this application at `/Volumes/Data/WebKitPerfMonitor`.
+The instructions assume you're using Mac OS X (Mavericks for Server.app case and Mountain Lion without Server.app) as the
+host server, and assume that we're installing this application at `/Volumes/Data/WebKitPerfMonitor`.
 
-1. Install Server (DO NOT launch the Server app)
+You can choose between using Server.app or install the required tools separately
+
+1. Install Server.app (if you don't want to use Server.app, install PostgreSQL: http://www.postgresql.org/download/macosx/)
 2. Install node.
 3. Install Xcode with command line tools (only needed for svn)
 4. `svn co https://svn.webkit.org/repository/webkit/trunk/Websites/perf.webkit.org /Volumes/Data/WebKitPerfMonitor`
@@ -12,32 +14,47 @@ this application at `/Volumes/Data/WebKitPerfMonitor`.
 
 # Configuring Apache
 
-Don't use the Server App to start or stop Apache. It does weird things to httpd configurations. Use apachectl instead:
- - Starting httpd: `sudo apachectl stop`
- - Stopping httpd: `sudo apachectl restart`
+You can use apachectl to start/stop/restart apache server from the command line:
+
+ - Starting httpd: `sudo apachectl start`
+ - Stopping httpd: `sudo apachectl stop`
+ - Restarting httpd: `sudo apachectl restart`
+
+## Instructions if you're using Server.app
+
+ - Enable PHP web applications
+ - Go to Server Website / Store Site Files In, change it to /Volumes/Data/WebKitPerfMonitor/public/`
+ - Go to Server Website / Edit advanced settings, enable Allow overrides using .htaccess files
+
+## Instructions if you're not using Server.app
+
+ - Edit /private/etc/apache2/httpd.conf
 
-## Edit /private/etc/apache2/httpd.conf
+     1. Change DocumentRoot to `/Volumes/Data/WebKitPerfMonitor/public/`
+     2. Uncomment `"LoadModule php5_module libexec/apache2/libphp5.so"`
+     3. Modify the directives for the document root and / to allow overriding `"All"`
+     4. Delete directives on CGI-Executables
+
+## Common directives for the related apache config file
+
+  httpd config file is located at:
+
+    - With Server.app: /Library/Server/Web/Config/apache2/sites/0000_any_80.conf (and/or 0000_any_`PORT#`.conf)
+    - Without: /private/etc/apache2/httpd.conf
+
+ 1. Update ServerAdmin to your email address
+ 2. Add the following directives to enable gzip:
 
-1. Update ServerAdmin to your email address
-2. Change DocumentRoot to `/Volumes/Data/WebKitPerfMonitor/public/`
-3. Uncomment `"LoadModule php5_module libexec/apache2/libphp5.so"`
-4. Modify the directives for the document root and / to allow overriding `"All"`
-5. Delete directives on CGI-Executables
-6. Add the following directives to enable gzip:
-    
         <IfModule mod_deflate.c>
             AddOutputFilterByType DEFLATE text/html text/xml text/plain application/json application/xml application/xhtml+xml
         </IfModule>
 
-7. Add the following directives to enable zlib compression and MultiViews on WebKitPerfMonitor/public:
+ 3. Add the following directives to enable zlib compression and MultiViews on WebKitPerfMonitor/public:
 
         Options Indexes MultiViews
         php_flag zlib.output_compression on
 
-Note: If you've accidentally turned on the Server app, httpd.conf is located at `/Library/Server/Web/Config/apache2/` instead.
-Delete the Web Sharing related stuff and include `/private/etc/apache2/httpd.conf` at the very end.
-
-The log is located at `/private/var/log/apache2`.
+The apache logs are located at `/private/var/log/apache2`.
 
 
 # Protecting the Administrative Pages to Prevent Execution of Arbitrary Code
@@ -55,7 +72,7 @@ Generate a password file via `htdigest -c <path> <realm> <username>`, and then c
        AuthUserFile "<Realm>"
        Require valid-user
 
-where <Realm> is replaced with the realm of your choice.
+where <Realm> is replaced with the realm of your choice, which will be displayed on the username/password input box.
 
 
 # Configuring PostgreSQL
@@ -67,6 +84,8 @@ where <Realm> is replaced with the realm of your choice.
 
 ## Creating a Database and a User
 
+The binaries located in PostgreSQL's directory, or if you're using Server.app in /Applications/Server.app/Contents/ServerRoot/usr/bin/
+
 1. Create a database: `createdb webkit-perf-db -h localhost`
 2. Create a user: `createuser -P -S -e webkit-perf-db-user -h localhost`
 3. Connect to database: `psql webkit-perf-db -h localhost`