link howto

[stouyapi.git] / README.rst

diff --git a/README.rst b/README.rst
index f5df7cf6697ba6b836f6837819d033d8ffefde0f..ece443089dd340bc395f7c75e29281a955dfc98b 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -35,17 +35,36 @@ The username will appear on your ouya main screen.
 
 Apache setup
 ============
+
+.. note:: Step-by-step setup instructions can be found in
+          `HOWTO-SETUP.rst <HOWTO-SETUP.rst>`__.
+
+
 Virtual host configuration::
 
-  Script PUT /empty-json.php
-  Script DELETE /api/v1/queued_downloads_delete.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
+
+    <Directory "/path/to/stouyapi/www">
+      AllowOverride All
+      Require all granted
+    </Directory>
+  </VirtualHost>
 
-  <Directory "/path/to/stouyapi/www">
-    AllowOverride All
-  </Directory>
+The following modules need to be enabled in Apache 2.4
+(with e.g. ``a2enmod``):
 
-``mod_actions``, ``mod_expires`` and ``mod_php`` (or php-fpm) need to be enabled
-for Apache 2.4.
+- ``actions``
+- ``expires``
+- ``php`` (or php-fpm via fastcgi)
+- ``rewrite``
 
 The virtual host's document root needs to point to the ``www`` folder.