LogdeIt, a Pastebin service
Go to file
Takeshi Kanemoto 3bb4544b26 Import make_app from lodgeit.application instead of lodgeit
The commit that fixes PEP-8 errors removed the possibility to
import make_app from lodgeit as a shorthand. This breaks lodgeit.wsgi,
while manage.py works fine as it imports make_app from
lodgeit.application directly.

Fix lodgeit.wsgi so that it imports make_app from lodgeit.application
instead, making it more consistent with manage.py.

Ref: fbb61e9c1d
Change-Id: Ic4dfc118712d2c88886416af0e5ad003b8af017d
2015-11-27 07:31:39 +00:00
clientlib [svn] added license informations to lodgeit pastebin and finished open sourceing the package 2006-12-15 22:37:06 +01:00
lodgeit Replace XXX with TODO 2015-11-17 19:09:23 +09:00
scripts Add tox configuration to enable PEP-8 checks, and fix various failures 2015-11-17 19:09:23 +09:00
tests Add tox configuration to enable PEP-8 checks, and fix various failures 2015-11-17 19:09:23 +09:00
.gitignore Add tox configuration to enable PEP-8 checks, and fix various failures 2015-11-17 19:09:23 +09:00
.gitreview Updated .gitreview location 2012-12-16 10:41:25 -08: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 Correct command to start server in README 2015-10-01 11:24:04 +09:00
requirements.txt Add a requirements.txt file 2015-04-20 14:14:54 +09:00
test-requirements.txt Add tox configuration to enable PEP-8 checks, and fix various failures 2015-11-17 19:09:23 +09:00
TODO Fix misspellings in lodgeit 2014-02-08 10:39:12 +08:00
tox.ini Add tox configuration to enable PEP-8 checks, and fix various failures 2015-11-17 19:09:23 +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 modifiing ``dburi``.

Now start the development server::

    python manage.py runserver

Enjoy!