Skip to content

Latest commit

 

History

History
290 lines (187 loc) · 6.15 KB

install.rst

File metadata and controls

290 lines (187 loc) · 6.15 KB

Metadata Explorer Tool Install

Install requirements

System packages (ubuntu-1204)

  • python-setuptools
  • python-dev
  • python-virtualenv
  • python-imaging
  • libjpeg-dev
  • libpng-dev
  • postgresql
  • libapache2-mod-wsgi
  • build-essential
  • libxml2-dev
  • libxslt-dev
  • libpq-dev
  • xmlsec1
  • memcached
  • libffi-dev
  • django_chartit
  • dateutils

Create database

postgresql :

sudo su - postgres
createuser -P met
createdb --owner met met

Project deployment

  • Create a user met in the system:

    sudo adduser met

  • Add www-data into met group:

    sudo adduser www-data met

  • Change to met user:

    sudo su - met

  • Create a virtualenv and load it:

    virtualenv met-venv
source met-venv/bin/activate

  • Clone git repository:

    git clone git://github.com/Yaco-Sistemas/met.git

  • Deploy met egg:

    cd met
python setup.py develop

  • Configure local_settings and initialize met database (create models):

    cp local_settings.example.py local_settings.py
python manage.py syncdb

  • To initialize static files for admin page of Django execute:

    python manage.py collectstatic

  • Patch the pyFF modyle with files in pyff-patch

    cp pyff-patch/* met-venv/lib/python2.7/site-packages/pyff/

Apache configuration

This is a basic template that assumes the project was deployed into met user's home.

A apache 2.2.18 or later is required (AllowEncodedSlashes NoDecode) http://httpd.apache.org/docs/2.2/mod/core.html#allowencodedslashes

Alias /media/ /home/met/media/
Alias /static/ /home/met/static/

<Directory /home/met/media/>
Order deny,allow
Allow from all
</Directory>

<Directory /home/met/static/>
Order deny,allow
Allow from all
</Directory>

AllowEncodedSlashes NoDecode

WSGIDaemonProcess <server name> home=/home/met
WSGIProcessGroup <server name>

WSGIScriptAlias / /home/met/met/met-wsgi.py

<Directory /home/met/met/met-wsgi.py>
Order allow,deny
Allow from all
</Directory>

<Location /met/saml2/login >
authtype shibboleth
shibRequestSetting requireSession 1
require valid-user
</Location>

Enable memcached

Memcached is disabled in the local_settings.example.py configuration. Find the block CACHES in your local_settings.py file and set it as follow:

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'LOCATION': '127.0.0.1:11211',
    }
}

Initialize media directory

Initialize media directory with proper permissions:

python manage.py collectstatic
mkdir ~/media
chmod g+srw ~/media

Create directory for pyFF cache

Create a cache directory for pyFF with proper permissions:

mkdir /home/met/met/.cache
chown www-data.www-data /home/met/met/.cache

Automatic refresh of federations' metadata

Metadata of configured federations can be refreshed automatically. To achieve this you just need to configure a cronjob on your server such as:

0 * * * * cd /home/met/met && /home/met/met-venv/bin/python /home/met/met/automatic_refresh/refresh.py --log /home/met/met/automatic_refresh/pylog.conf

With the option --log the script will log as configured in the logging configuration file.

This cron code must be inserted for the met user, so to edit the proper cron file, it is highly suggested you use the command:

crontab -u met -e

Logrotate configuration

Logrotate can be configured to avoid the continuous growth of the refresh metadata script logging:

 /var/log/met_refresh.log {
      rotate 7
      daily
      missingok
      notifempty
      delaycompress
      compress
      postrotate
              touch /var/log/met_refresh.log >/dev/null 2>&1 || true
              chown www-data.www-data /var/log/met_refresh.log >/dev/null 2>&1 || true
              reload rsyslog >/dev/null 2>&1 || true
      endscript
}

Publishing Met Documentation

You have to install the Sphinx package inside a python virtualenv. You can install Sphinx with this command:

easy_install Sphinx

Now, you need to build the html from the rst pages:

cd /home/met/met/doc
make html

To publish the generated html in your MET site, you can add this block to your apache site configuration:

Alias /doc /home/met/met/doc/build/html
<Directory /home/met/met/doc/build/html>
   Options Indexes FollowSymlinks
   Order deny,allow
   Allow from all
</Directory>

Customizations

Customize /about page

We are going to create a new about.html template that overwrite the default about.html template. To do this, you must ensure that this block exists in your local_settings.py (it is already set in local_settings.example.py provided by this package)

TEMPLATE_DIRS = (
    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
    # Always use forward slashes, even on Windows.
    # Don't forget to use absolute paths, not relative paths.
    os.path.join(BASEDIR, 'templates'),
)

BASEDIR is the directory where local_settings.py and met-wsgi.py are. Then we need to create a directory called templates and a file called about.html in it. The about.html file must have this structure:

{% extends "base.html" %}

{% block content %}
<p>This is your custom content</p>
{% endblock %}

You can add your custom html between the block and endblock tags.