Skip to main content

H5P Config

The default value is displayed together with the .env setting name. If getting or setting the value from PHP, use the config() function and the config key.

H5P_OVERRIDE_DISABLE_SETTING

Show or hide the footer when displaying the H5P. The footer contains buttons for 'Embed', 'Reuse', 'Rights of use' and link to h5p.org. The display of the individual buttons may depend on other settings.

.env
H5P_OVERRIDE_DISABLE_SETTING=false
Config key
h5p.overrideDisableSetting
Allowed values
true  => Footer is not displayed
false => Footer is displayed

H5P_DEFAULT_EXPORT_OPTION

Show or hide the 'Reuse' button in the footer. The reuse button enables download of the content, including the libraries it uses, as an .h5p file. For details on the .h5p file type see the specification on h5p.org.

.env
H5P_DEFAULT_EXPORT_OPTION=2
Config key
h5p.defaultExportOption
Allowed values
0 => Reuse button is hidden
1 => Controlled by author, default is display
2 => Controlled by author, default is hide
3 => Reuse button is displayed
4 => Controlled by permissions. Currently, permission is always denied, i.e. the button is hidden.

H5P_SHOW_DISPLAY_OPTIONS

Show the 'Display options' section in the editor. The section allows the author to set the visibility of the footer, and visibility of the 'Rights of use' and 'Reuse' buttons in the footer.

.env
H5P_SHOW_DISPLAY_OPTIONS=false
Config key
h5p.showDisplayOptions
Allowed values
true  => Show section in the editor
false => Section is not displayed

H5P_DEFAULT_SHARE_SETTING

Set the default value of the sharing option in the editor. Regardless of this setting the author can toggle the setting on or off. For more about sharing see the Shared content section in the User Guides.

.env
H5P_DEFAULT_SHARE_SETTING=private
Config key
h5p.defaultShareSetting
Allowed values
private => Sharing is default disabled
share => Sharing is default enabled

H5P_SINGLE_CONTENT_UPGRADE

.env
H5P_SINGLE_CONTENT_UPGRADE=true
Config key
h5p.singleContentUpgrade

H5P_DEVELOPMENT_MODE

.env
H5P_DEVELOPMENT_MODE=false
Config key
h5p.developmentMode

H5P_IS_HUB_ENABLED

.env
H5P_IS_HUB_ENABLED=false
Config key
h5p.isHubEnabled

H5P_INCLUDE_MATHJAX

.env
H5P_INCLUDE_MATHJAX=true
Config key
h5p.include-mathjax

H5P_CROSSORIGIN

.env
H5P_CROSSORIGIN=null
Config key
h5p.crossOrigin

H5P_CROSSORIGIN_REGEXP

.env
H5P_CROSSORIGIN_REGEXP=/.+/
Config key
h5p.crossOriginRegexp

H5P_ADAPTER

.env
H5P_ADAPTER=cerpus
Config key
h5p.h5pAdapter

H5P_SAVE_FREQUENCY

.env
H5P_SAVE_FREQUENCY=15
Config key
h5p.saveFrequency

H5P_INCLUDE_CUSTOM_CSS

.env
H5P_INCLUDE_CUSTOM_CSS=false
Config key
h5p.include-custom-css

H5P_DEFAULT_RESOURCE_LANGUAGE

.env
H5P_DEFAULT_RESOURCE_LANGUAGE=eng
Config key
h5p.default-resource-language

H5P_UPLOAD_MEDIA_FILES_TIMEOUT

.env
H5P_UPLOAD_MEDIA_FILES_TIMEOUT=5
Config key
h5p.upload-media-files-timeout

H5P DragQuestion

H5P_DQ_DISABLE_FULLSCREEN

.env
H5P_DQ_DISABLE_FULLSCREEN=false
Config key
h5p.H5P_DragQuestion.disableFullscreen

H5P Dialogcards

H5P_DC_USE_RICH_TEXT

.env
H5P_DC_USE_RICH_TEXT=false
Config key
h5p.H5P_Dialogcards.useRichText

Storage

UPLOAD_STORAGE_PATH_H5P

Default value is public_path() . '/h5pstorage'

Config key
h5p.storage.path

Video

H5P_VIDEO_STREAM_ENABLED

.env
H5P_VIDEO_STREAM_ENABLED=true
Config key
h5p.video.enable

H5P_VIDEO_ADAPTER

Deprecated

H5P_VIDEO_URL

.env
H5P_VIDEO_URL=null
Config key
h5p.video.url

H5P_VIDEO_ADAPTER_KEY

.env
H5P_VIDEO_ADAPTER_KEY=null
Config key
h5p.video.key

H5P_VIDEO_ADAPTER_SECRET

.env
H5P_VIDEO_ADAPTER_SECRET=null
Config key
h5p.video.secret

H5P_VIDEO_ADAPTER_DELETEVIDEO

.env
H5P_VIDEO_ADAPTER_DELETEVIDEO=true
Config key
h5p.video.deleteVideoSourceAfterConvertToStream

H5P_VIDEO_DELAY

.env
H5P_VIDEO_DELAY=10
Config key
h5p.video.pingDelay

H5P_VIDEO_ACCOUNT_ID

.env
H5P_VIDEO_ACCOUNT_ID=null
Config key
h5p.video.accountId

H5P_VIDEO_AUTH_URL

.env
H5P_VIDEO_AUTH_URL=null
Config key
h5p.video.authUrl

Image

H5P_IMAGE_AUTH_DOMAIN

.env
H5P_IMAGE_AUTH_DOMAIN=null
Config key
h5p.image.authDomain

H5P_IMAGE_AUTH_KEY

.env
H5P_IMAGE_AUTH_KEY=null
Config key
h5p.image.key

H5P_IMAGE_AUTH_SECRET

.env
H5P_IMAGE_AUTH_SECRET=null
Config key
h5p.image.secret

H5P_IMAGE_AUDIENCE

.env
H5P_IMAGE_AUDIENCE=null
Config key
h5p.image.audience

H5P_IMAGE_URL

.env
H5P_IMAGE_URL=null
Config key
h5p.image.url

H5P_IMAGE_PROPERTIES_WIDTH

.env
H5P_IMAGE_PROPERTIES_WIDTH=2500
Config key
h5p.image.properties.width

Audio

H5P_AUDIO_AUTH_DOMAIN

.env
H5P_AUDIO_AUTH_DOMAIN=null
Config key
h5p.audio.authDomain

H5P_AUDIO_AUTH_KEY

.env
H5P_AUDIO_AUTH_KEY=null
Config key
h5p.audio.key

H5P_AUDIO_AUTH_SECRET

.env
H5P_AUDIO_AUTH_SECRET=null
Config key
h5p.audio.secret

H5P_AUDIO_AUDIENCE

.env
H5P_AUDIO_AUDIENCE=null
Config key
h5p.audio.audience

H5P_AUDIO_URL

.env
H5P_AUDIO_URL=null
Config key
h5p.audio.url