djaodjin-deployutils 0.5.17

Deploy webapps running behind djaoapp session manager

DjaoDjin deployutils

This Django app enables a Django project to seamlessly integrate behind the DjaoDjin HTTP session manager reverse proxy. It will replace the default django.contrib.sessions and AUTHENTICATION_BACKENDS to decode sessions forwarded to your Django project by the HTTP session manager.

More technical documentation

Install

Install deployutils into your environment

$ pip install djaodjin-deployutils

Update your settings.py

+from deployutils.configs import load_config

 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+APP_NAME = os.path.basename(BASE_DIR)

+update_settings(sys.modules[__name__],
    load_config(APP_NAME, 'credentials', verbose=True))

 INSTALLED_APPS = (
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+    'deployutils.apps.django',
 )

 MIDDLEWARE_CLASSES = (
     'django.middleware.security.SecurityMiddleware',
-    'django.contrib.sessions.middleware.SessionMiddleware',
+    'deployutils.apps.django.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
 )

+AUTHENTICATION_BACKENDS = (
+    'deployutils.apps.django.backends.auth.ProxyUserBackend',
+)

# Session settings
+SESSION_ENGINE = 'deployutils.apps.django.backends.encrypted_cookies'

+DEPLOYUTILS = {
+    # Hardcoded mockups here.
+    'MOCKUP_SESSIONS': {
+        'donny': {
+          'username': 'donny',
+          'roles': {
+            'manager': [{
+               'slug': 'testsite', 'printable_name': 'Testsite'}]}},
+    },
+    'ALLOWED_NO_SESSION': [
+        STATIC_URL, reverse_lazy('login')]
+}

Create a credentials file that contains the DJAODJIN_SECRET_KEY. (You can also pass DJAODJIN_SECRET_KEY as a shell environment variable.)

$ cat ./credentials
# Authentication for djaodjin firewall
DJAODJIN_SECRET_KEY = "__your_secret_key__"

(for stand-alone testing) Add the mockup views in urls.py

 urlpatterns = [
 ...
+    url(r'^', include('deployutils.apps.django.mockup.urls')),
 ...
 ]

Development

Clone the repository in a virtualenv and install the prerequisites

$ virtualenv _installTop_
$ cd _installTop_
$ source bin/activate
$ git clone https://github.com/djaodjin/djaodjin-deployutils.git
$ cd djaodjin-deployutils
$ pip install -r testsite/requirements.txt

Create the credentials file with a DJAODJIN_SECRET_KEY and the empty db.

$ make initdb

Run the web application

$ python manage.py runserver

Browse to http://localhost:8000

Bonus commands

Commands to upload/download resources

$ python manage.py download_resources
$ python manage.py upload_resources

Not all assets are stored under source control. Images, videos, etc. are better kept outside the git repository. These two commands are used to download the extra resources into the webapp htdocs/ directory from the stage server and upload them from the webapp htdocs/ directory to the stage server respectively.

Commands to setup on deployed servers

$ python manage.py pullapp

Fetch/merge from the remote git repository and downlad the extra resources from the stage server.

Using configuration files from a S3 bucket

$ python manage.py upload_configs --location s3://__example__ credentials site.conf