openstack/horizon
Code Issues Proposed changes
Files
aa0f0ebc18080f98f11673b0c0892c7b459e5060
horizon/doc/source/topics/install.rst
Akihiro Motoki aa0f0ebc18 Add install guide for users and clean up README 
* Add "Using Horizon" section to the docs, which describes
  how to install and configure Horizon. It is for operators
  who install Horizon from source code.
* Clean up README.rst as much of the information is out-of-date
  and most of it is covered by the developer docs.
* Minor update of page titles.

Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-09 03:29:26 +09:00

2.6 KiB
Raw Blame History

Installing Horizon

This page covers the basic installation of Horizon.

System Requirements

  • Python 2.7 (or 2.6)
  • Django 1.6 (1.4 and 1.5 are supported too)
  • Minimum required set of running OpenStack services are:
    • Nova
    • Keystone
    • Glance
    • Neutron (unless nova-network is used)
  • All other services are optional. Horizon supports the following services in Juno release. If Keystone endpoint for a service is configured, Horizon detects it and enables its support automatically.
    • Swift
    • Cinder
    • Heat
    • Ceilometer
    • Trove
    • Sahara

Installation

  1. Compile translation message catalogs for internationalization. This step is not required if you do not need to support languages other than English. GNU gettext tool is required to compile message catalogs:

    $ sudo apt-get install gettext
$ ./run_tests.sh --compilemessages

    This command compiles translation message catalogs within Python virtualenv named .venv. After this step, you can remove .venv directory safely.

  2. Install Horizon python module into your system. Run the following in the top directory.:

    $ sudo pip install .

  3. Create openstack_dashboard/local/local_settings.py. It is usually a good idea to copy openstack_dashboard/local/local_settings.py.example and edit it. At least we need to customize the following variables in this file.

    • ALLOWED_HOSTS (unless DEBUG is True)
    • OPENSTACK_KEYSTONE_URL

    For more details, please refer to deployment and settings.

  4. Set up a web server with WSGI support. It is optional but recommended in production deployments. For example, install Apache web server on Ubuntu:

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

    Then configure the web server to host OpenStack Dashboard via WSGI. For apache2 web server, you may need to create /etc/apache2/site-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

  5. Finally, enable the above configuration and restart the web server.:

    $ sudo a2ensite horizon
$ sudo service apache2 restart

Next Steps

  • deployment covers some common questions, concerns and pitfalls you may encounter when deploying Horizon in a production environment.
  • settings lists the available settings for Horizon.
  • customizing describes how to customizing Horizon as you want.
View Git Blame Copy Permalink