2024-03-04 10:44:38 +00:00
<!doctype html>
< html lang = "en" dir = "ltr" class = "docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-extensions/index" data-has-hydrated = "false" >
< head >
< meta charset = "UTF-8" >
2025-01-14 13:36:07 +00:00
< meta name = "generator" content = "Docusaurus v3.7.0" >
2024-12-17 12:19:08 +00:00
< title data-rh = "true" > Extensions | Podman Desktop< / title > < meta data-rh = "true" name = "viewport" content = "width=device-width,initial-scale=1" > < meta data-rh = "true" name = "twitter:card" content = "summary_large_image" > < meta data-rh = "true" property = "og:image" content = "https://podman-desktop.io/img/banner_podman-desktop.png" > < meta data-rh = "true" name = "twitter:image" content = "https://podman-desktop.io/img/banner_podman-desktop.png" > < meta data-rh = "true" property = "og:url" content = "https://podman-desktop.io/docs/extensions" > < meta data-rh = "true" property = "og:locale" content = "en" > < meta data-rh = "true" name = "docusaurus_locale" content = "en" > < meta data-rh = "true" name = "docsearch:language" content = "en" > < meta data-rh = "true" name = "docusaurus_version" content = "current" > < meta data-rh = "true" name = "docusaurus_tag" content = "docs-default-current" > < meta data-rh = "true" name = "docsearch:version" content = "current" > < meta data-rh = "true" name = "docsearch:docusaurus_tag" content = "docs-default-current" > < meta data-rh = "true" property = "og:title" content = "Extensions | Podman Desktop" > < meta data-rh = "true" name = "description" content = "Installing, developing, or publishing extensions." > < meta data-rh = "true" property = "og:description" content = "Installing, developing, or publishing extensions." > < meta data-rh = "true" name = "keywords" content = "podman desktop,podman,extension" > < link data-rh = "true" rel = "icon" href = "/img/favicon.ico" > < link data-rh = "true" rel = "canonical" href = "https://podman-desktop.io/docs/extensions" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/docs/extensions" hreflang = "en" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/docs/extensions" hreflang = "x-default" > < link data-rh = "true" rel = "preconnect" href = "https://MR01ANKQ9S-dsn.algolia.net" crossorigin = "anonymous" > < link rel = "alternate" type = "application/rss+xml" href = "/blog/rss.xml" title = "Podman Desktop RSS Feed" >
2024-03-04 10:44:38 +00:00
< link rel = "alternate" type = "application/atom+xml" href = "/blog/atom.xml" title = "Podman Desktop Atom Feed" >
< link rel = "alternate" type = "application/json" href = "/blog/feed.json" title = "Podman Desktop JSON Feed" >
2025-01-14 13:36:07 +00:00
2024-03-04 10:44:38 +00:00
< link rel = "search" type = "application/opensearchdescription+xml" title = "Podman Desktop" href = "/opensearch.xml" >
< link rel = "preconnect" href = "https://podman-desktop-website.goatcounter.com" >
2025-02-03 22:25:00 +00:00
< script async src = "//gc.zgo.at/count.js" data-goatcounter = "https://podman-desktop-website.goatcounter.com/count" > < / script > < link rel = "stylesheet" href = "/assets/css/styles.d91155a6.css" >
< script src = "/assets/js/runtime~main.c423ff67.js" defer = "defer" > < / script >
2025-02-03 06:36:50 +00:00
< script src = "/assets/js/main.657757b2.js" defer = "defer" > < / script >
2024-03-04 10:44:38 +00:00
< / head >
< body class = "navigation-with-keyboard" >
2025-01-24 05:02:01 +00:00
< script > ! function ( ) { function t ( t ) { document . documentElement . setAttribute ( "data-theme" , t ) } var e = function ( ) { try { return new URLSearchParams ( window . location . search ) . get ( "docusaurus-theme" ) } catch ( t ) { } } ( ) || function ( ) { try { return window . localStorage . getItem ( "theme" ) } catch ( t ) { } } ( ) ; null !== e ? t ( e ) : window . matchMedia ( "(prefers-color-scheme: dark)" ) . matches ? t ( "dark" ) : window . matchMedia ( "(prefers-color-scheme: light)" ) . matches ? t ( "light" ) : t ( "dark" ) } ( ) , function ( ) { try { const c = new URLSearchParams ( window . location . search ) . entries ( ) ; for ( var [ t , e ] of c ) if ( t . startsWith ( "docusaurus-data-" ) ) { var a = t . replace ( "docusaurus-data-" , "data-" ) ; document . documentElement . setAttribute ( a , e ) } } catch ( t ) { } } ( ) < / script > < div id = "__docusaurus" > < div role = "region" aria-label = "Skip to main content" > < a class = "skipToContent_oPtH" href = "#__docusaurus_skipToContent_fallback" > Skip to main content< / a > < / div > < nav aria-label = "Main" class = "navbar navbar--fixed-top" > < div class = "navbar__inner" > < div class = "navbar__items" > < button aria-label = "Toggle navigation bar" aria-expanded = "false" class = "navbar__toggle clean-btn" type = "button" > < svg width = "30" height = "30" viewBox = "0 0 30 30" aria-hidden = "true" > < path stroke = "currentColor" stroke-linecap = "round" stroke-miterlimit = "10" stroke-width = "2" d = "M4 7h22M4 15h22M4 23h22" > < / path > < / svg > < / button > < a class = "navbar__brand" href = "/" > < div class = "navbar__logo" > < img src = "/img/logo.svg" alt = "Podman Desktop Logo" class = "themedComponent_siVc themedComponent--light_hHel" height = "56" > < img src = "/img/logo.svg" alt = "Podman Desktop Logo" class = "themedComponent_siVc themedComponent--dark_yETr" height = "56" > < / div > < b class = "navbar__title text--truncate" > podman desktop< / b > < / a > < a aria-current = "page" class = "navbar__item navbar__link navbar__link--active" href = "/docs/intro" > Documentation< / a > < a class = "navbar__item navbar__link" href = "/features" > Features< / a > < a class = "navbar__item navbar__link" href = "/downloads" > Downloads< / a > < a class = "navbar__item navbar__link" href = "/extend" > Extend< / a > < a class = "navbar__item navbar__link" href = "/blog" > Blog< / a > < a class = "navbar__item navbar__link" href = "/tutorial" > Tutorials< / a > < / div > < div class = "navbar__items navbar__items--right" > < a href = "https://github.com/podman-desktop/podman-desktop" target = "_blank" rel = "noopener noreferrer" class = "navbar__item navbar__link header-github-link" > < / a > < div class = "toggle_ki11 colorModeToggle_Hewu" > < button class = "clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m" type = "button" disabled = "" title = "Switch between dark and light mode (currently dark mode)" aria-label = "Switch between dark and light mode (currently dark mode)" aria-live = "polite" aria-pressed = "true" > < svg viewBox = "0 0 24 24" width = "24" height = "24" class = "lightToggleIcon_lgto" > < path fill = "currentColor" d = "M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z" > < / path > < / svg > < svg viewBox = "0 0 24 24" width = "24" height = "24" class = "darkToggleIcon_U96C" > < path fill = "currentColor" d = "M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3 . 86 , 0-7-3 . 14-7-7C5 , 9 . 07 , 6 . 81 , 6 . 55 , 9 . 37 , 5 . 51z M12 , 3c-4 . 97 , 0-9 , 4 . 03-9 , 9s4 . 03 , 9 , 9 , 9s9-4 . 03 , 9-9c0-0 . 46-0 . 04-0 . 92-0 . 1-1 . 36 c-0 . 98 , 1 . 37-2 . 58 , 2 .
2024-12-17 12:19:08 +00:00
< p > Extensions are designed to be modular and easily pluggable into Podman Desktop. They allow you to use and manipulate a wide range of Podman Desktop functionalities < a href = "/api" > via our API< / a > . Not only can you customize every component of Podman Desktop, but you can also extend its functionality with these extensions.< / p >
< p > With extensions, you can add:< / p >
2024-03-04 10:44:38 +00:00
< ul >
2024-12-17 12:19:08 +00:00
< li > Support for container engines, such as Podman or Docker.< / li >
< li > Virtual machine integrations, such as Lima.< / li >
< li > Podman Desktop extension points, including tray icon menus, status bar items, icons, menus, and commands.< / li >
< li > Integration with third-party tools, such as Kind or Compose.< / li >
2024-03-04 10:44:38 +00:00
< / ul >
2024-12-17 12:19:08 +00:00
< h2 class = "anchor anchorWithStickyNavbar_JmGV" id = "architecture" > Architecture< a href = "#architecture" class = "hash-link" aria-label = "Direct link to Architecture" title = "Direct link to Architecture" > < / a > < / h2 >
< p > Below is an example of the architecture for the " Podman" extension that integrates with Podman Desktop:< / p >
< p > < img decoding = "async" loading = "lazy" alt = "architecture" src = "/assets/images/architecture-af9c3dd4fc496284d3e601fa3c61adaa.png" width = "596" height = "648" class = "img_SS3x" > < / p >
< p > Each extension is isolated and communicates entirely through the Podman Desktop API, ensuring modularity and extensibility for Podman Desktop.< / p >
< h2 class = "anchor anchorWithStickyNavbar_JmGV" id = "what-can-a-podman-desktop-extension-do" > What can a Podman Desktop extension do?< a href = "#what-can-a-podman-desktop-extension-do" class = "hash-link" aria-label = "Direct link to What can a Podman Desktop extension do?" title = "Direct link to What can a Podman Desktop extension do?" > < / a > < / h2 >
< p > Here are some examples of what you can achieve with the Podman Desktop extension API:< / p >
< ul >
< li > < a href = "/docs/extensions/developing/onboarding-workflow" > Create your own onboarding workflow.< / a > < / li >
< li > < a href = "/docs/extensions/developing/commands" > Add non-native Podman Desktop commands.< / a > < / li >
< li > < a href = "/docs/extensions/developing/config" > Create configuration settings for your extension.< / a > < / li >
< li > < a href = "/docs/extensions/developing/menu" > Add menus to areas, such as pushing images.< / a > < / li >
< / ul >
< p > The possibilities are endless. You can leverage < a href = "/api" > our API< / a > to expand your extension' s capabilities even further.< / p >
< h2 class = "anchor anchorWithStickyNavbar_JmGV" id = "how-to-build-an-extension" > How to build an extension< a href = "#how-to-build-an-extension" class = "hash-link" aria-label = "Direct link to How to build an extension" title = "Direct link to How to build an extension" > < / a > < / h2 >
< p > To help you get started, we' ve provided templates ranging from a minimal " Hello World" example to a full web-view extension.< / p >
< p > Here are some examples from < a href = "/docs/extensions/templates" > our templates documentation< / a > :< / p >
< ul >
< li > < a href = "https://github.com/podman-desktop/extension-template-minimal" target = "_blank" rel = "noopener noreferrer" > Basic " Hello World" example.< / a > < / li >
< li > < a href = "https://github.com/podman-desktop/extension-template-webview" target = "_blank" rel = "noopener noreferrer" > Simple webview template.< / a > < / li >
< li > < a href = "https://github.com/podman-desktop/extension-template-full" target = "_blank" rel = "noopener noreferrer" > Full-stack webview template.< / a > < / li >
< / ul >
< p > Have questions or need assistance? Join our community on Discord for support!< / p >
< h2 class = "anchor anchorWithStickyNavbar_JmGV" id = "next-steps" > Next Steps< a href = "#next-steps" class = "hash-link" aria-label = "Direct link to Next Steps" title = "Direct link to Next Steps" > < / a > < / h2 >
2024-03-04 10:44:38 +00:00
< ul >
2024-05-03 14:21:14 +00:00
< li > < a href = "/docs/extensions/developing" > Writing a Podman Desktop extension entry point< / a > < / li >
2024-03-04 10:44:38 +00:00
< li > < a href = "/docs/extensions/publish" > Publishing a Podman Desktop extension< / a > < / li >
< li > < a href = "/docs/extensions/install" > Installing a Podman Desktop extension< / a > < / li >
2025-01-29 20:58:29 +00:00
< / ul > < / div > < footer class = "theme-doc-footer docusaurus-mt-lg" > < div class = "row margin-top--sm theme-doc-footer-tags-row" > < div class = "col" > < b > Tags:< / b > < ul class = "tags_Ow0B padding--none margin-left--sm" > < li class = "tag_DFxh" > < a class = "tag_otG2 tagRegular_s0E1" href = "/docs/tags/podman-desktop-extensions" > podman-desktop-extensions< / a > < / li > < li class = "tag_DFxh" > < a class = "tag_otG2 tagRegular_s0E1" href = "/docs/tags/building-an-extension" > building-an-extension< / a > < / li > < / ul > < / div > < / div > < div class = "row margin-top--sm theme-doc-footer-edit-meta-row" > < div class = "col" > < a href = "https://github.com/podman-desktop/podman-desktop/tree/main/website/docs/extensions/index.md" target = "_blank" rel = "noopener noreferrer" class = "theme-edit-this-page" > < svg fill = "currentColor" height = "20" width = "20" viewBox = "0 0 40 40" class = "iconEdit_bHB7" aria-hidden = "true" > < g > < path d = "m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z" > < / path > < / g > < / svg > Edit this page< / a > < / div > < div class = "col lastUpdated_ydrU" > < / div > < / div > < / footer > < / article > < nav class = "pagination-nav docusaurus-mt-lg" aria-label = "Docs pages" > < a class = "pagination-nav__link pagination-nav__link--prev" href = "/docs/openshift/openshift-local" > < div class = "pagination-nav__sublabel" > Previous< / div > < div class = "pagination-nav__label" > OpenShift Local< / div > < / a > < a class = "pagination-nav__link pagination-nav__link--next" href = "/docs/extensions/install" > < div class = "pagination-nav__sublabel" > Next< / div > < div class = "pagination-nav__label" > Installing< / div > < / a > < / nav > < / div > < / div > < div class = "col col--3" > < div class = "tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop" > < ul class = "table-of-contents table-of-contents__left-border" > < li > < a href = "#architecture" class = "table-of-contents__link toc-highlight" > Architecture< / a > < / li > < li > < a href = "#what-can-a-podman-desktop-extension-do" class = "table-of-contents__link toc-highlight" > What can a Podman Desktop extension do?< / a > < / li > < li > < a href = "#how-to-build-an-extension" class = "table-of-contents__link toc-highlight" > How to build an extension< / a > < / li > < li > < a href = "#next-steps" class = "table-of-contents__link toc-highlight" > Next Steps< / a > < / li > < / ul > < / div > < / div > < / div > < / div > < / main > < / div > < / div > < / div > < footer class = "footer" > < div class = "container container-fluid" > < div class = "row footer__links" > < div class = "col footer__col" > < div class = "footer__title" > Documentation< / div > < ul class = "footer__items clean-list" > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/installation" > Installing Podman Desktop< / a > < / li > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/migrating-from-docker" > Migrating from Docker< / a > < / li > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/kubernetes" > Working with Kubernetes< / a > < / li > < li class = "footer__item" > < a class = "footer__link-item" href = "/docs/troubleshooting" > Troubleshooting< / a > < / li > < / ul > < / div > < div class = "col footer__col" > < div class = "footer__title" > Links< / div > < ul class = "footer__items clean-list" > < li class = "footer__item" > < a href = "https://github.com/podman-desktop/podman-desktop" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > GitHub< svg width = "13.5" height = "13.5" aria-hidden = "true" viewBox = "0 0 24 24" class = "iconExternalLink_nPrP" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z" > < / path > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://discord.com/invite/x5GzFF6QH4" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Chat (bridged): #podman-desktop on Discord< svg width = "13.5" height = "13.5" aria-hidden = "true" viewBox = "0 0 24 24" class = "iconExternalLink_nPrP" > < path fill = "currentColor" d = "M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z" > < / path > < / svg > < / a > < / li > < li class = "footer__item" > < a href = "https://github.com/podman-desktop/podman-desktop#communication" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Other ways to Communicate< svg wid
< div class = "w-80" > < img class = "dark:hidden" alt = "Cloud Native Computing Foundation" src = "/img/cncf-logo.svg" > < img class = "hidden dark:inline" alt = "Cloud Native Computing Foundation" src = "/img/cncf-logo-dark.svg" > < / div >
< div > We are a < a href = "https://cncf.io/" > Cloud Native Computing Foundation< / a > sandbox project.< / div >
< div class = "text-sm" >
© Copyright podman desktop Contributors 2025. © 2025 The Linux Foundation. All rights reserved.
< / div >
< div class = "text-xs" > The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our < a href = "https://www.linuxfoundation.org/trademark-usage/" > Trademark Usage< / a > page.
< / div >
< / div > < / div > < / div > < / div > < / footer > < / div >
2024-03-04 10:44:38 +00:00
< / body >
< / html >
