Add an instruction on how to setup test-results app

https://bugs.webkit.org/show_bug.cgi?id=123321

Rubber-stamped by Stephanie Lewis.

Added Install.md and updated config.json accordingly.

Also moved init-database.sql out of public/include since it doesn't need to be accessible via httpd.

* Install.md: Added.
* config.json:
* init-database.sql: Moved from public/include/init-database.sql.

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

diff --git a/Websites/test-results/ChangeLog b/Websites/test-results/ChangeLog
index 8582915bb308f1516953d59293ad2b451772d2a1..36c3036fe326e31de5fe818869bdd184579dc822 100644 (file)
--- a/Websites/test-results/ChangeLog
+++ b/Websites/test-results/ChangeLog
@@ -1,3 +1,18 @@
+2013-10-24  Ryosuke Niwa  <rniwa@webkit.org>
+
+        Add an instruction on how to setup test-results app
+        https://bugs.webkit.org/show_bug.cgi?id=123321
+
+        Rubber-stamped by Stephanie Lewis.
+
+        Added Install.md and updated config.json accordingly.
+
+        Also moved init-database.sql out of public/include since it doesn't need to be accessible via httpd.
+
+        * Install.md: Added.
+        * config.json:
+        * init-database.sql: Moved from public/include/init-database.sql.
+
 2013-10-24  Ryosuke Niwa  <rniwa@webkit.org>
 
         Move everything except ChangeLog and config.json into public directory.

diff --git a/Websites/test-results/Install.md b/Websites/test-results/Install.md
new file mode 100644 (file)
index 0000000..9dc1e20
--- /dev/null
+++ b/Websites/test-results/Install.md
@@ -0,0 +1,79 @@
+# Checking Out the Code and Installing Required Applications
+
+Note: These instructions assume you're using Mac OS X Mavericks as the host server, and assume that we're installing
+this application at `/Volumes/Data/test-results`.
+
+1. Install Server (DO NOT launch the Server app)
+2. Install Xcode with command line tools (only needed for svn); On Mavericks, simply run svn to trigger the installation.
+3. `svn co https://svn.webkit.org/repository/webkit/trunk/Websites/test-results /Volumes/Data/test-results`
+
+# Configuring Apache
+
+Always use apachectl instead of the Server App to start or stop Apache.
+ - Starting httpd: `sudo apachectl stop`
+ - Stopping httpd: `sudo apachectl restart`
+
+## Edit /private/etc/apache2/httpd.conf
+
+1. Uncomment `"LoadModule php5_module libexec/apache2/libphp5.so"`
+2. Update ServerAdmin to `rniwa@apple.com`
+2. Set ServerName.
+3. Change DocumentRoot to `/Volumes/Data/test-results/public/`
+4. Change the directives for the document root and / to point to `/Volumes/Data/test-results/public/`
+5. Add Add the following directives to enable zlib compression and MultiViews:
+
+        Options Indexes MultiViews
+        php_flag zlib.output_compression on
+
+6. Delete or comment out directives on CGI-Executables
+7. 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>
+
+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.
+
+By default, the Apache error log will be located at `/private/var/log/apache2/error_log`.
+
+
+# Protecting the Administrative Pages to Prevent Execution of Arbitrary Code
+
+By default, the application gives the administrative privilege to everyone. Anyone can add, remove, or edit tests,
+builders, and other entities in the database and may even execute arbitrary JavaScript on the server via aggregators.
+
+We recommend protection via Digest Auth on https connection.
+
+Generate a password file via `htdigest -c <path> <realm> <username>`, and then add the following directive:
+
+        <Directory "/Volumes/Data/test-results/public/admin/">
+               AuthType Digest
+               AuthName "<realm>"
+               AuthDigestProvider file
+               AuthUserFile "<path>"
+               Require valid-user
+        </Directory>
+
+where <realm> is replaced with the realm of your choice.
+
+
+# Configuring PostgreSQL
+
+1. Create database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/initdb /Volumes/Data/test-results/database`
+2. Start database:
+   `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_ctl -D /Volumes/Data/test-results/database
+   -l logfile -o "-k /Volumes/Data/test-results/database" start`
+
+## Creating a Database and a User
+
+1. Create a database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/createdb test-results-db -h localhost`
+2. Create a user: `/Applications/Server.app/Contents/ServerRoot/usr/bin/createuser -P -S -e test-results-user -h localhost`
+3. Connect to database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/psql test-results-db -h localhost`
+4. Grant all permissions to the new user: `grant all privileges on database "test-results-db" to "test-results-user";`
+5. Update database/config.json.
+
+## Initializing the Database
+
+Run `database/init-database.sql` in psql as `test-results-user`:
+`/Applications/Server.app/Contents/ServerRoot/usr/bin/psql test-results-db -h localhost --username test-results-user -f init-database.sql`

diff --git a/Websites/test-results/config.json b/Websites/test-results/config.json
index 6e3687ccf7fb99a3f345f05d873f7fbfcccbd7a1..8a178db585870fa18220cddc91362187488b5f12 100644 (file)
--- a/Websites/test-results/config.json
+++ b/Websites/test-results/config.json
@@ -5,9 +5,9 @@
     "database": {
         "host": "localhost",
         "port": "5432",
-        "username": "safari-test-history",
+        "username": "test-results-user",
         "password": "password",
-        "name": "safari-test-history-db"
+        "name": "test-results-db"
     },
     "masters": [
         "build.webkit.org",

diff --git a/Websites/test-results/public/include/init-database.sql b/Websites/test-results/init-database.sql
similarity index 100%
rename from Websites/test-results/public/include/init-database.sql
rename to Websites/test-results/init-database.sql