Add step-by-step setup instructions.

[stouyapi.git] / README.rst

diff --git a/README.rst b/README.rst
index 91d490f4d2176fb1217c57a33b1414f8f42bd3bc..445be74057245a985cdff148571edcce56ccbcac 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -30,18 +30,65 @@ OUYA setup
 2. Enter any username, leave password empty. Continue.
 3. Skip credit card registration
 
+The username will appear on your ouya main screen.
+
 
 Apache setup
 ============
+
+.. note:: Step-by-step setup instructions can be found in
+          ``HOWTO-SETUP.rst``.
+
+
 Virtual host configuration::
 
-  Script PUT /empty-json.php
+  <VirtualHost *:80>
+    ServerName stouyapi.test
+    DocumentRoot /path/to/stouyapi/www
+
+    CustomLog /var/log/apache2/stouyapi-access.log combined
+    ErrorLog  /var/log/apache2/stouyapi-error.log
+
+    Script PUT /empty-json.php
+    Script DELETE /api/v1/queued_downloads_delete.php
 
-``mod_actions`` need to be enabled for apache 2.4.
+    <Directory "/path/to/stouyapi/www">
+      AllowOverride All
+      Require all granted
+    </Directory>
+  </VirtualHost>
+
+The following modules need to be enabled in Apache 2.4
+(with e.g. ``a2enmod``):
+
+- ``actions``
+- ``expires``
+- ``php`` (or php-fpm via fastcgi)
+- ``rewrite``
 
 The virtual host's document root needs to point to the ``www`` folder.
 
 
+Test your Apache setup
+----------------------
+::
+
+   # check if normal API routes work
+   $ curl -I http://stouyapi.cwboo/api/firmware_builds
+   HTTP/1.1 200 OK
+   [...]
+
+   # check if rewritten API routes work
+   $ curl -I http://stouyapi.cwboo/api/v1/discover/discover
+   HTTP/1.1 200 OK
+   [...]
+
+   # check if PHP routes work
+   curl -I http://stouyapi.cwboo/api/v1/gamers/me
+   HTTP/1.1 200 OK
+   [...]
+
+
 Building API data
 =================
 Download the OUYA game data repository from
@@ -52,6 +99,31 @@ and then generate the API files with it::
     $ ./bin/import-game-data.php ouya-game-data/folders
 
 
+Building the web discover store
+===============================
+After building the API files, generate the HTML::
+
+  $ ./bin/build-html.php
+
+
+===============
+Push to my OUYA
+===============
+stouyapi's HTML game detail page have a "Push to my OUYA" button that
+allows anyone to tell his own OUYA to install that game.
+It works without any user accounts, and is only based on IP addresses.
+
+If your PC that you click the Push button on and your OUYA have the same
+public IP address (IPv4 NAT), or the same IPv6 64bit prefix, then
+the OUYA will install the game within 5 minutes.
+
+It will also work if you run stouyapi inside your local network, because
+all private IP addresses are mapped to a special "local" address.
+
+You can inspect your own download queue by simply opening
+``/api/v1/queued_downloads`` in your browser.
+
+
 ========
 See also
 ========