Adding setup instructions to the quickstart docs.

Implements blueprint horizon-dev-setup-doc-update.

Change-Id: I0d16a5db7b8b7b670e76a99792f744e6ff0e00a2
This commit is contained in:
Tres Henry 2011-11-08 09:25:35 -08:00
parent 74c07b0455
commit 00a3832886
2 changed files with 30 additions and 1 deletions

2
README
View File

@ -28,7 +28,7 @@ For issue tracking:
Project Structure and Testing:
------------------------------
This project is a bit different from other Openstack projects in that it has
This project is a bit different from other OpenStack projects in that it has
two very distinct components underneath it: ``horizon``, and
``openstack-dashboard``.

View File

@ -2,6 +2,35 @@
Horizon Quickstart
==================
Setup
=====
To setup an Horizon development environment simply clone the Horizon git
repository at http://github.com/openstack/horizon and execute the
``run_tests.sh`` script from the root folder (see :doc:`ref/run_tests`).
Horizon assumes a single end-point for OpenStack services which defaults to
the local host (127.0.0.1). If this is not the case change the
``OPENSTACK_HOST`` setting in the ``local_settings.py`` file, located in the
``openstack-dashboard/local`` folder, to the actual IP address of the
OpenStack end-point Horizon should use.
To start the Horizon development server use the Django ``manage.py`` utility
from the ``openstack-dashboard`` directory with the context of the virtual
environment::
> tools/with_venv.sh dashboard/manage.py runserver
Alternately specify the listen IP and port::
> tools/with_venv.sh dashboard/manage.py runserver 0.0.0.0:8080
Once the Horizon server is running point a web browser to http://localhost:8000
or to the IP and port the server is listening.
note:: The ``DevStack`` project (http://devstack.org/) can be used to install
an OpenStack development environment from scratch.
Horizon's Structure
===================