# Customizing Katacoda Embed

This is only available as part of a paid subscription. More details at https://katacoda.com/embed/

When embedding Katacoda you can provide a series of parameters to change the default behaviour of Katacoda. Here are the various options available.

# Example

# Global Parameters (data-katacoda-*)

Element Description
lang Used with internationalisation support and the ability to load language translated strings and content. By default, English will be used.
userid Provide additional tracking userid. This should not be personalised information, such as a email address of the user. Instead, use an internal tracking reference
font Override the main font
fontheader Override the main font
color Override the default color
secondary Override the secondary color, such as on buttons
externalcss Provide the absolute URL to an externalcss to load. This external CSS can be stored and hosted on Katacoda via an Asset
layout Define the layout to use when rendering
ondemand Set to "true" if Katacoda should not load automatically. Call window.katacoda.init() to start Katacoda

# Dashboard Parameters (data-katacoda-*)

Element Description
id Provide the dashboard you wish to render based on the pathway filename. For example: 'myuser/introduction/dashboard' to render the dashboard based on introduction-pathway.json.
hideprogress Indicate if the progress bar for users course should be shown

# Scenario Parameters (data-katacoda-*)

Element Description
id Provide the name of the scenario to render, such as 'myuser/scenarion-folder-name'
prompt Initial help message output at the top of the terminal to users
ctaurl Set the call to action URL at the end of a scenario
ctatext Set the call to action text at the end of a scenario
layout Override the layout specified within the content. Supported: terminal, editor-terminal, iframe, terminal-iframe
hideintro Indicate if the intro panel should be hidden. True indicates intro will not be shown
hidefinish Indicate if the finish panel should be hidden. True indicates finish will not be shown
hidetitle Indicate if the title on the scenarios steps should be hidden. True indicates title will not be shown
hidesidebar Indicate if the sidebar content should be hidden. True indicates sidebar will not be shown
hideiframebuttons When the layout iframe is used, indicate if the refresh and pop-out buttons should be hidden. True indicates the buttons will not be shown. The default value is true

# Terminal/Panel Only Parameters (data-katacoda-*)

Element Description
env Load a environment based on Katacoda image name. Example: bash
id Provide the name of the scenario to render, such as 'myuser/scenarion-folder-name'. Not supported when env parameter provided
ui Specify "panel" to create a terminal panel at the bottom of the page
prompt Initial help message output at the top of the terminal to users
command Initial command to run when the panel or terminal is loaded
runinbackground Specify a command that should be run in the backgroud
port Specify the default port to for preview URLs
filename When using editor layout, specify the filename for the code snippet

# Katacoda for Trainers Dashboard Parameters (data-katacoda-*)

Katacoda includes the ability to dynamically schedule additional training.

Element Description
id To embed the Dashboard showing the live training, use the ID "<katacoda-profile>/training/dashboard". The target link will showing all the active training allowing the user to navigate to the course, generated based on the Pathway defined for the course.

If no training is currently scheduled, it will return "No Active Training".

For example:

<div id="katacoda-dashboard" data-katacoda-id="scenario-examples/training/dashboard"</div>

# Additional Customizations

If you require additional Customizations, please contact Support.