Update admin guide.
[pithos] / docs / source / adminguide.rst
index 6634a05..4e8ae5e 100644 (file)
@@ -9,7 +9,7 @@ Assuming a clean debian squeeze (stable) installation, use the following steps t
 Install packages::
 
   apt-get install git python-django python-setuptools python-sphinx
-  apt-get install python-sqlalchemy python-psycopg2
+  apt-get install python-sqlalchemy python-mysqldb python-psycopg2
   apt-get install apache2 libapache2-mod-wsgi
 
 Get the source::
@@ -17,14 +17,15 @@ Get the source::
   cd /
   git clone https://code.grnet.gr/git/pithos
 
-Setup the files (choose where to store data in ``settings.py`` and change ``SECRET_KEY``)::
+Setup the files::
 
   cd /pithos/pithos
-  cp settings.py.dist settings.py
   python manage.py syncdb
   cd /pithos
   python setup.py build_sphinx
 
+It is advised that you create a ``settings.local`` file to place any configuration overrides (at least change ``SECRET_KEY``).
+
 Edit ``/etc/apache2/sites-available/pithos`` (change the ``ServerName`` directive)::
 
   <VirtualHost *:80>
@@ -42,11 +43,17 @@ Edit ``/etc/apache2/sites-available/pithos`` (change the ``ServerName`` directiv
         Allow from all
     </Directory>
 
+    SetEnv no-gzip
+    SetEnv dont-vary
+
     RewriteEngine On
-    RewriteRule ^/v(.*) /api/v$1 [PT]
-    RewriteRule ^/public(.*) /api/public$1 [PT]
-    RewriteRule ^/login(.*) https://%{HTTP_HOST}%{REQUEST_URI}
-    RewriteRule ^/admin(.*) https://%{HTTP_HOST}%{REQUEST_URI}
+    RewriteRule ^/v(.*) /api/v$1 [PT,NE]
+    RewriteRule ^/public(.*) /api/public$1 [PT,NE]
+    RewriteRule ^/tools(.*) /api/ui$1 [PT,NE]
+    RewriteRule ^/im(.*) https://%{HTTP_HOST}%{REQUEST_URI} [NE]
+    RewriteRule ^/login(.*) https://%{HTTP_HOST}%{REQUEST_URI} [NE]
+
+    RequestHeader set X-Forwarded-Protocol "http"
 
     WSGIScriptAlias /api /pithos/pithos/wsgi/pithos.wsgi
     # WSGIDaemonProcess pithos
@@ -57,6 +64,16 @@ Edit ``/etc/apache2/sites-available/pithos`` (change the ``ServerName`` directiv
     CustomLog ${APACHE_LOG_DIR}/pithos.access.log combined
   </VirtualHost>
 
+To disable non-SSL connections, ``/etc/apache2/sites-available/pithos`` should be::
+
+  <VirtualHost *:80>
+    ServerAdmin webmaster@pithos.dev.grnet.gr
+    ServerName pithos.dev.grnet.gr
+
+    RewriteEngine On
+    RewriteRule (.*) https://%{HTTP_HOST}%{REQUEST_URI}
+  </VirtualHost>
+
 Edit ``/etc/apache2/sites-available/pithos-ssl`` (assuming files in ``/etc/ssl/private/pithos.dev.grnet.gr.key`` and ``/etc/ssl/certs/pithos.dev.grnet.gr.crt`` - change the ``ServerName`` directive)::
 
   <IfModule mod_ssl.c>
@@ -75,26 +92,22 @@ Edit ``/etc/apache2/sites-available/pithos-ssl`` (assuming files in ``/etc/ssl/p
         Allow from all
     </Directory>
 
+    SetEnv no-gzip
+    SetEnv dont-vary
+
     RewriteEngine On
-    RewriteRule ^/v(.*) /api/v$1 [PT]
-    RewriteRule ^/public(.*) /api/public$1 [PT]
-    RewriteRule ^/login(.*) /api/login$1 [PT]
-    RewriteRule ^/admin(.*) /api/admin$1 [PT]
+    RewriteRule ^/v(.*) /api/v$1 [PT,NE]
+    RewriteRule ^/public(.*) /api/public$1 [PT,NE]
+    RewriteRule ^/tools(.*) /api/ui$1 [PT,NE]
+    RewriteRule ^/im(.*) /api/im$1 [PT,NE]
+    RewriteRule ^/login(.*) /api/im/login/dummy$1 [PT,NE]
+
+    RequestHeader set X-Forwarded-Protocol "https"
 
     WSGIScriptAlias /api /pithos/pithos/wsgi/pithos.wsgi
     # WSGIDaemonProcess pithos
     # WSGIProcessGroup pithos
 
-    ShibConfig /etc/shibboleth/shibboleth2.xml
-    Alias      /shibboleth-sp /usr/share/shibboleth 
-
-    <Location /api/login>
-        AuthType shibboleth
-        ShibRequireSession On
-        ShibUseHeaders On
-        require valid-user
-    </Location>
-
     LogLevel warn
     ErrorLog ${APACHE_LOG_DIR}/pithos.error.log
     CustomLog ${APACHE_LOG_DIR}/pithos.access.log combined
@@ -109,6 +122,15 @@ Add in ``/etc/apache2/mods-available/wsgi.conf``::
 
   WSGIChunkedRequest On
 
+Make sure the data folder is writable by the web server user::
+
+  chown -R www-data:www-data /pithos/pithos/data
+
+If using an SQLite database, the same goes for the database file and the containing folder::
+
+  chown www-data:www-data /pithos/pithos/
+  chown www-data:www-data /pithos/pithos/backend.db
+
 Configure and run apache::
 
   a2enmod ssl
@@ -122,7 +144,67 @@ Configure and run apache::
 
 Useful alias to add in ``~/.bashrc``::
 
-  alias pithos-sync='cd /pithos && git pull && python setup.py build_sphinx && /etc/init.d/apache2 restart'
+  alias sync-pithos='cd /pithos && git pull && python setup.py build_sphinx && /etc/init.d/apache2 restart'
+
+Gunicorn Setup
+--------------
+
+Add in ``/etc/apt/sources.list``::
+
+  deb http://backports.debian.org/debian-backports squeeze-backports main
+
+Then::
+
+  apt-get update
+  apt-get -t squeeze-backports install gunicorn
+  apt-get -t squeeze-backports install python-gevent
+
+Create ``/etc/gunicorn.d/pithos``::
+
+  CONFIG = {
+   'mode': 'django',
+   'working_dir': '/pithos/pithos',
+   'user': 'www-data',
+   'group': 'www-data',
+   'args': (
+        '--bind=[::]:8080',
+        '--worker-class=egg:gunicorn#gevent',
+        '--workers=4',
+        '--log-level=debug',
+        '/pithos/pithos/settings.py',
+   ),
+  }
+
+Replace the ``WSGI*`` directives in ``/etc/apache2/sites-available/pithos`` and ``/etc/apache2/sites-available/pithos-ssl`` with::
+
+  <Proxy *>
+    Order allow,deny
+    Allow from all
+  </Proxy>
+
+  SetEnv                proxy-sendchunked
+  SSLProxyEngine        off
+  ProxyErrorOverride    off
+
+  ProxyPass        /api http://localhost:8080 retry=0
+  ProxyPassReverse /api http://localhost:8080
+
+Make sure that in ``settings.local``::
+
+  USE_X_FORWARDED_HOST = True
+
+Configure and run::
+
+  /etc/init.d/gunicorn restart
+  a2enmod proxy
+  a2enmod proxy_http
+  /etc/init.d/apache2 restart
+
+If experiencing timeout problems, try adding to ``/etc/gunicorn.d/pithos``::
+
+        ...
+        '--timeout=43200',
+        ...
 
 Shibboleth Setup
 ----------------
@@ -135,15 +217,15 @@ Setup the files in ``/etc/shibboleth``.
 
 Add in ``/etc/apache2/sites-available/pithos-ssl``::
 
-       ShibConfig /etc/shibboleth/shibboleth2.xml
-       Alias      /shibboleth-sp /usr/share/shibboleth 
+  ShibConfig /etc/shibboleth/shibboleth2.xml
+  Alias      /shibboleth-sp /usr/share/shibboleth 
 
-       <Location /api/login>
-               AuthType shibboleth
-               ShibRequireSession On
-               ShibUseHeaders On
-               require valid-user
-       </Location>
+  <Location /api/im/login/shibboleth>
+    AuthType shibboleth
+    ShibRequireSession On
+    ShibUseHeaders On
+    require valid-user
+  </Location>
 
 Configure and run apache::
 
@@ -151,6 +233,16 @@ Configure and run apache::
   /etc/init.d/apache2 restart
   /etc/init.d/shibd restart
 
+The following tokens should be available at the destination, after passing through the apache module::
+
+  eppn # eduPersonPrincipalName
+  Shib-InetOrgPerson-givenName
+  Shib-Person-surname
+  Shib-Person-commonName
+  Shib-InetOrgPerson-displayName
+  Shib-EP-Affiliation
+  Shib-Session-ID
+
 MySQL Setup
 -----------
 
@@ -160,6 +252,11 @@ Server side::
 
   apt-get install mysql-server
 
+Add in ``/etc/mysql/conf.d/pithos.cnf``::
+
+  [mysqld]
+  sql-mode="NO_AUTO_VALUE_ON_ZERO"
+
 Edit ``/etc/mysql/my.cnf`` to allow network connections and restart the server.
 
 Create database and user::