Configuration¶

We use superdesk.core.get_app_config, so to use it do:

from superdesk.core import get_app_config

print(get_app_config("SERVER_DOMAIN"))

Configuration is combination of default settings module and settings module in application repo.

Default settings¶

`APPLICATION_NAME`¶

Default: 'Superdesk'

`CLIENT_URL`¶

Default: 'http://localhost:9000'

`DEFAULT_TIMEZONE`¶

Default: None

Superdesk will try to guess the value from system if not set.

`FTP_TIMEOUT`¶

Default: 300

This is used for all ftp operations. Increase if you get ftp timeout errors.

`INSTALLED_APPS`¶

Default: []

You can install additional modules by adding their names here.

`MODULES`¶

Added in version 3.0.0.

Default: []

You can install additional modules by adding their names here.

`CONTENT_EXPIRY_MINUTES`¶

Changed in version 1.5: Change default value to 0.

Default: 0

By default content will not expire.

`ARCHIVED_EXPIRY_MINUTES`¶

Added in version 1.34.

Default: 0

`PUBLISHED_CONTENT_EXPIRY_MINUTES`¶

Default: 0

It applies only to published content if the value is greater than 0 and it overrides the desk/stage content expiry settings. If PUBLISHED_CONTENT_EXPIRY_MINUTES is set to 0 then the content is expired based on the content expiry settings for that desk/stage.

`INGEST_EXPIRY_MINUTES`¶

Default: 2880 (2 days)

`SPIKE_EXPIRY_MINUTES`¶

Default: None

Will use value from CONTENT_EXPIRY_MINUTES when empty.

`MAX_VALUE_OF_INGEST_SEQUENCE`¶

Default: 9999

`MAX_VALUE_OF_PUBLISH_SEQUENCE`¶

Default: 9999

`DEFAULT_SOURCE_VALUE_FOR_MANUAL_ARTICLES`¶

Default: 'Superdesk'

Changed in version 1.8: Change default value to 'Superdesk'.

`DEFAULT_PRIORITY_VALUE_FOR_MANUAL_ARTICLES`¶

Default: 6

`DEFAULT_URGENCY_VALUE_FOR_MANUAL_ARTICLES`¶

Default: 3

`DEFAULT_GENRE_VALUE_FOR_MANUAL_ARTICLES`¶

Default: [{'qcode': 'Article', 'name': 'Article (news)'}]

`RESET_PRIORITY_VALUE_FOR_UPDATE_ARTICLES`¶

Default: False

`NEWSML_PROVIDER_ID`¶

Default: 'sourcefabric.org'

`ORGANIZATION_NAME`¶

Default: 'Your organisation'

Changed in version 1.8: Change default value to 'Your organisation'.

`ORGANIZATION_NAME_ABBREVIATION`¶

Default: 'Short name for your organisation'

Changed in version 1.8: Change default value to 'Short name for your organisation'.

`MAX_TRANSMIT_RETRY_ATTEMPT`¶

Default: 10

Max retries attemps when transmitting an item.

`TRANSMIT_RETRY_ATTEMPT_DELAY_MINUTES`¶

Default: 3

Delay between retry attempts.

`MAX_TRANSMIT_QUERY_LIMIT`¶

Default: 500

Max transmit items to be fetched from mongo at once.

`ODBC_PUBLISH`¶

Default: None

Determines if the ODBC publishing mechanism will be used. If enabled then pyodbc must be installed along with its dependencies.

Mongo connections¶

There are multiple connections by default, so that it can use different instances for legal archive and production content.

For each there is _DBNAME and _URI setting, if _URI is set it will be used as is, if not it will use localhost as server and _DBNAME as db.

`MONGO_DBNAME`¶

Default: 'superdesk'

`MONGO_URI`¶

Default: 'mongodb://localhost/superdesk'

`LEGAL_ARCHIVE_DBNAME`¶

Default: 'legal_archive'

`LEGAL_ARCHIVE_URI`¶

Default: 'mongodb://localhost/legal_archive'

`ARCHIVED_DBNAME`¶

Default: 'archived'

`ARCHIVED_URI`¶

Default: mongodb://localhost/archived'

Elastic settings¶

`ELASTICSEARCH_URL`¶

Default: 'http://localhost:9200'

`ELASTICSEARCH_INDEX`¶

Default: 'superdesk'

Redis settings¶

`REDIS_URL`¶

Default: 'redis://localhost:6379'

Cache settings¶

`CACHE_URL`¶

Default: 'redis://localhost:6379'

Added in version 1.3.

Celery settings¶

`BROKER_URL`¶

Default: 'redis://localhost:6379'

`CELERY_WORKER_CONCURRENCY`¶

Default: None

If not set it will be the number of CPUs available.

`HIGH_PRIORITY_QUEUE_ENABLED`¶

Added in version 1.31.

Default: False

When enabled you can toggle subscriber priority and those with high priority will use dedicated celery queue for transmissions. This should be only enabled when you have dedicated worker running:

$ celery -A worker worker -Q publish_priority

Monitoring settings¶

`SENTRY_DSN`¶

Default: None

LDAP settings¶

Used for LDAP based authentication, if not configured it will use mongodb for credentials.

`LDAP_SERVER`¶

Default: ''

`LDAP_SERVER_PORT`¶

Default: 389

`LDAP_FQDN`¶

Default: ''

`LDAP_BASE_FILTER`¶

Default: ''

`LDAP_USER_FILTER`¶

Default: '(&(objectCategory=user)(objectClass=user)(sAMAccountName={}))'

`LDAP_USER_ATTRIBUTES`¶

Default:

{
    'givenName': 'first_name',
    'sn': 'last_name',
    'ipPhone': 'phone',
    'mail': 'email',
    'displayName': 'display_name'
}

Media settings¶

`MEDIA_PREFIX`¶

Default: ''

Uses for generation of media url (<media_prefix>/<media_id>):

# if it's empty (default value) uses something like
'http://<host>/api/upload-raw'

# serve directly from AMAZON S3
'https://<bucket>.s3-<region>.amazonaws.com/<subfolder>'

# save relative urls to database
'/media-via-nginx'
# or using api view
'/api/upload-raw'

Amazon S3 settings¶

`AMAZON_ACCESS_KEY_ID`¶

Default: ''

`AMAZON_SECRET_ACCESS_KEY`¶

Default: ''

`AMAZON_REGION`¶

Default: 'us-east-1'

`AMAZON_CONTAINER_NAME`¶

Default: ''

`AMAZON_S3_SUBFOLDER`¶

Default: ''

`AMAZON_OBJECT_ACL`¶

Default: ''

Security settings¶

`SESSION_EXPIRY_MINUTES`¶

Default: 240

The number of minutes since the last update of the Mongo auth object after which it will be deleted.

`RESET_PASSWORD_TOKEN_TIME_TO_LIVE`¶

Default: 1

The number of days a token is valid, env RESET_PASS_TTL.

`ACTIVATE_ACCOUNT_TOKEN_TIME_TO_LIVE`¶

Default: 7

The number of days an activation token is valid, env ACTIVATE_TTL.

`SECRET_KEY`¶

Added in version 1.5.

Changed in version 2.4: Now required as flask.session will be used for some authentication

Default: Hardcoded value, which should not be used in production!

This value should be set to a unique, unpredictable value. It is used for auth token signing.

Email settings¶

`MAIL_SERVER`¶

Default: 'localhost'

`MAIL_PORT`¶

Default: 25

`MAIL_USE_TLS`¶

Default: False

`MAIL_USE_SSL`¶

Default: False

`MAIL_USERNAME`¶

Default: ''

`MAIL_PASSWORD`¶

Default: ''

`MAIL_DEFAULT_SENDER`¶

Default: 'superdesk@localhost'

`ADMINS`¶

Default: ['']

Content API Settings¶

Added in version 1.5.

CONTENTAPI_URL

Default: localhost:5400

Content API URL. Set this when running api behind a proxy.

`CONTENT_API_ENABLED`¶

Default: True

Set to false to disable publishing to Content API.

`CONTENT_API_EXPIRY_DAYS`¶

Default: 0

Define after how many days items expire in content api. When set to 0 no items will be removed.

`CONTENTAPI_MONGO_DBNAME`¶

Default: contentapi

`CONTENTAPI_MONGO_URI`¶

Default: mongodb://localhost/contentapi

`CONTENTAPI_ELASTICSEARCH_URL`¶

Default: http://localhost:9200

`CONTENTAPI_ELASTICSEARCH_INDEX`¶

Default: contentapi

Google OAuth Settings¶

Added in version 1.8.

`GOOGLE_CLIENT_ID`¶

Default: ''

`GOOGLE_CLIENT_SECRET`¶

Default: ''

SAML Auth Settings¶

Added in version 1.9.

`SAML_PATH`¶

Default: None

`SAML_LABEL`¶

Default: 'Single Sign On'

Label on auth button for SAML.

OpenID Connect Auth Settings¶

Added in version 2.1.

`OIDC_ENABLED`¶

Default: False

`OIDC_ISSUER_URL`¶

Default: http://localhost:8080/auth/realms/SUPERDESK_REALM

Issuer URL address

`OIDC_SERVER_CLIENT`¶

Keycloak client name with access type is confidential

`OIDC_SERVER_CLIENT_SECRET`¶

Keycloak server client secret

`OIDC_WEB_CLIENT`¶

Keycloak client name with access type is public

`OIDC_BROWSER_REDIRECT_URL`¶

Default: CLIENT_URL

Redirect URL for successful authentication with Keycloak

Schema and Editor¶

Added in version 1.9.

Allows updating schema and editor settings for item types text, picture and composite.

`SCHEMA`¶

Default: {}

Example:

SCHEMA = {
    'composite': {
        'headline': {'type': 'text', 'required': True, 'maxlength': 200},
        ...
    }
}

`EDITOR`¶

Default: {}

Example:

EDITOR = {
    'composite': {
        'headline': {'order': 1, formatOptions: ['bold']},
        ...
    }
}

`OVERRIDE_EDNOTE_FOR_CORRECTIONS`¶

Default: True

Set to False to disable editor note overriding on correction.

`OVERRIDE_EDNOTE_TEMPLATE`¶

Default: None

Template to use to override editor note (ignored if OVERRIDE_EDNOTE_FOR_CORRECTIONS is False). If not set, default template will be used. In your template, you can use {date} to insert current date or {slugline} for slugline.

Example:

OVERRIDE_EDNOTE_FOR_CORRECTIONS = True
OVERRIDE_EDNOTE_TEMPLATE = 'Story "{slugline}" corrected on {date}'

`ALLOW_UPDATING_SCHEDULED_ITEMS`¶

Default: None

Set to True to allow updating the schedule items.

`GEONAMES_USERNAME`¶

Added in version 1.20.

Default: None

When configured it will enable /places_autocomplete service and client will use it for place field searching.

Other¶

KEYWORDS_ADD_MISSING_ON_PUBLISH = False[source]¶: Add missing keywords to keywords vocabulary when item is published

Added in version 2.0.

WORKFLOW_ALLOW_MULTIPLE_UPDATES = False[source]¶

Allow creating multiple updates in production

By default there can be only 1 update in progress for a story, when enable there is no limit and multiple updates can be created. It will still validate on publish if the previous ones are published and not let publishing out of sequence.

Added in version 2.0.

ARCHIVE_AUTOCOMPLETE = False[source]¶

Enable archive autocomplete API

Added in version 2.0.

It will return suggestions for field from archive api, only from published items for time defined via ARCHIVE_AUTOCOMPLETE_DAYS and ARCHIVE_AUTOCOMPLETE_HOURS.

ARCHIVE_AUTOCOMPLETE_DAYS = 0[source]¶: Added in version 2.0.

ARCHIVE_AUTOCOMPLETE_HOURS = 0[source]¶: Added in version 2.0.

LINKS_MAX_HOURS = 0[source]¶

Define for how many hours in the past it shoudl return links for.

Set to 0 to disable time limit.

Added in version 1.34.

Extend Superdesk¶

Additional settings which are allowed to change some Superdesk defaults

SCHEMA_UPDATE

Default: None

Allows to update a default schema.

Example:

SCHEMA_UPDATE = {
    'archive': {
        'extra': {
            'type': 'dict',
            'schema': {},
            'mapping': {
                'type': 'object',
                'enabled': True
            },
            'allow_unknown': True,
        }
    }
}

Video server settings¶

`VIDEO_SERVER_URL`¶

Default: http://localhost:5050

Video server API url.

`VIDEO_SERVER_ENABLED`¶

Default: False

Enable video server.

Publish System Config¶

`PUBLISH_EXCHANGE_FACTORY`¶

Default: "superdesk.publish_async.exchanges:DefaultPublishExchangeFactory"

Module path to use for the PublishExchangeFactory.

`PUBLISH_MODULES`¶

List of modules to load into the publishing system. In each module it looks for a publish_components variable, which provides a list of classes, which are then registered with the PublishExchangeFactory.

Default:

[
    "superdesk.publish_async.exchanges",
    "superdesk.publish_async.filters",
    "superdesk.publish_async.formatters",
    "superdesk.publish_async.routers",
    "superdesk.publish_async.consumers",
]

`PUBLISH_CHANNELS`¶

When an item is sent to the PublishExchangeFactory for publishing, the factory determines which PublishExchange to use, and which associated PublishExchangeFilter, PublishExchangeFormatter and PublishExchangeRouter to use.

The factory will iterate over the entries in the PUBLISH_CHANNELS config, matching the PublishRequest to the channel config, and use that to construct an instance of PublishExchange.

class PublishChannelConfig[source]¶

A dict to define list of filters and PublishExchange config to use

config: ExchangeConfig¶: Config for the PublishExchange that matches this channel

filter: Callable[[dict], bool]¶: Function used for custom filtering based on the item to be published

item_types: list[str]¶: List of item types to match

operations: list[str]¶: List of PublishProducer actions to match

sender_types: list[str]¶: List of PublishSenderType’s to match One of api, ingest_rule, macro or internal

class ExchangeConfig[source]¶

A dict to define a PublishExchange config

exchange: str¶: Name of a registered PublishExchange to use

filter: str¶: Name of a registered PublishExchangeFilter to use

formatter: str¶: Name of a registered PublishExchangeFormatter to use

polling: bool¶: If True will set the published item queue_state to pending, for the celery beat schedule to pick it up (used in content based exchanges only)

router: str¶: Name of a registered PublishExchangeRouter to use

Default Channel:

ExchangeConfig(
    exchange="default",
    filter="default",
    formatter="default",
    router="celery",
    polling=True,
)

DefaultClasses:

exchange: superdesk.publish_async.exchanges.BasicPublishExchange
filter: superdesk.publish_async.filters.BasePublishExchangeFilter
formatter: superdesk.publish_async.formatters.BasePublishExchangeFormatter
router: superdesk.publish_async.routers.CeleryPublishRouter

Default:

[{
    "operations": ["resend"],
    "config": ExchangeConfig(
        filter="resend",
    ),
},
{
    "operations": ["correct"],
    "config": ExchangeConfig(
        exchange="content",
        filter="content:corrected",
    ),
},
{
    "operations": ["kill", "takedown"],
    "config": ExchangeConfig(
        exchange="content",
        filter="content:content:killed",
    ),
},
{
    # If the request is coming from the Web API and has no associations
    # then we can handle this publish request via asyncio (aka instant publishing)
    "item_types": ["text", "preformatted"],
    "sender_types": ["api"],
    "filter": lambda item: not len(item.get("associations") or {}),
    "config": ExchangeConfig(
        exchange="content",
        filter="content",
        router="asyncio",
    ),
},
{
    # If the request is coming from the Web API and has no associations
    # then we can handle this publish request via asyncio (aka instant publishing)
    "item_types": ["text", "preformatted"],
    "config": ExchangeConfig(
        exchange="content",
        filter="content",
    ),
},
{
    "item_types": ["composite"],
    "config": ExchangeConfig(
        exchange="content",
    ),
},
{
    "item_types": ["audio", "video", "picture", "graphic"],
    "config": ExchangeConfig(
        exchange="content",
        router="celery",
        polling=True,
    ),
},
{
    "sender_types": ["api"],
    "config": ExchangeConfig(
        router="asyncio",
    ),
},
{
    "sender_types": ["ingest_rule"],
    "config": ExchangeConfig(
        router="celery",
        polling=True,
    ),
}]

Configuration¶

Default settings¶

APPLICATION_NAME¶

CLIENT_URL¶

DEFAULT_TIMEZONE¶

FTP_TIMEOUT¶

INSTALLED_APPS¶

MODULES¶

CONTENT_EXPIRY_MINUTES¶

ARCHIVED_EXPIRY_MINUTES¶

PUBLISHED_CONTENT_EXPIRY_MINUTES¶

INGEST_EXPIRY_MINUTES¶

SPIKE_EXPIRY_MINUTES¶

MAX_VALUE_OF_INGEST_SEQUENCE¶

MAX_VALUE_OF_PUBLISH_SEQUENCE¶

DEFAULT_SOURCE_VALUE_FOR_MANUAL_ARTICLES¶

DEFAULT_PRIORITY_VALUE_FOR_MANUAL_ARTICLES¶

DEFAULT_URGENCY_VALUE_FOR_MANUAL_ARTICLES¶

DEFAULT_GENRE_VALUE_FOR_MANUAL_ARTICLES¶

RESET_PRIORITY_VALUE_FOR_UPDATE_ARTICLES¶

NEWSML_PROVIDER_ID¶

ORGANIZATION_NAME¶

ORGANIZATION_NAME_ABBREVIATION¶

MAX_TRANSMIT_RETRY_ATTEMPT¶

TRANSMIT_RETRY_ATTEMPT_DELAY_MINUTES¶

MAX_TRANSMIT_QUERY_LIMIT¶

ODBC_PUBLISH¶

Mongo connections¶

MONGO_DBNAME¶

MONGO_URI¶

LEGAL_ARCHIVE_DBNAME¶

LEGAL_ARCHIVE_URI¶

ARCHIVED_DBNAME¶

ARCHIVED_URI¶

Elastic settings¶

ELASTICSEARCH_URL¶

ELASTICSEARCH_INDEX¶

Redis settings¶

REDIS_URL¶

Cache settings¶

CACHE_URL¶

Celery settings¶

BROKER_URL¶

CELERY_WORKER_CONCURRENCY¶

HIGH_PRIORITY_QUEUE_ENABLED¶

Monitoring settings¶

SENTRY_DSN¶

LDAP settings¶

LDAP_SERVER¶

LDAP_SERVER_PORT¶

LDAP_FQDN¶

LDAP_BASE_FILTER¶

LDAP_USER_FILTER¶

LDAP_USER_ATTRIBUTES¶

Media settings¶

MEDIA_PREFIX¶

Amazon S3 settings¶

AMAZON_ACCESS_KEY_ID¶

AMAZON_SECRET_ACCESS_KEY¶

AMAZON_REGION¶

AMAZON_CONTAINER_NAME¶

AMAZON_S3_SUBFOLDER¶

AMAZON_OBJECT_ACL¶

Security settings¶

SESSION_EXPIRY_MINUTES¶

RESET_PASSWORD_TOKEN_TIME_TO_LIVE¶

ACTIVATE_ACCOUNT_TOKEN_TIME_TO_LIVE¶

SECRET_KEY¶

Email settings¶

MAIL_SERVER¶

MAIL_PORT¶

MAIL_USE_TLS¶

MAIL_USE_SSL¶

MAIL_USERNAME¶

MAIL_PASSWORD¶

MAIL_DEFAULT_SENDER¶

ADMINS¶

Content API Settings¶

CONTENT_API_ENABLED¶

CONTENT_API_EXPIRY_DAYS¶

`APPLICATION_NAME`¶

`CLIENT_URL`¶

`DEFAULT_TIMEZONE`¶

`FTP_TIMEOUT`¶

`INSTALLED_APPS`¶

`MODULES`¶

`CONTENT_EXPIRY_MINUTES`¶

`ARCHIVED_EXPIRY_MINUTES`¶

`PUBLISHED_CONTENT_EXPIRY_MINUTES`¶

`INGEST_EXPIRY_MINUTES`¶

`SPIKE_EXPIRY_MINUTES`¶

`MAX_VALUE_OF_INGEST_SEQUENCE`¶

`MAX_VALUE_OF_PUBLISH_SEQUENCE`¶

`DEFAULT_SOURCE_VALUE_FOR_MANUAL_ARTICLES`¶

`DEFAULT_PRIORITY_VALUE_FOR_MANUAL_ARTICLES`¶

`DEFAULT_URGENCY_VALUE_FOR_MANUAL_ARTICLES`¶

`DEFAULT_GENRE_VALUE_FOR_MANUAL_ARTICLES`¶

`RESET_PRIORITY_VALUE_FOR_UPDATE_ARTICLES`¶

`NEWSML_PROVIDER_ID`¶

`ORGANIZATION_NAME`¶

`ORGANIZATION_NAME_ABBREVIATION`¶

`MAX_TRANSMIT_RETRY_ATTEMPT`¶

`TRANSMIT_RETRY_ATTEMPT_DELAY_MINUTES`¶

`MAX_TRANSMIT_QUERY_LIMIT`¶

`ODBC_PUBLISH`¶

`MONGO_DBNAME`¶

`MONGO_URI`¶

`LEGAL_ARCHIVE_DBNAME`¶

`LEGAL_ARCHIVE_URI`¶

`ARCHIVED_DBNAME`¶

`ARCHIVED_URI`¶

`ELASTICSEARCH_URL`¶

`ELASTICSEARCH_INDEX`¶

`REDIS_URL`¶

`CACHE_URL`¶

`BROKER_URL`¶

`CELERY_WORKER_CONCURRENCY`¶

`HIGH_PRIORITY_QUEUE_ENABLED`¶

`SENTRY_DSN`¶

`LDAP_SERVER`¶

`LDAP_SERVER_PORT`¶

`LDAP_FQDN`¶

`LDAP_BASE_FILTER`¶

`LDAP_USER_FILTER`¶

`LDAP_USER_ATTRIBUTES`¶

`MEDIA_PREFIX`¶

`AMAZON_ACCESS_KEY_ID`¶

`AMAZON_SECRET_ACCESS_KEY`¶

`AMAZON_REGION`¶

`AMAZON_CONTAINER_NAME`¶

`AMAZON_S3_SUBFOLDER`¶

`AMAZON_OBJECT_ACL`¶

`SESSION_EXPIRY_MINUTES`¶

`RESET_PASSWORD_TOKEN_TIME_TO_LIVE`¶

`ACTIVATE_ACCOUNT_TOKEN_TIME_TO_LIVE`¶

`SECRET_KEY`¶

`MAIL_SERVER`¶

`MAIL_PORT`¶

`MAIL_USE_TLS`¶

`MAIL_USE_SSL`¶

`MAIL_USERNAME`¶

`MAIL_PASSWORD`¶

`MAIL_DEFAULT_SENDER`¶

`ADMINS`¶

`CONTENT_API_ENABLED`¶

`CONTENT_API_EXPIRY_DAYS`¶

`CONTENTAPI_MONGO_DBNAME`¶

`CONTENTAPI_MONGO_URI`¶

`CONTENTAPI_ELASTICSEARCH_URL`¶

`CONTENTAPI_ELASTICSEARCH_INDEX`¶

`GOOGLE_CLIENT_ID`¶

`GOOGLE_CLIENT_SECRET`¶

`SAML_PATH`¶

`SAML_LABEL`¶

`OIDC_ENABLED`¶

`OIDC_ISSUER_URL`¶

`OIDC_SERVER_CLIENT`¶

`OIDC_SERVER_CLIENT_SECRET`¶

`OIDC_WEB_CLIENT`¶

`OIDC_BROWSER_REDIRECT_URL`¶