lodgeit

LogdeIt, a Pastebin service

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Clark Boylan cc2728f1a3 Drop python 3.6 testing Python 3.6 is sufficiently old at this point that we don't need to keep testing on it. This will reduce the number of things we need to tend and care for with this application and service. Change-Id: Iadea5270f54631ef72a68a37073fd8d337bc4c5c		6 months ago
clientlib	[svn] added license informations to lodgeit pastebin and finished open sourceing the package	17 years ago
editors/vim	vim plugin: add vim plugin that targets openstack	8 years ago
lodgeit	new paste: check input length	1 year ago
scripts	Merge "Fix sort comparison function"	3 years ago
tests	Modernize test suite	6 months ago
.gitignore	Modernize test suite	6 months ago
.gitreview	OpenDev Migration Patch	4 years ago
.mailmap	Add a .mailmap file	7 years ago
.stestr.conf	Modernize test suite	6 months ago
.zuul.yaml	Drop python 3.6 testing	6 months ago
Dockerfile	Update uwsgi image to python 3.10	6 months ago
Makefile	added missing files	15 years ago
README	Allow for overriding title	2 years ago
TODO	Fix misspellings in lodgeit	9 years ago
babel.ini	Added javascript support in babel	15 years ago
bindep.txt	Add libc6-dev to bindep and pin Pygments for 2.7	3 years ago
lodgeit.wsgi	Import make_app from lodgeit.application instead of lodgeit	8 years ago
manage.py	Fix PEP-8 errors	6 years ago
requirements.txt	Skip deprecated lexers (Pygments 2.7.3 and later)	2 years ago
setup.cfg	Drop python 3.6 testing	6 months ago
setup.py	Upload container images	3 years ago
test-requirements.txt	Modernize test suite	6 months ago
tox.ini	Drop python 3.6 testing	6 months ago

README

==============
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://opendev.org/opendev/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!

Environment Settings
====================

LODGEIT_TITLE_OVERRIDE : <string>
  Arbitrary string to override the main heading for site customisation