openoni.md

Open ONI

Contents

• Dependencies
• Install
  • Clone Open ONI
  • SELinux Permissions
  • File-based Cache Directory
  • Python Virtual Environment
  • Migrate Database
  • Newspaper Data Symlink
• Configure
  • Solr Schema
  • Django
    • Local Settings
      • Theme and Plugins
      • Title and Project Name
    • Logging
    • URLs
    • WSGI Path
• Compile Static Assets
• Load Batches

Dependencies

Install required services

yum install python-virtualenv

Install

Clone Open ONI

mkdir /var/local/www/django
chgrp webadmins /var/local/www/django
chmod 2775 /var/local/www/django
cd /var/local/www/django

Run these commands as a regular user rather than root

git clone [email protected]:open-oni/open-oni.git openoni
cd openoni

# We're currently deploying from dev branch for Django 1.11 LTS
git checkout dev

SELinux Permissions

# Python executables need httpd-executable SELinux context
semanage fcontext -a -t httpd_sys_script_exec_t "/var/local/www/django/openoni/ENV/lib/python2.7/site-packages/.+\.so"

# Static asset path needs Apache write access
mkdir /var/local/www/django/openoni/static/compiled
semanage fcontext -a -t httpd_sys_rw_content_t "/var/local/www/django/openoni/static/compiled(/.*)?"

restorecon -F -R /var/local/www/django/openoni/

File-based Cache Directory

This is only used if the production settings file is enabled in Open ONI's settings_local.py

mkdir -p /var/tmp/django_cache
chown apache /var/tmp/django_cache
chmod 2770 /var/tmp/django_cache

Python Virtual Environment

Run these commands as a regular user rather than root

cd /var/local/www/django/openoni

# Create and activate Python virtual environment
virtualenv ENV
source ENV/bin/activate

# Update pip and setuptools
pip install -U pip
pip install -U setuptools

# Install / update Open ONI dependencies
pip install -U -r requirements.txt

Migrate Database

Run these commands as a regular user rather than root

cd /var/local/www/django/openoni
source ENV/bin/activate
./manage.py migrate

Newspaper Data Symlink

Run these commands as a regular user rather than root

cd /var/local/www/django/openoni
source ENV/bin/activate

rm -rf data/batches
ln -s /var/local/newspapers data/batches

./manage.py batches

Configure

Solr Schema

cp /var/local/www/django/openoni/docker/solr/schema.xml /var/solr/data/openoni/conf/schema.xml
cp /var/local/www/django/openoni/docker/solr/solrconfig.xml /var/solr/data/openoni/conf/solrconfig.xml
chown -R solr.solr /var/solr/data/openoni

service solr restart

Django

Local Settings

cp settings_local_example.py settings_local.py

Follow instructions within for the appropriate deployment environment

Theme and Plugins

Add the theme and plugins it incorporates to INSTALLED_APPS:

# List of configuration classes / app packages in order of priority (i.e., the
# first item in the list has final say when collisions occur)
INSTALLED_APPS = (
    # Default
#    'django.contrib.admin',
#    'django.contrib.auth',
#    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    # Plugins
    # See https://github.com/open-oni?q=plugin for available plugins
    'onisite.plugins.calendar',
    'onisite.plugins.featured_content',
    'onisite.plugins.map',

    # Open ONI
    'django.contrib.humanize',  # Added to make data more human-readable
    'themes.nebraska',
    'themes.default',
    'core',
)

Title and Project Name

Set the title and project name text for the website

# SITE_TITLE that will be used for display purposes throughout app
# PROJECT_NAME may be the same as SITE_TITLE but can be used
# for longer descriptions that will only show up occasionally
# Example 'Open ONI' for most headers, 'Open Online Newspapers Initiative'
# for introduction / about / further information / etc
SITE_TITLE = "Nebraska Newspapers"
PROJECT_NAME = "Nebraska Newspapers"

Logging

Create symlink at /var/log/openoni to /var/local/www/django/openoni/log

ln -s /var/local/www/django/openoni/log /var/log/openoni

URLs

Set the URLs file to use the theme and plugins it incorporates

vim onisite/urls.py:

from django.urls import include, path, re_path
from onisite.plugins.featured_content import views as fc_views

urlpatterns = [
  # Plugin URLs
  path('', include("onisite.plugins.calendar.urls")),
  re_path(r'^$', views.featured, name="featured_home"),
  re_path(r'^map', include("onisite.plugins.map.urls")),

  # Theme URLs
  path('', include("themes.nebraska.urls")),

  # Open ONI URLs
  path('', include("core.urls")),
]

WSGI Path

vim onisite/wsgi.py:

…
#sys.path.append('/opt/openoni')
sys.path.append('/var/local/www/django/openoni')
…

Compile Static Assets

Run these commands as a regular user rather than root

cd /var/local/www/django/openoni
source ENV/bin/activate

./manage.py collectstatic -c
./manage.py collectstatic --noinput

# Grant write access for both Apache and group
sudo chown -R apache static/compiled/
sudo chmod -R g+w static/compiled/

In production environments, perform a graceful Apache restart after re-compiling static assets so the app uses the updated static file hash fingerprints in the URLs rendered in templates:

sudo apachectl graceful

Load Batches

Instructions for loading batches are available in the README.