LogdeIt, a Pastebin service
Go to file
David Pursehouse 236d157efc Add a .mailmap file
Makes the output of git shortlog look better, for example when
running:

 git shortlog -n -c -s

And makes the annotation in git blame look better.

Initial version only includes names that could be found either
in the repository itself or Google searches.

Change-Id: I95a40e0a6d793037371909e1db6faa04c3cf735b
2016-02-26 15:23:37 +09:00
clientlib [svn] added license informations to lodgeit pastebin and finished open sourceing the package 2006-12-15 22:37:06 +01:00
editors/vim vim plugin: add vim plugin that targets openstack 2015-12-02 17:15:08 +01:00
lodgeit Merge "Update i18n files to remove unused translations" 2016-02-26 02:05:39 +00:00
scripts Add tox configuration to enable PEP-8 checks, and fix various failures 2015-11-17 19:09:23 +09:00
tests Fix up the tests and add tox configuration to run them 2015-11-24 13:33:00 +09:00
.gitignore Ignore the virtualenv folder and Eclipse's settings files. 2015-11-17 19:09:23 +09:00
.gitreview Updated .gitreview location 2012-12-16 10:41:25 -08:00
.mailmap Add a .mailmap file 2016-02-26 15:23:37 +09:00
babel.ini Added javascript support in babel 2008-09-14 13:44:48 +02:00
lodgeit.wsgi Import make_app from lodgeit.application instead of lodgeit 2015-11-27 07:31:39 +00:00
Makefile added missing files 2008-07-08 11:20:20 +02:00
manage.py Minimal fixes and cleanup. 2010-07-16 23:13:44 +02:00
README Fix minor typo in README 2016-01-26 11:08:00 +01:00
requirements.txt Add pytz and MarkupSafe into requirements.txt 2015-11-27 10:15:32 +01:00
test-requirements.txt Fix up the tests and add tox configuration to run them 2015-11-24 13:33:00 +09:00
TODO Fix misspellings in lodgeit 2014-02-08 10:39:12 +08:00
tox.ini Fix up the tests and add tox configuration to run them 2015-11-24 13:33:00 +09:00

==============
LodgeIt Readme
==============

Lodgeit implements a pastebin and some scripts to paste the service.


Installation
~~~~~~~~~~~~

LodgeIt requires at least Python 2.5 to work correctly. Next to this LodgeIt has
quite a few of dependencies as well as a nice bootstrap process. This is documented
on the following slides.

Dependencies and virtual environment
====================================

To get LodgeIt work properly we need those dependencies: Python (at least 2.5),
python-setuptools and git.

For Ubuntu (or any Debian based distribution) use ``aptitude`` to install::

    aptitude install python-dev python-setuptools python-virtualenv git

Now we can install LodgeIt. But first we need to clone LodgeIt from the
git repository. To do that you create a new folder ``lodgeit-dev`` in your
projects directory and change into it. There we initialize the virtual
environment and clone LodgeIt::

    git clone https://git.openstack.org/openstack-infra/lodgeit

Right before we can initialize the virtual environment we need to install some
development packages to compile the python imaging library.

For Ubuntu again ``aptitude`` (as root)::

    sudo aptitude install build-essential
    apt-get build-dep python-imaging

Now it's possible to install the virtual environment. This is done with a simple
Python command::

    # assumed that you are located in lodgeit-dev/lodgeit
    python scripts/make-bootstrap.py > ../bootstrap.py
    cd ..
    # make sure that the virtualenv is not activated. If yes, execute `deactivate`
    python bootstrap.py .

You are ready to run now.

Database and other things
=========================

We are now ready to enter the virtual environment (assumed you are located in
``lodgeit-dev/lodgeit``)::

    . ../bin/activate

LodgeIt initializes it's database per default on /tmp/lodgeit.db, you can change
that path in the manage.py by modifying ``dburi``.

Now start the development server::

    python manage.py runserver

Enjoy!