Simple URL shortener for intranet/personal use.

Requirements
==============================================================================
Shurl runs on [Flask](http://flask.pocoo.org) with the support of
[wtforms](wtforms.readthedocs.org) and [flask-WTF](https://flask-wtf.readthedocs.org/).
It uses sqlite3 as default database, however it's fairly easy to change it
to something else since the queries it performs are very simple. As usual,
patches are welcome.


Installation instructions
==============================================================================

1. Create a python virtual environment with virtualenv:

        virtualenv ENV

2. Activate the newly created virtual environment:

        source ENV/bin/activate

3. Install dependencies:

        pip install -r PIP_REQUIREMENTS

4. Use either apache2 configured with mod\_wsgi:

        <VirtualHost *:80>
          [...your configuration here...]
          WSGIDaemonProcess shurl user=www-data group=www-data threads=3
          WSGIScriptAlias / /path/to/shurl/shurl.wsgi
          <Directory /path/to/shurl>
            WSGIProcessGroup shurl
            WSGIApplicationGroup %{GLOBAL}
            Order deny,allow
            Allow from all
          </Directory>
        </VirtualHost>

   Or run it through gunicorn:

        gunicorn shurl:app

5. If you didn't use `ENV` as the name for the python's virtual environment,
   change it in `shurl.wsgi`

![Screenshot](https://raw.githubusercontent.com/kratorius/shurl/master/screenshot.png)


License
==============================================================================

This software is distributed under the BSD license. See the LICENSE file
for more informations.

Simple URL shortener for intranet/personal use.

Requirements
==============================================================================
Shurl runs on [Flask](http://flask.pocoo.org) with the support of
[wtforms](wtforms.readthedocs.org) and [flask-WTF](https://flask-wtf.readthedocs.org/).
It uses sqlite3 as default database, however it's fairly easy to change it
to something else since the queries it performs are very simple. As usual,
patches are welcome.


Installation instructions
==============================================================================

1. Create a python virtual environment with virtualenv:

        virtualenv ENV

2. Activate the newly created virtual environment:

        source ENV/bin/activate

3. Install dependencies:

        pip install -r PIP_REQUIREMENTS

4. Use either apache2 configured with mod\_wsgi:

        <VirtualHost *:80>
          [...your configuration here...]
          WSGIDaemonProcess shurl user=www-data group=www-data threads=3
          WSGIScriptAlias / /path/to/shurl/shurl.wsgi
          <Directory /path/to/shurl>
            WSGIProcessGroup shurl
            WSGIApplicationGroup %{GLOBAL}
            Order deny,allow
            Allow from all
          </Directory>
        </VirtualHost>

   Or run it through gunicorn:

        gunicorn shurl:app

5. If you didn't use `ENV` as the name for the python's virtual environment,
   change it in `shurl.wsgi`


Screenshot
==============================================================================

![Screenshot](https://raw.githubusercontent.com/kratorius/shurl/master/screenshot.png)


License
==============================================================================

This software is distributed under the BSD license. See the LICENSE file
for more informations.

Embed the screenshot in its own section
Embed the screenshot in its own section
