Skip to content

Commit

Permalink
Merge pull request #62 from unt-libraries/update-installation-docs
Browse files Browse the repository at this point in the history
Update the installation docs.
  • Loading branch information
damonkelley committed Feb 9, 2016
2 parents eab9266 + 88c0cb3 commit 87569e1
Showing 1 changed file with 21 additions and 34 deletions.
55 changes: 21 additions & 34 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ We'll elaborate a bit in this section.
Dependencies
============

- Python 2.6+ (not Python 3)
- Django (Tested on 1.6.1, at least 1.3 or higher required)
- lxml (Ubuntu/Debian users should ``apt-get build-dep python-lxml`` first)
- Python 2.7.x
- Django 1.8
- libxml2-dev libxslt-dev
- Django Admin - ``django.contrib.admin``

Important security warning
==========================
Expand All @@ -26,47 +27,33 @@ Instead, use a network firewall to whitelist the server to authorized clients,
or use a web server configuration directive (such as Apache's
``<LimitExcept GET>``) to set up who is allowed to POST/PUT/DELETE events.

Before you begin
================

The instructions below assume that you have a Django project already created.
If you don't, you can create one using the "django-admin.py startproject"
command (in an environment where Django has been installed). The specifics
of where and how you create your project will depend on your specific hosting
preferences and needs. Some understanding of WSGI hosting and Python virtual
environments is highly recommended before going forward.

Install
=======

To install this package, do **one (1)** of the following:
1. Install the package. ::

$ pip install django-premis-event-service

- Place the ``premis_event_service`` folder in your Django project directory
(alongside the ``manage.py`` file)
- Place the ``premis_event_service`` folder somewhere in your PYTHON_PATH
- Install using: pip install <path to django-premis-event-service>
(activate your Django virtualenv before running)
.. - Install from PyPI using: pip install django-premis-event-service
.. (activate your Django virtualenv before running) (NOT YET AVAILABLE)

Quick start
===========
2. Add ``premis_event_service`` to your ``INSTALLED_APPS``. Be sure to add ``django.contrib.admin`` if it is not already present. ::

1. Follow the Mandatory Configuration instructions in :doc:`configuration`.
INSTALLED_APPS = (
'django.contrib.admin',
# ...
'premis_event_service',
)

2. Include the event service URLconf in your project ``urls.py`` like this (do
not modify this line -- this app must be served from top-level URLs for
in its current state)::
4. Include the URLs. ::

url(r'', include('premis_event_service.urls')),
urlpatterns = [
url(r'', include('premis_event_service.urls'))
# ...
url(r'^admin/', include(admin.site.urls)),
]

3. Run ``python manage.py syncdb`` to create the event service models. If
asked to create a superuser account, follow the prompts to do so. You will
need at least one superuser account.

4. Start the development server using: ``python manage.py runserver``
5. Migrate the database. ::

5. Visit http://127.0.0.1:8000/admin/ in a web browser and log in using your
superuser credentials.
$ python manage.py migrate

6. Continue to :doc:`administration` to begin setting up Agents.

0 comments on commit 87569e1

Please sign in to comment.