Tethys Platform
Table Of Contents
Table Of Contents

Tethys Portal Configuration

Beginning in Tethys Platform 3.0 the Tethys Portal is configured via a portal_config.yml file in the $TETHYS_HOME/ directory. This instructions outline the various settings that can be added to the portal_config.yml file.

Once you have installed Tethys you can generate a new portal_config.yml file using the gen command. (See gen command for more information).

tethys gen portal_config

This will create a new portal_config.yml file in your TETHYS_HOME directory that looks like this:

# Portal Level Config File

# For more information about this file refer to the Tethys Docs (http://docs.tethysplatform.org/en/stable/tethys_portal/configuration.html)
version: 2.0
name: 

############################################################################
# APPS
# The "tethys install" command checks this section for app settings.
#############################################################################
apps: {}


############################################################################
# SETTINGS
# Settings from this section are read everytime the Portal starts up.
#############################################################################
settings:
  SECRET_KEY: ...


############################################################################
# SITE SETTINGS
# This section is applied when running the "tethys site -f" command.
#############################################################################
site_settings:
  CUSTOM_STYLES: {}
  CUSTOM_TEMPLATES: {}
  GENERAL_SETTINGS: {}
  HOME_PAGE: {}

Portal Yaml Keys

The following sections describe the keys that can be added to the portal_config.yml file. These first two keys are just metadata and don't affect the portal.

  • version: the version of the portal_config.yml file schema.

  • name: the name of the portal_config.yml.

The next three sections describe different types of settings that allow you to customize the behavior and appearance of your portal. Note that the settings for each section are applied in different ways. The mechanism for applying the settings is noted in a comment at the top of the section in the portal_config.yml file, and will also be described for each section below.

Apps

Tip

This section is applied when running the "tethys install" command. Tethys will first look for app settings in this file. If none are found it will then look for a "services.yml" file in the install location.

Settings

Tethys Portal settings. Note: do not edit the settings.py directly, Instead set any Django setting in this section, even those not listed here.

Tip

You can customize these settings either by manually editing the portal_config.yml file, or by using the settings command.

Caution

The settings command will rewrite the portal_config.yml file each time it is run and will not preserve user-added comments.

Setting

Description

SECRET_KEY

the Django SECRET_KEY setting. Automatically generated if not set, however setting it manually is recommended.

DEBUG

the Django DEBUG setting. Defaults to True.

ALLOWED_HOSTS

the Django ALLOWED_HOSTS setting. Defaults to [].

ADMINS

the Django ADMINS setting.

INSTALLED_APPS

the Django INSTALLED_APPS setting. For convenience, any Django apps listed here will be appended to default list of Django apps required by Tethys. To override INSTALLED_APPS completely, use the INSTALLED_APPS_OVERRIDE setting.

INSTALLED_APPS_OVERRIDE

override for INSTALLED_APPS setting. CAUTION: improper use of this setting can break the Tethys Portal.

MIDDLEWARE

the Django MIDDLEWARE setting. For convenience, any middleware listed here will be appended to default list of middleware required by Tethys. To override MIDDLEWARE completely, use the MIDDLEWARE_OVERRIDE setting.

MIDDLEWARE_OVERRIDE

override for MIDDLEWARE setting. CAUTION: improper use of this setting can break the Tethys Portal.

AUTHENTICATION_BACKENDS

the Django AUTHENTICATION_BACKENDS setting. For convenience, any authentication backends listed here will be appended to default list of authentication backends required by Tethys. To override AUTHENTICATION_BACKENDS completely, use the AUTHENTICATION_BACKENDS_OVERRIDE setting.

AUTHENTICATION_BACKENDS_OVERRIDE

override for AUTHENTICATION_BACKENDS setting. CAUTION: improper use of this setting can break the Tethys Portal.

RESOURCE_QUOTA_HANDLERS

a list of Tethys ResourceQuotaHandler classes to load (see: Tethys Quotas API). For convenience, any quota handlers listed here will be appended to the default list of quota handlerss. To override RESOURCE_QUOTA_HANDLERS completely, use the RESOURCE_QUOTA_HANDLERS_OVERRIDE setting.

RESOURCE_QUOTA_HANDLERS_OVERRIDE

override for RESOURCE_QUOTA_HANDLERS setting. CAUTION: improper use of this setting can break the Tethys Portal.

TETHYS_PORTAL_CONFIG

Setting

Description

ENABLE_OPEN_SIGNUP

anyone can create a Tethys Portal account using a "Sign Up" link on the home page when True. Defaults to False.

REGISTER_CONTROLLER

override the default registration page with a custom controller. The value should be the dot-path to the controller function/class (e.g. tethysext.my_extension.controllers.custom_registration)

ENABLE_OPEN_PORTAL

no login required for Tethys Portal when True. Defaults to False. Controllers in apps need to use the controller decorator from the Tethys SDK, rather than Django's login_required decorator.

ENABLE_RESTRICTED_APP_ACCESS

app access can be restricted based on user object permissions when True. Defaults to False. If ENABLE_OPEN_PORTAL is set to True this setting has no effect. That is, users will have unrestricted access to apps independently of the value of this setting.

TETHYS_WORKSPACES_ROOT

location to which app workspaces will be synced when tethys manage collectworkspaces is executed. Gathering all workspaces to one location is recommended for production deployments to allow for easier updating and backing up of app data. Defaults to <TETHYS_HOME>/workspaces.

STATIC_ROOT

the Django STATIC_ROOT setting. Defaults to <TETHYS_HOME>/static.

STATICFILES_USE_NPM

serves JavaScript dependencies through Tethys rather than using a content delivery network (CDN) when True. Defaults to False. When set to True then you must run tethys gen package_json to npm install the JS dependencies locally so they can be served by Tethys.

SESSION_CONFIG

Setting

Description

SESSION_SECURITY_WARN_AFTER

the Django Session Security WARN_AFTER setting. Defaults to 840 seconds.

SESSION_SECURITY_EXPIRE_AFTER

the Django Session Security EXPIRE_AFTER setting. Defaults to 900 seconds.

DATABASES

See the Django DATABASES setting.

Setting

Description

default

USER

the Django default database USER setting.

PASSWORD

the Django default database PASSWORD setting.

HOST

the Django default database HOST setting.

PORT

the Django default database PORT setting.

DIR

name of psql directory for conda installation of PostgreSQL that ships with Tethys. This directory will be created in the TETHYS_HOME directory when tethys db create is executed. Defaults to "psql". If you are using an external database server then exclude this key or set it to None.

LOGGING

Setting

Description

formatters

override all of the default logging formatters.

handlers

override all of the default logging handlers.

loggers

django

define specific loggers or change the following default loggers:

handlers

override the default handlers for the django logger. Defaults to ['console_simple'].

level

override the default level for the django logger. Defaults to 'WARNING' unless the DJANGO_LOG_LEVEL environment variable is set.

tethys

define specific loggers or change the following default loggers:

handlers

override the default handlers for the tethys logger. Defaults to ['console_verbose'].

level

override the default level for the tethys logger. Defaults to 'INFO'.

tethys.apps

define specific loggers or change the following default loggers:

handlers

override the default handlers for the tethys.apps logger. Defaults to ['console_verbose'].

level

override the default level for the tethys.apps logger. Defaults to 'INFO'.

CAPTCHA_CONFIG

Setting

Description

RECAPTCHA_PRIVATE_KEY

Private key for Google ReCaptcha. Required to enable ReCaptcha on the login screen. See Django Recaptcha 2 Installation.

RECAPTCHA_PUBLIC_KEY

Public key for Google ReCaptcha. Required to enable ReCaptcha on the login screen. See Django Recaptcha 2 Installation.

RECAPTCHA_PROXY_HOST

Proxy host for Google ReCaptcha. Optional. See Django Recaptcha 2 Installation.

OAUTH_CONFIG

Setting

Description

SSO_TENANT_REGEX

A regular expression defining the characters allowed in the Tenant field on the /accounts/tenant/ page. This page is only needed when using Multi-Tenant SSO features. Defaults to "^[ws_-]+$".

SOCIAL_AUTH_AZUREAD_OAUTH2_KEY

Key for authenticating with Azure Active Directory using their OAuth2 service. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET

Secret for authenticating with Azure Active Directory using their OAuth2 service. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_MULTI_TENANT

Define one or more sets of settings for multiple tenants, each indexed by a Tenant Key. See: Azure AD Multi Tenant Setup.

SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY

Key for authenticating with Azure Active Directory against a single Tenant/Active Directory using their OAuth2 service. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET

Secret for authenticating with Azure Active Directory against a single Tenant/Active Directory using their OAuth2 service. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID

The ID of the Tenant/Active Directory to authenticate against. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_MULTI_TENANT

Define one or more sets of settings for multiple tenants, each indexed by a Tenant Key. See: Azure AD Multi Tenant Setup.

SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_KEY

Key for authenticating with Azure Active Directory B2C using their OAuth2 service. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_SECRET

Secret for authenticating with Azure Active Directory B2C using their OAuth2 service. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_TENANT_ID

The ID of the Tenant/Active Directory to authenticate against in Azure Active Directory B2C. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_POLICY

The user flow policy to use. Use 'b2c_' unless you have created a custom user flow that you would like to use. See Azure Active Directory SSO Setup.

SOCIAL_AUTH_ADFS_OIDC_MULTI_TENANT

Define one or more sets of settings for multiple tenants, each indexed by a Tenant Key. See: AD FS Multi Tenant Setup.

SOCIAL_AUTH_ADFS_OIDC_KEY

Client ID for authenticating with an AD FS services using its Open ID Connect interface. See Active Directory Federation Services (AD FS) SSO Setup.

SOCIAL_AUTH_ADFS_OIDC_SECRET

Secret for authenticating with an AD FS service using its Open ID Connect interface. See Active Directory Federation Services (AD FS) SSO Setup.

SOCIAL_AUTH_ADFS_OIDC_DOMAIN

Domain of the AD FS server. See Active Directory Federation Services (AD FS) SSO Setup.

SOCIAL_AUTH_FACEBOOK_KEY

Key for authenticating with Facebook using their OAuth2 service. See Facebook SSO Setup.

SOCIAL_AUTH_FACEBOOK_SECRET

Secret for authenticating with Facebook using their OAuth2 service. See Facebook SSO Setup.

SOCIAL_AUTH_FACEBOOK_SCOPE

List of scopes for authenticating with Facebook using their OAuth2 service. See Facebook SSO Setup.

SOCIAL_AUTH_GOOGLE_OAUTH2_KEY

Key for authenticating with Google using their OAuth2 service. See Google SSO Setup.

SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET

Secret for authenticating with Google using their OAuth2 service. See Google SSO Setup.

SOCIAL_AUTH_HYDROSHARE_KEY

Key for authenticating with HydroShare using their OAuth2 service. See HydroShare SSO Setup.

SOCIAL_AUTH_HYDROSHARE_SECRET

Secret for authentication with HydroShare using their OAuth2 service. See HydroShare SSO Setup.

SOCIAL_AUTH_ARCGIS_KEY

Key for authenticating with ArcGIS Online using their OAuth2 service. See ArcGIS Online or ArcGIS Enterprise Portal SSO Setup.

SOCIAL_AUTH_ARCGIS_SECRET

Secret for authentication with ArcGIS Online using their OAuth2 service. See ArcGIS Online or ArcGIS Enterprise Portal SSO Setup.

SOCIAL_AUTH_ARCGIS_PORTAL_KEY

Key for authenticating with an ArcGIS Enterprise Portal using their OAuth2 service. See ArcGIS Online or ArcGIS Enterprise Portal SSO Setup.

SOCIAL_AUTH_ARCGIS_PORTAL_SECRET

Secret for authentication with an ArcGIS Enterprise Portal using their OAuth2 service. See ArcGIS Online or ArcGIS Enterprise Portal SSO Setup.

SOCIAL_AUTH_ARCGIS_PORTAL_URL

Root URL of the ArcGIS Enterprise Portal that will provide their OAuth2 service. See ArcGIS Online or ArcGIS Enterprise Portal SSO Setup.

SOCIAL_AUTH_LINKEDIN_OAUTH2_KEY

Key for authenticating with LinkedIn using their OAuth2 service. See LinkedIn SSO Setup.

SOCIAL_AUTH_LINKEDIN_OAUTH2_SECRET

Secret for authenticating with LinkedIn using their OAuth2 service. See LinkedIn SSO Setup.

SOCIAL_AUTH_OKTA_OAUTH2_MULTI_TENANT

Define one or more sets of settings for multiple tenants, each indexed by a Tenant Key. See: Okta Multi Tenant Setup.

SOCIAL_AUTH_OKTA_OAUTH2_KEY

Client ID for authenticating with Okta using their OAuth 2 interface. See Okta SSO Setup.

SOCIAL_AUTH_OKTA_OAUTH2_SECRET

Secret for authenticating with Okta using their OAuth 2 interface. See Okta SSO Setup.

SOCIAL_AUTH_OKTA_OAUTH2_API_URL

Your Okta Organization URL. See Okta SSO Setup.

SOCIAL_AUTH_OKTA_OPENIDCONNECT_MULTI_TENANT

Define one or more sets of settings for multiple tenants, each indexed by a Tenant Key. See: Okta Multi Tenant Setup.

SOCIAL_AUTH_OKTA_OPENIDCONNECT_KEY

Client ID for authenticating with Okta using their Open ID Connect interface. See Okta SSO Setup.

SOCIAL_AUTH_OKTA_OPENIDCONNECT_SECRET

Secret for authenticating with Okta using their Open ID Connect interface. See Okta SSO Setup.

SOCIAL_AUTH_OKTA_OPENIDCONNECT_API_URL

Your Okta Organization URL. See Okta SSO Setup.

SOCIAL_AUTH_ONELOGIN_OIDC_MULTI_TENANT

Define one or more sets of settings for multiple tenants, each indexed by a Tenant Key. See: OneLogin Multi Tenant Setup.

SOCIAL_AUTH_ONELOGIN_OIDC_KEY

Client ID for authenticating with OneLogin using their Open ID Connect interface. See OneLogin SSO Setup.

SOCIAL_AUTH_ONELOGIN_OIDC_SECRET

Secret for authenticating with OneLogin using their Open ID Connect interface. See OneLogin SSO Setup.

SOCIAL_AUTH_ONELOGIN_OIDC_SUBDOMAIN

Your OneLogin Subdomain. See OneLogin SSO Setup.

MFA_CONFIG

Setting

Description

ADMIN_MFA_REQUIRED

Are admin (staff) users required to set up MFA when MFA_REQUIRED is True. Defaults to True.

SSO_MFA_REQUIRED

Are users logged in with SSO required to set up MFA when MFA_REQUIRED is True. Defaults to False.

MFA_RECHECK

Allow random rechecking of the user. Defaults to False.

MFA_RECHECK_MIN

Minimum recheck interval in seconds. Defaults to 600 seconds (10 minutes).

MFA_RECHECK_MAX

Maximum recheck interval in seconds. Defaults to 1800 seconds (30 minutes).

MFA_QUICKLOGIN

Allow quick login for returning users by provide only their 2FA. Defaults to False.

TOKEN_ISSUER_NAME

TOTP Issuer name to display in the app. Defaults to Tethys Portal.

MFA_UNALLOWED_METHODS

A list of MFA methods to be disallowed. Valid methods are include U2F, FIDO2, Email, Trusted_Devices, and TOTP. All but TOPT are disabled by default.

ANALYTICS_CONFIG

the Django Analytical configuration settings for enabling analytics services on the Tethys Portal (see: Enabling Services - Django Analytical. The following is a list of settings for some of the supported services that can be enabled.

Setting

Description

CLICKY_SITE_ID

CRAZY_EGG_ACCOUNT_NUMBER

GAUGES_SITE_ID

GOOGLE_ANALYTICS_JS_PROPERTY_ID

GOSQUARED_SITE_TOKEN

HOTJAR_SITE_ID

HUBSPOT_PORTAL_ID

INTERCOM_APP_ID

KISSINSIGHTS_ACCOUNT_NUMBER

KISSINSIGHTS_SITE_CODE

KISS_METRICS_API_KEY

MIXPANEL_API_TOKEN

OLARK_SITE_ID

OPTIMIZELY_ACCOUNT_NUMBER

PERFORMABLE_API_KEY

PIWIK_DOMAIN_PATH

PIWIK_SITE_ID

RATING_MAILRU_COUNTER_ID

SNAPENGAGE_WIDGET_ID

SPRING_METRICS_TRACKING_ID

USERVOICE_WIDGET_KEY

WOOPRA_DOMAIN

YANDEX_METRICA_COUNTER_ID

EMAIL_CONFIG

Setting

Description

EMAIL_HOST

the Django EMAIL_HOST setting.

EMAIL_PORT

the Django EMAIL_PORT setting.

EMAIL_HOST_USER

the Django EMAIL_HOST_USER setting.

EMAIL_HOST_PASSWORD

the Django EMAIL_HOST_PASSWORD setting.

EMAIL_USE_TLS

the Django EMAIL_USE_TLS setting.

DEFAULT_FROM_EMAIL

the Django DEFAULT_FROM_EMAIL setting.

EMAIL_FROM

the email alias setting (e.g.: 'John Smith').

LOCKOUT_CONFIG

the Django Axes configuration settings for enabling lockout capabilities on Tethys Portal (see: Lockout (Optional)). The following is a list of the Django Axes settings that are configured for the default lockout capabilities in Tethys Portal. For a full list of Django Axes settings, see: Django Axes Configuration Documentation.

Setting

Description

AXES_FAILURE_LIMIT

Number of failed login attempts to allow before locking. Default 3.

AXES_COOLOFF_TIME

Time to elapse before locked user is allowed to attempt logging in again. In the portal_config.yml this setting accepts only integers or ISO 8601 time duration formatted strings (e.g.: "PT30M"). Default is 30 minutes.

AXES_ONLY_USER_FAILURES

Only lock based on username and do not lock based on IP when True. Defaults to True.

AXES_ENABLE_ADMIN

Enable the Django Axes admin interface. Defaults to True.

AXES_VERBOSE

More logging for Axes when True. Defaults to True.

AXES_RESET_ON_SUCCESS

Successful login (after the cooloff time has passed) will reset the number of failed logins when True. Defaults to True.

AXES_LOCKOUT_TEMPLATE

Template to render when user is locked out. Defaults to 'tethys_portal/accounts/lockout.html'

AXES_LOGGER

The logger for Django Axes to use. Defaults to 'tethys.watch_login'.

Other Settings

Setting

Description

CHANNEL_LAYERS

the Django Channels CHANNEL_LAYERS setting.

AUTH_PASSWORD_VALIDATORS

the Django AUTH_PASSWORD_VALIDATORS setting.

GUARDIAN_RAISE_403

the Django Guardian GUARDIAN_RAISE_403 setting.

GUARDIAN_RENDER_403

the Django Guardian GUARDIAN_RENDER_403 setting.

GUARDIAN_TEMPLATE_403

the Django Guardian GUARDIAN_TEMPLATE_403 setting.

ANONYMOUS_USER_NAME

the Django Guardian ANONYMOUS_USER_NAME setting.

Note

All of the settings groupings that end in _CONFIG are merely for convenience and organization, but are not necessary. Thus the following two examples are effectively the same:

settings:
  TETHYS_PORTAL_CONFIG:
    BYPASS_TETHYS_HOME_PAGE: False
settings:
  BYPASS_TETHYS_HOME_PAGE: False

Note

You may define any Django Setting as a key under the settings key. Only the most common Django settings are listed above. For a complete reference of Django settings see: Django Settings Reference.

Tip

Settings from this section are read everytime the Portal starts up. If changes are made you will need to restart the portal for the settings to be applied.

Site Settings

The site_settings Portal Yaml Key is used to specify settings related to customization of the portal theme and content. Here is a comprehensive list of the available settings:

Note

New in Tethys 4.0

The site_settings key is new in Tethys 4.0. Previous versions used the site_content key. Additionally, the setting categories were introduced, and the names of several settings were changed to be consistent with the corresponding settings in the Portal Admin pages Administrator Pages.

General Settings

The following settings can be used to modify global features of the site. Access the settings using the Site Settings > General Settings links on the admin pages or under the GENERAL_SETTINGS category in the site_settings section of the portal_config.yml file.

Admin Setting

Portal Config Yaml Key

Site Setting Command Option

Description

Site Title

SITE_TITLE

--site-title

Title of the web page that appears in browser tabs and bookmarks of the site. Default is "Tethys Portal".

Favicon

FAVICON

--favicon

Local or external path to the icon that will display in the browser tab. We recommend storing the favicon in the static directory of tethys_portal. Default is "tethys_portal/images/default_favicon.png".

Brand Text

BRAND_TEXT

--brand-text

Title that appears in the header of the portal. Default is "Tethys Portal".

Brand Image

BRAND_IMAGE

--brand-image

Local or external path to the portal logo. We recommend storing the logo in the static directory of tethys_portal. Default is "tethys_portal/images/tethys-logo-75.png".

Brand Image Height

BRAND_IMAGE_HEIGHT

--brand-image-height

The height of the brand image.

Brand Image Width

BRAND_IMAGE_WIDTH

--brand-image-width

The width of the brand image.

Brand Image Padding

BRAND_IMAGE_PADDING

--brand-image-padding

The padding for the brand image.

Apps Library Title

APPS_LIBRARY_TITLE

--apps-library-title

Title of the page that displays app icons. Default is "Apps".

Primary Color

PRIMARY_COLOR

--primary-color

The primary color for the portal theme. Default is #0a62a9.

Secondary Color

SECONDARY_COLOR

--secondary-color

The secondary color for the portal theme. Default is #7ec1f7.

Primary Text Color

PRIMARY_TEXT_COLOR

--primary-text-color

Color of the text appearing in the headers and footer.

Primary Text Hover Color

PRIMARY_TEXT_HOVER_COLOR

--primary-text-hover-color

Hover color of the text appearing in the headers and footer (where applicable).

Secondary Text Color

SECONDARY_TEXT_COLOR

--secondary-text-color

Color of secondary text on the home page.

Secondary Text Hover Color

SECONDARY_TEXT_HOVER_COLOR

--secondary-text-hover-color

Hover color of the secondary text on the home page.

Background Color

BACKGROUND_COLOR

--background-color

Color of the background on the apps library page and other pages.

Footer Copyright

FOOTER_COPYRIGHT

--footer-copyright

Copyright text that appears in the footer of the portal. Default is "Copyright © 2022 Your Organization".

Home Page Template

HOME_PAGE_TEMPLATE

--home-page-template

Path to alternate Home page template (will replace Home page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Apps Library Template

APPS_LIBRARY_TEMPLATE

--apps-library-template

Path to alternate Apps Library page template (will replace Apps Library page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Login Page Template

LOGIN_PAGE_TEMPLATE

--login-page-template

Path to alternate portal login page template (will replace login page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Register Page Template

REGISTER_PAGE_TEMPLATE

--register-page-template

Path to alternate portal registration (or signup) page template (will replace signup page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

User Page Template

USER_PAGE_TEMPLATE

--user-page-template

Path to alternate user profile page template (will replace user page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

User Settings Page Template

USER_SETTINGS_PAGE_TEMPLATE

--user-settings-page-template

Path to alternate user settings (i.e. edit) page template (will replace settings page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Home Page

The following settings can be used to modify the content on the home page. Access the settings using the Site Settings > Home Page links on the admin pages or under the HOME_PAGE category in the site_settings section of the portal_config.yml file.

Admin Setting

Portal Config Yaml Key

Site Setting Command Option

Description

Hero Text

HERO_TEXT

--hero-text

Text that appears in the hero banner at the top of the home page. Default is "Welcome to Tethys Portal,nthe hub for your apps.".

Blurb Text

BLURB_TEXT

--blurb-text

Text that appears in the blurb banner, which follows the hero banner. Default is "Tethys Portal is designed to be customizable, so that you can host apps for yournorganization. You can change everything on this page from the Home Page settings.".

Feature 1 Heading

FEATURE_1_HEADING

--feature-1-heading

Heading for 1st feature highlight (out of 3).

Feature 1 Body

FEATURE_1_BODY

--feature-1-body

Body text for the 1st feature highlight.

Feature 1 Image

FEATURE_1_IMAGE

--feature-1-image

Path or url to image for the 1st feature highlight.

Feature 2 Heading

FEATURE_2_HEADING

--feature-2-heading

Heading for 2nd feature highlight (out of 3).

Feature 2 Body

FEATURE_2_BODY

--feature-2-body

Body text for the 2nd feature highlight.

Feature 2 Image

FEATURE_2_IMAGE

--feature-2-image

Path or url to image for the 2nd feature highlight.

Feature 3 Heading

FEATURE_3_HEADING

--feature-3-heading

Heading for 3rd feature highlight (out of 3).

Feature 3 Body

FEATURE_3_BODY

--feature-3-body

Body text for the 3rd feature highlight.

Feature 3 Image

FEATURE_3_IMAGE

--feature-3-image

Path or url to image for the 3rd feature highlight.

Call To Action

CALL_TO_ACTION

--call-to-action

Text that appears in the call to action banner at the bottom of the page (only visible when user is not logged in). Default is "Ready to get started?".

Call To Action Button

CALL_TO_ACTION_BUTTON

--call-to-action-button

Text that appears on the call to action button in the call to action banner (only visible when user is not logged in). Default is "Start Using Tethys!".

For more advanced customization, you may use the Custom Styles and Custom Template options to completely replace the Home Page or Apps Library page CSS and HTML.

Custom Styles

The following settings can be used to add additional CSS to the Home page, Apps Library page, and portal-wide. Access the settings using the Site Settings > Custom Styles links on the admin pages or under the CUSTOM_STYLES category in the site_settings section of the portal_config.yml file.

Admin Setting

Portal Config Yaml Key

Site Setting Command Option

Description

Portal Base Css

PORTAL_BASE_CSS

--portal-base-css

CSS code to modify the Tethys Portal Base Page, which extends most of the portal pages (i.e. Home, Login, Developer, Admin, etc.). Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

Home Page Css

HOME_PAGE_CSS

--home-page-css

CSS code to modify the Tethys Portal Home Page. Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

Apps Library Css

APPS_LIBRARY_CSS

--apps-library-css

CSS code to modify the Tethys Portal Apps Library. Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

Accounts Base Css

ACCOUNTS_BASE_CSS

--accounts-base-css

CSS code to modify the base template for all of the accounts pages (e.g. login, register, change password, etc.). Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

Login Css

LOGIN_CSS

--login-css

CSS code to modify the Portal Login page. Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

Register Css

REGISTER_CSS

--register-css

CSS code to modify the Portal Registration page. Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

User Base Css

USER_BASE_CSS

--user-base-css

CSS code to modify the base template for all of the user profile pages (e.g. user, settings, manage storage). Takes or straight CSS code or a file path available through Tethys static files, such as in a Tethys app, Tethys extension, or Django app.

Custom Templates

The following settings can be used to override the templates for the Home page and Apps Library page. Access the settings using the Site Settings > Custom Templates links on the admin pages or under the CUSTOM_TEMPLATES category in the site_settings section of the portal_config.yml file..

Admin Setting

Portal Config Yaml Key

Site Setting Command Option

Description

Home Page Template

HOME_PAGE_TEMPLATE

--home-page-template

Path to alternate Home page template (will replace Home page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Apps Library Template

APPS_LIBRARY_TEMPLATE

--apps-library-template

Path to alternate Apps Library page template (will replace Apps Library page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Login Page Template

LOGIN_PAGE_TEMPLATE

--login-page-template

Path to alternate portal login page template (will replace login page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Register Page Template

REGISTER_PAGE_TEMPLATE

--register-page-template

Path to alternate portal registration (or signup) page template (will replace signup page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

User Page Template

USER_PAGE_TEMPLATE

--user-page-template

Path to alternate user profile page template (will replace user page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

User Settings Page Template

USER_SETTINGS_PAGE_TEMPLATE

--user-settings-page-template

Path to alternate user settings (i.e. edit) page template (will replace settings page template entirely). The template must be located within a valid templates directory, such as in a Tethys app, Tethys extension, or Django app.

Tip

Settings from this section are read when running the "tethys site -f" command. Note that the "-f" flag indicates that site settings should be applied from this file.

Note

All of the site settings can also be modified through the Administrator Pages.

Example Portal Config File

# Portal Level Config File

# For more information about this file refer to the Tethys Docs (http://docs.tethysplatform.org/en/stable/tethys_portal/configuration.html)
version: 2.0
name: Tethys Main Portal

############################################################################
# APPS
# The "tethys install" command checks this section for app settings.
#############################################################################
apps:
  my_first_app:
    services:
      persistent:
        catalog_db: test
      spatial:
      dataset:
      wps:
      custom_settings:

############################################################################
# SETTINGS
# Settings from this section are read everytime the Portal starts up.
#############################################################################
settings:
  SECRET_KEY: 'gij28v16WhZ4v18WtlHqusP5VYnVUslxEvRQoXLj7hvJ2ZRN7f'
  DEBUG: True
  ALLOWED_HOSTS: []
  ADMINS: []
  TETHYS_PORTAL_CONFIG:
    BYPASS_TETHYS_HOME_PAGE: False
    ENABLE_OPEN_SIGNUP: False
    ENABLE_OPEN_PORTAL: False
    ENABLE_RESTRICTED_APP_ACCESS: False
    #  REGISTER_CONTROLLER: ''
    #  STATIC_ROOT: ''
    #  TETHYS_WORKSPACES_ROOT: ''
    #  STATICFILES_USE_NPM: True

  SESSION_CONFIG:
    EXPIRE_AT_BROWSER_CLOSE: True
    SECURITY_WARN_AFTER: 840
    SECURITY_EXPIRE_AFTER: 900

  DATABASES:
    default:
      NAME: tethys_platform
      USER: tethys_default
      PASSWORD: pass
      HOST: localhost
      PORT:  5436
      DIR: psql

  LOGGING_CONFIG:
    TETHYS_LOGGING:
      handlers:
        - console_verbose
      level: INFO
    TETHYS_APPS_LOGGING:
      handlers:
        - console_verbose
      level: INFO
    LOGGING_FORMATTERS: {}
    LOGGING_HANDLERS: {}
    LOGGERS: {}

  #  INSTALLED_APPS_OVERRIDE: []
  INSTALLED_APPS: []

  #  MIDDLEWARE_OVERRIDE: []
  MIDDLEWARE: []

  #  AUTHENTICATION_BACKENDS_OVERRIDE: []
  AUTHENTICATION_BACKENDS: []

  #  RESOURCE_QUOTA_HANDLERS_OVERRIDE: []
  RESOURCE_QUOTA_HANDLERS: []

  CAPTCHA_CONFIG:
    ENABLE_CAPTCHA: False
    RECAPTCHA_PRIVATE_KEY: ''
    RECAPTCHA_PUBLIC_KEY: ''
    #  RECAPTCHA_PROXY_HOST: https://recaptcha.net

  #  OAUTH_CONFIG:
  #    SOCIAL_AUTH_GOOGLE_OAUTH2_KEY: ''
  #    SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET: ''
  #
  #    SOCIAL_AUTH_FACEBOOK_KEY: ''
  #    SOCIAL_AUTH_FACEBOOK_SECRET: ''
  #    SOCIAL_AUTH_FACEBOOK_SCOPE: ['email']
  #
  #    SOCIAL_AUTH_LINKEDIN_OAUTH2_KEY: ''
  #    SOCIAL_AUTH_LINKEDIN_OAUTH2_SECRET: ''
  #
  #    SOCIAL_AUTH_HYDROSHARE_KEY: ''
  #    SOCIAL_AUTH_HYDROSHARE_SECRET: ''
  #
  #    SOCIAL_AUTH_ARCGIS_KEY: ''
  #    SOCIAL_AUTH_ARCGIS_SECRET: ''
  #
  #    SOCIAL_AUTH_ARCGIS_PORTAL_KEY: ''
  #    SOCIAL_AUTH_ARCGIS_PORTAL_SECRET: ''
  #    SOCIAL_AUTH_ARCGIS_PORTAL_URL: ''

  #  ANALYTICS_CONFIG:
  #    CLICKMAP_TRACKER_ID: False
  #    CLICKY_SITE_ID: False
  #    CRAZY_EGG_ACCOUNT_NUMBER: False
  #    GAUGES_SITE_ID: False
  #    GOOGLE_ANALYTICS_JS_PROPERTY_ID: False
  #    GOSQUARED_SITE_TOKEN: False
  #    HOTJAR_SITE_ID: False
  #    HUBSPOT_PORTAL_ID: False
  #    INTERCOM_APP_ID: False
  #    KISSINSIGHTS_ACCOUNT_NUMBER: False
  #    KISSINSIGHTS_SITE_CODE: False
  #    KISS_METRICS_API_KEY: False
  #    MIXPANEL_API_TOKEN: False
  #    OLARK_SITE_ID: False
  #    OPTIMIZELY_ACCOUNT_NUMBER: False
  #    PERFORMABLE_API_KEY: False
  #    PIWIK_DOMAIN_PATH: False
  #    PIWIK_SITE_ID: False
  #    RATING_MAILRU_COUNTER_ID: False
  #    SNAPENGAGE_WIDGET_ID: False
  #    SPRING_METRICS_TRACKING_ID: False
  #    USERVOICE_WIDGET_KEY: False
  #    WOOPRA_DOMAIN: False
  #    YANDEX_METRICA_COUNTER_ID: False

  #  EMAIL_CONFIG:
  #    EMAIL_BACKEND: 'django.core.mail.backends.smtp.EmailBackend'
  #    EMAIL_HOST: 'localhost'
  #    EMAIL_PORT: 25
  #    EMAIL_HOST_USER: ''
  #    EMAIL_HOST_PASSWORD: ''
  #    EMAIL_USE_TLS: False
  #    DEFAULT_FROM_EMAIL: 'Example <noreply@exmaple.com>'

  #  CHANNEL_LAYERS:
  #    default:
  #      BACKEND: channels.layers.InMemoryChannelLayer

  # Password validation
  # https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
  #  AUTH_PASSWORD_VALIDATORS:
  #    - NAME: django.contrib.auth.password_validation.UserAttributeSimilarityValidator
  #    - NAME: django.contrib.auth.password_validation.MinimumLengthValidator
  #    - NAME: django.contrib.auth.password_validation.CommonPasswordValidator
  #    - NAME: django.contrib.auth.password_validation.NumericPasswordValidator

  # Django Guardian Settings
  #   GUARDIAN_RAISE_403: False  # Mutually exclusive with GUARDIAN_RENDER_403
  #   GUARDIAN_RENDER_403: False  # Mutually exclusive with GUARDIAN_RAISE_403
  #   GUARDIAN_TEMPLATE_403: ''
  #   ANONYMOUS_DEFAULT_USERNAME_VALUE: 'anonymous'

############################################################################
# SITE SETTINGS
# This section is applied when running the "tethys site -f" command.
#############################################################################
site_settings:
  GENERAL_SETTINGS:
    SITE_TITLE:
    FAVICON:
    BRAND_TEXT:
    BRAND_IMAGE:
    BRAND_IMAGE_HEIGHT:
    BRAND_IMAGE_WIDTH:
    BRAND_IMAGE_PADDING:
    APPS_LIBRARY_TITLE:
    PRIMARY_COLOR:
    SECONDARY_COLOR:
    BACKGROUND_COLOR:
    PRIMARY_TEXT_COLOR:
    PRIMARY_TEXT_HOVER_COLOR:
    SECONDARY_TEXT_COLOR:
    SECONDARY_TEXT_HOVER_COLOR:
    FOOTER_COPYRIGHT:
  HOME_PAGE:
    HERO_TEXT:
    BLURB_TEXT:
    FEATURE_1_HEADING:
    FEATURE_1_BODY:
    FEATURE_1_IMAGE:
    FEATURE_2_HEADING:
    FEATURE_2_BODY:
    FEATURE_2_IMAGE:
    FEATURE_3_HEADING:
    FEATURE_3_BODY:
    FEATURE_3_IMAGE:
    CALL_TO_ACTION:
    CALL_TO_ACTION_BUTTON:
  CUSTOM_STYLES:
    PORTAL_BASE_CSS:
    HOME_PAGE_CSS:
    APPS_LIBRARY_CSS:
    ACCOUNTS_BASE_CSS:
    LOGIN_CSS:
    REGISTER_CSS:
    USER_BASE_CSS:
  CUSTOM_TEMPLATES:
    HOME_PAGE_TEMPLATE:
    APPS_LIBRARY_TEMPLATE:
    LOGIN_PAGE_TEMPLATE:
    REGISTER_PAGE_TEMPLATE:
    USER_PAGE_TEMPLATE: