Installation and Setup

Install the packages below to get started. Globus Portal Framework requires Python 3.7 and higher.

pip install django-admin django-globus-portal-framework

Django-admin will help you bootstrap your initial portal while Globus Portal Framework will add tooling for Globus services, Search, Transfer, and Auth.

Run the django-admin command below to create your project layout.

django-admin startproject myportal
cd myportal

This will create your basic Django project with the following project structure:

myportal/
  db.sqlite3
  manage.py
  myportal/
    settings.py
    urls.py

Globus Auth

Globus Auth will allow your users to login to the portal, storing their tokens in the database for Search, Transfer, or any other custom functionality you want to implement.

You’ll need a Client ID from Globus. Follow these instructions from the Globus Auth Developer Guide.

When you register your application with Globus, make sure it has the following settings:

Redirect URL – http://localhost:8000/complete/globus/
Native App – Unchecked

Settings

Next, you will need to modify your myportal/settings.py file to enable user auth and Globus Portal Framework components. You can copy-paste the individual settings below, or use our Settings Example for a complete settings.py file reference.

# Your portal credentials for a Globus Auth Flow
SOCIAL_AUTH_GLOBUS_KEY = 'Put your Client ID here'
SOCIAL_AUTH_GLOBUS_SECRET = 'Put your Client Secret Here'

# This is a general Django setting if views need to redirect to login
# https://docs.djangoproject.com/en/3.2/ref/settings/#login-url
LOGIN_URL = '/login/globus'

# This dictates which scopes will be requested on each user login
SOCIAL_AUTH_GLOBUS_SCOPE = [
    'urn:globus:auth:scope:search.api.globus.org:search',
]

# Installed apps tells Django which packages to load on startup
INSTALLED_APPS = [
    ...
    'globus_portal_framework',
    'social_django',
]

# Middleware provides exception handling
MIDDLEWARE = [
    ...
    'globus_portal_framework.middleware.ExpiredTokenMiddleware',
    'globus_portal_framework.middleware.GlobusAuthExceptionMiddleware',
    'social_django.middleware.SocialAuthExceptionMiddleware',
]

# Authentication backends setup OAuth2 handling and where user data should be
# stored
AUTHENTICATION_BACKENDS = [
    'globus_portal_framework.auth.GlobusOpenIdConnect',
    'django.contrib.auth.backends.ModelBackend',
]

# The context processor below provides some basic context to all templates
TEMPLATES = [
  {
      'BACKEND': 'django.template.backends.django.DjangoTemplates',
      'DIRS': [],
      'APP_DIRS': True,
      'OPTIONS': {
          'context_processors': [
              ...
              'globus_portal_framework.context_processors.globals',
          ],
      },
  },
]

Add the base URLs for Globus Portal Framework in your myportal/urls.py file. These will provide a starting point for your Globus Portal. You may keep or discard any existing paths in your urlpatterns.

from django.urls import path, include

urlpatterns = [
    # Provides the basic search portal
    path('', include('globus_portal_framework.urls')),
    # Provides Login urls for Globus Auth
    path('', include('social_django.urls', namespace='social')),
]

Now run your server to see your Globus Portal. Migrate will setup your database, which will be used in the next section when adding Globus Auth. The second command will run your Globus Portal.

Note

Make sure you use http://localhost:8000 in your browser, so your URL matches the callback URL for your Globus App at developers.globus.org. A mismatch will cause an error when logging in.

python manage.py migrate
python manage.py runserver localhost:8000

You should now be able to view a portal at http://localhost:8000/