Explain push-to-my-ouya

[stouyapi.git] / README.rst

diff --git a/README.rst b/README.rst
index bb6527702bb6ffcde88fa0268c842b393e10ca06..0b7b800f4a3062d4bbcd6289c7bdce1b1f64df35 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -19,10 +19,8 @@ OUYA config change
     OUYA_SERVER_URL=http://stouyapi.boo
     OUYA_STATUS_SERVER_URL=http://stouyapi.boo/api/v1/status
 
-Notes:
-
-- "important note, don't put trailing slash into OUYA_SERVER_URL, it will make double slashes"
-- I had to reboot to make that change in the file active
+The changes should take effect immediately.
+If they do not, reboot the OUYA once.
 
 
 OUYA setup
@@ -33,26 +31,68 @@ OUYA setup
 3. Skip credit card registration
 
 
+Apache setup
+============
+Virtual host configuration::
 
-===========
-Information
-===========
-By default, OUYA uses HTTPS to devs.ouya.tv.
-(status.ouya.tv is HTTP only, no SSL)
-DNS mapping does not work, except when creating an own SSL certificate
-and registering the root CA at the OUYA itself.
+  Script PUT /empty-json.php
+  Script DELETE /api/v1/queued_downloads_delete.php
+
+``mod_actions`` need to be enabled for apache 2.4.
+
+The virtual host's document root needs to point to the ``www`` folder.
+
+
+Building API data
+=================
+Download the OUYA game data repository from
+https://github.com/ouya-saviors/ouya-game-data
+and then generate the API files with it::
+
+    $ git clone https://github.com/ouya-saviors/ouya-game-data.git
+    $ ./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
 
-IPv6 used -> custom domain needs IPv6 DNS entry
 
-https://rabid.ouya.tv/ - was OUYA's sandbox instance
+===============
+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.
 
-DEBUG=1
-DEBUG_SPAM=1
 
 ========
 See also
 ========
 
-- https://gitlab.com/devirich/BrewyaOnOuya
-- https://archive.org/details/ouyalibrary
-- https://github.com/cweiske/ouya-game-data/
+- https://gitlab.com/devirich/BrewyaOnOuya - alternative storefront
+- https://archive.org/details/ouyalibrary - Archived OUYA games
+- https://github.com/ouya-saviors/ouya-game-data/ - OUYA game data repository
+
+
+===========
+Discoveries
+===========
+
+- data/data/tv.ouya/cache/ion/
+
+  - image cache for main menu image
+
+- Don't put a trailing slash into ``OUYA_SERVER_URL`` - it will make double slashes