Manual installation¶

System Requirements¶

• Python 2.7
• Django 1.8
• An accessible keystone endpoint
• All other services are optional. Horizon supports the following services as of the Pike release. If the keystone endpoint for a service is configured, horizon detects it and enables its support automatically.
  • cinder: Block Storage
  • glance: Image Management
  • heat: Orchestration
  • neutron: Networking
  • nova: Compute
  • swift: Object Storage
  • Horizon also supports many other OpenStack services via plugins. For more information, see the Plugin Registry.

Installation¶

1. Clone Horizon

   $ git clone https://git.openstack.org/openstack/horizon -b stable/<release> --depth=1
   $ cd horizon
   

2. Install the horizon python module into your system

   $ sudo pip install -c http://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/<release> .
   

Configuration¶

This section contains a small summary of the critical settings required to run horizon. For more details, please refer to Settings Reference.

$ sudo apt-get install gettext
$ ./manage.py compilemessages

$ ./manage.py collectstatic
$ ./manage.py compress

SESSION_ENGINE = 'django.contrib.sessions.backends.cache'
CACHES = {
    'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache'
    'LOCATION': 'my_memcached_host:11211',
}

SESSION_ENGINE = 'django.core.cache.backends.db.DatabaseCache'
DATABASES = {
    'default': {
        # Database configuration here
    }
}

SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"

Deployment¶

1. Set up a web server with WSGI support. For example, install Apache web server on Ubuntu

   $ sudo apt-get install apache2 libapache2-mod-wsgi
   

   You can either use the provided openstack_dashboard/wsgi/django.wsgi or generate a openstack_dashboard/wsgi/horizon.wsgi file with the following command (which detects if you use a virtual environment or not to automatically build an adapted WSGI file)

   $ ./manage.py make_web_conf --wsgi
   

   Then configure the web server to host OpenStack dashboard via WSGI. For apache2 web server, you may need to create /etc/apache2/sites-available/horizon.conf. The template in DevStack is a good example of the file. http://git.openstack.org/cgit/openstack-dev/devstack/tree/files/apache-horizon.template Or, if you previously generated an openstack_dashboard/wsgi/horizon.wsgi you can automatically generate an apache configuration file

   $ ./manage.py make_web_conf --apache > /etc/apache2/sites-available/horizon.conf
   

   Same as above but if you want SSL support

   $ ./manage.py make_web_conf --apache --ssl --sslkey=/path/to/ssl/key --sslcert=/path/to/ssl/cert > /etc/apache2/sites-available/horizon.conf
   

   By default the apache configuration will launch a number of apache processes equal to the number of CPUs + 1 of the machine on which you launch the make_web_conf command. If the target machine is not the same or if you want to specify the number of processes, add the --processes option

   $ ./manage.py make_web_conf --apache --processes 10 > /etc/apache2/sites-available/horizon.conf
   

2. Enable the above configuration and restart the web server

   $ sudo a2ensite horizon
   $ sudo service apache2 restart
   

Next Steps¶

• Settings Reference lists the available settings for horizon.
• Customizing Horizon describes how to customize horizon.