Administrator Guide
===================
-Add the following line in in ``uwsgi_params``::
+Simple Setup
+------------
+
+Assuming a clean debian squeeze (stable) installation, use the following steps to run the software.
+
+Install packages::
+
+ apt-get install git python-django python-setuptools python-sphinx
+ apt-get install python-sqlalchemy python-mysqldb python-psycopg2
+ apt-get install apache2 libapache2-mod-wsgi
+
+Get the source::
+
+ cd /
+ git clone https://code.grnet.gr/git/pithos
+
+Setup the files::
+
+ cd /pithos/pithos
+ 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>
+ ServerAdmin webmaster@pithos.dev.grnet.gr
+ ServerName pithos.dev.grnet.gr
+
+ DocumentRoot /pithos/htdocs
+ Alias /ui "/var/www/pithos_web_client"
+ Alias /docs "/pithos/docs/build/html"
+
+ <Directory />
+ Options Indexes FollowSymLinks
+ AllowOverride None
+ Order allow,deny
+ Allow from all
+ </Directory>
+
+ SetEnv no-gzip
+ SetEnv dont-vary
+
+ RewriteEngine On
+ 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
+ # WSGIProcessGroup pithos
+
+ LogLevel warn
+ ErrorLog ${APACHE_LOG_DIR}/pithos.error.log
+ 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>
+ <VirtualHost _default_:443>
+ ServerAdmin webmaster@pithos.dev.grnet.gr
+ ServerName pithos.dev.grnet.gr
+
+ DocumentRoot /pithos/htdocs
+ Alias /ui "/var/www/pithos_web_client"
+ Alias /docs "/pithos/docs/build/html"
+
+ <Directory />
+ Options Indexes FollowSymLinks
+ AllowOverride None
+ Order allow,deny
+ Allow from all
+ </Directory>
+
+ SetEnv no-gzip
+ SetEnv dont-vary
+
+ RewriteEngine On
+ 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
+
+ LogLevel warn
+ ErrorLog ${APACHE_LOG_DIR}/pithos.error.log
+ CustomLog ${APACHE_LOG_DIR}/pithos.access.log combined
+
+ SSLEngine on
+ SSLCertificateFile /etc/ssl/certs/pithos.dev.grnet.gr.crt
+ SSLCertificateKeyFile /etc/ssl/private/pithos.dev.grnet.gr.key
+ </VirtualHost>
+ </IfModule>
+
+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
+ a2enmod rewrite
+ a2dissite default
+ a2ensite pithos
+ a2ensite pithos-ssl
+ mkdir /var/www/pithos
+ mkdir /var/www/pithos_web_client
+ /etc/init.d/apache2 restart
+
+Useful alias to add in ``~/.bashrc``::
+
+ 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
+----------------
+
+Install package::
+
+ apt-get install libapache2-mod-shib2
+
+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
+
+ <Location /api/im/login/shibboleth>
+ AuthType shibboleth
+ ShibRequireSession On
+ ShibUseHeaders On
+ require valid-user
+ </Location>
+
+Configure and run apache::
+
+ a2enmod shib2
+ /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
+-----------
+
+If using MySQL instead of SQLite for the database engine, consider the following.
+
+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::
+
+ CREATE DATABASE pithos CHARACTER SET utf8 COLLATE utf8_bin;
+ GRANT ALL ON pithos.* TO pithos@localhost IDENTIFIED BY 'password';
+ GRANT ALL ON pithos.* TO pithos@'%' IDENTIFIED BY 'password';
+
+Client side::
+
+ apt-get install mysql-client
+
+It helps to create a ``~/.my.cnf`` file, for automatically connecting to the server::
+
+ [client]
+ user = pithos
+ password = 'password'
+ host = pithos-storage.dev.grnet.gr
+
+ [mysql]
+ database = pithos
+
+PostgreSQL Setup
+----------------
+
+If using PostgreSQL instead of SQLite for the database engine, consider the following.
+
+Server side::
+
+ apt-get install postgresql
+
+Edit ``/etc/postgresql/8.4/main/postgresql.conf`` and ``/etc/postgresql/8.4/main/pg_hba.conf`` to allow network connections and restart the server.
+
+Create database and user::
+
+ CREATE DATABASE pithos WITH ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' TEMPLATE=template0;
+ CREATE USER pithos WITH PASSWORD 'password';
+ GRANT ALL PRIVILEGES ON DATABASE pithos TO pithos;
+
+Client side::
+
+ apt-get install postgresql-client
+
+It helps to create a ``~/.pgpass`` file, for automatically passing the password to the server::
+
+ pithos-storage.dev.grnet.gr:5432:pithos:pithos:password
+
+Connect with::
+
+ psql -h pithos-storage.dev.grnet.gr -U pithos
- uwsgi_param UWSGI_SCHEME $scheme;
projects / pithos / blobdiff