PWNurl: url shortening service

Table of Contents

Main Features

• TODO

Installation

The latest stable version can always be installed or updated to via pip:

$ pip install --upgrade pwnurl

The latest development version can be installed directly from GitHub:

$ pip install --upgrade https://github.com/donovan-duplessis/pwnurl/tarball/master

Configuration

You need to set the PWNURL_SETTINGS environment variable to point to the configuration file:

$ export PWNURL_SETTINGS=~/.pwnurlrc

The following configuration parameters are vailable:

Parameter	Description
HOST name=string	Hostname or ip address to bind server on e.g. HOST = '0.0.0.0'
PORT name=integer	Port number to bin server on e.g. PORT = 5001
SECRET_KEY name=sring	Secret application key/token e.g. SECRET_KEY = 'yU2Tz4PVMVWlDNceFuH'
CACHE_TYPE name=string,	Caching implementation (simpleredis) e.g. CACHE_TYPE = 'simple'
SQLALCHEMY_DATABASE_URI name=string	Database connection string e.g. SQLALCHEMY_DATABASE_URI = 'sqlite:////tmp/pwnurl.db'

Usage

Initialize Database:

$ pwnurl db upgrade

Compile Web Assets:

$ pwnurl assets clean
$ pwnurl assets build

Start Gunicorn Server:

$ pwnurl gunicorn [--daemon]

Stop Gunicorn Server:

$ kill -TERM `cat /tmp/pwnurl.pid`

Authors

Donovan du Plessis (@binarytrooper)

Licence

Please see LICENSE.

---