OpenStack Dashboard (Horizon)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Julie Pichon 96c6cdaa08 Fix XSS issue with the unordered_list filter 8 years ago
.tx Update Transifex resource name for havana 9 years ago
doc Release notes for the Havana release 9 years ago
horizon Fix multiple Cross-Site Scripting (XSS) vulnerabilities 9 years ago
openstack_dashboard Fix XSS issue with the unordered_list filter 8 years ago
tools Import install_venv from oslo 9 years ago
.gitignore Added openstack_dashboard/local/.secret_key_store to .gitignore. 10 years ago
.gitreview Open stable/havana 9 years ago
.mailmap remove 'import *' usage (or mark is #noqa) 9 years ago
.pylintrc updating to mimic other openstack projects, pep8, pylint, coverage 11 years ago
HACKING.rst Add HACKING.rst 10 years ago
LICENSE Initial commit 12 years ago Drop NodeJS dependency in favor of pure-python lesscpy 9 years ago
Makefile Unifies the project packaging into one set of modules. 11 years ago
README.rst Drop NodeJS dependency in favor of pure-python lesscpy 9 years ago Delete and launch devices on the topology view 9 years ago
openstack-common.conf Import install_venv from oslo 9 years ago
requirements.txt Updated from global requirements 9 years ago Add extra extension file to makemessage command line 9 years ago
setup.cfg Bump stable/havana next version to 2013.2.4 9 years ago Updated from global requirements 9 years ago
test-requirements.txt Update test-requirements to fix sphinx build_doc 9 years ago
tox.ini PEP8 E126 has been resolved 9 years ago


Horizon (OpenStack Dashboard)

Horizon is a Django-based project aimed at providing a complete OpenStack Dashboard along with an extensible framework for building new dashboards from reusable components. The openstack_dashboard module is a reference implementation of a Django site that uses the horizon app to provide web-based interactions with the various OpenStack projects.

For release management:

For blueprints and feature specifications:

For issue tracking:

Getting Started

For local development, first create a virtualenv for the project. In the tools directory there is a script to create one for you:

$ python tools/

Alternatively, the script will also install the environment for you and then run the full test suite to verify everything is installed and functioning correctly.

Now that the virtualenv is created, you need to configure your local environment. To do this, create a file in the openstack_dashboard/local/ directory. There is a file there that may be used as a template.

If all is well you should able to run the development server locally:

$ tools/ runserver

or, as a shortcut:

$ ./ --runserver

Settings Up OpenStack

The recommended tool for installing and configuring the core OpenStack components is Devstack. Refer to their documentation for getting Nova, Keystone, Glance, etc. up and running.


The minimum required set of OpenStack services running includes the following:

  • Nova (compute, api, scheduler, network, and volume services)
  • Glance
  • Keystone

Optional support is provided for Swift.


For development, start with the getting started instructions above. Once you have a working virtualenv and all the necessary packages, read on.

If dependencies are added to either horizon or openstack-dashboard, they should be added to requirements.txt.

The script invokes tests and analyses on both of these components in its process, and it is what Jenkins uses to verify the stability of the project. If run before an environment is set up, it will ask if you wish to install one.

To run the unit tests:

$ ./

Building Contributor Documentation

This documentation is written by contributors, for contributors.

The source is maintained in the doc/source folder using reStructuredText and built by Sphinx

  • Building Automatically:

    $ ./ --docs
  • Building Manually:

    $ export DJANGO_SETTINGS_MODULE=local.local_settings
    $ python doc/
    $ sphinx-build -b html doc/source build/sphinx/html

Results are in the build/sphinx/html directory