Tethys Platform
Table Of Contents
Table Of Contents

site command

Customize the theme and content of the Tethys Portal.

usage: tethys site [-h] [--tab-title TAB_TITLE] [--favicon FAVICON]
                   [--title TITLE] [--logo LOGO] [--logo-height LOGO_HEIGHT]
                   [--logo-width LOGO_WIDTH] [--logo-padding LOGO_PADDING]
                   [--library-title LIBRARY_TITLE]
                   [--primary-color PRIMARY_COLOR]
                   [--secondary-color SECONDARY_COLOR]
                   [--background-color BACKGROUND_COLOR]
                   [--text-color TEXT_COLOR]
                   [--text-hover-color TEXT_HOVER_COLOR]
                   [--secondary-text-color SECONDARY_TEXT_COLOR]
                   [--secondary-text-hover-color SECONDARY_TEXT_HOVER_COLOR]
                   [--copyright FOOTER_COPYRIGHT] [--hero-text HERO_TEXT]
                   [--blurb-text BLURB_TEXT]
                   [--feature1-heading FEATURE1_HEADING]
                   [--feature1-body FEATURE1_BODY]
                   [--feature1-image FEATURE1_IMAGE]
                   [--feature2-heading FEATURE2_HEADING]
                   [--feature2-body FEATURE2_BODY]
                   [--feature2-image FEATURE2_IMAGE]
                   [--feature3-heading FEATURE3_HEADING]
                   [--feature3-body FEATURE3_BODY]
                   [--feature3-image FEATURE3_IMAGE]
                   [--action-text ACTION_TEXT] [--action-button ACTION_BUTTON]
                   [--restore-defaults] [-f FROM_FILE]

Named Arguments

--tab-title

A double quoted string with the title that will display in the browser tab. Default is "Tethys Portal".

--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".

--title

A double quoted string with the title of the portal. Default is "Tethys Portal".

--logo

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".

--logo-height

The height of the portal logo.

--logo-width

The width of the portal logo.

--logo-padding

The padding for the portal logo.

--library-title

A double quoted string with the Title for the Apps library. Default is "Apps Library".

--primary-color

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

--secondary-color

The secondary color for the portal. Default is #1b95dc.

--background-color

The background color for the portal.

--text-color

The primary text color for the portal.

--text-hover-color

The hover text color for the portal.

--secondary-text-color

The secondary text color for the portal.

--secondary-text-hover-color

The secondary hover text color for the portal.

--copyright

A double quoted string with the Footer copyright for the portal. Default is "Copyright © 2019 Your Organization".

--hero-text

A double quoted string with the hero text to display in the portal home. Default is "Welcome to Tethys Portal, the hub for your apps.".

--blurb-text

A double quoted string with the blurb text to display in the portal home. Default is "Tethys Portal is designed to be customizable, so that you can host apps for your organization. You can change everything on this page from the Home Page settings.".

--feature1-heading

A double quoted string with the heading for display feature number 1 out 3.

--feature1-body

A double quoted string with the content for display feature number 1 out 3.

--feature1-image

A double quoted string with an image for display feature number 1 out 3.

--feature2-heading

A double quoted string with the heading for display feature number 2 out 3.

--feature2-body

A double quoted string with the content for display feature number 2 out 3.

--feature2-image

A double quoted string with an image for display feature number 2 out 3.

--feature3-heading

A double quoted string with the heading for display feature number 3 out 3.

--feature3-body

A double quoted string with the content for display feature number 3 out 3.

--feature3-image

A double quoted string with an image for display feature number 3 out 3.

--action-text

A double quoted string with the call to action text that will display in the portal. Default is "Ready to get started?".

--action-button

A double quoted string for the call to action button. Default is "Start Using Tethys!".

--restore-defaults

Restores the sites default values.

Default: False

-f, --from-file

Load site content from portal_config.yml file.

Default: True

Table Of Contents