Elgato_dark/podman-desktop
1
0
Fork 0
mirror of https://github.com/podman-desktop/podman-desktop synced 2026-04-21 17:47:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

deploy: 7e0b9fbb85

Browse source
This commit is contained in:
github-actions[bot] 2026-04-21 07:47:57 +00:00
parent 0f190a337e
commit 548cd8581a
1086 changed files with 3438 additions and 3438 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
404.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
api.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
api/@podman-desktop/namespaces/authentication.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

6
api/@podman-desktop/namespaces/authentication/functions/getSession.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -26,7 +26,7 @@
<blockquote>
<p><strong>getSession</strong>(<code>providerId</code>, <code>scopes</code>, <code>options</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/AuthenticationSession"><code>AuthenticationSession</code></a> | <code>undefined</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4426" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4426</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4426" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4426</a></p>
<p>Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
registered, or if the user does not consent to sharing authentication information with
the extension. If there are multiple sessions with the same scopes, the user will be shown a
@ -50,7 +50,7 @@ to VS Code that implement GitHub and Microsoft authentication: their providerId&
<blockquote>
<p><strong>getSession</strong>(<code>providerId</code>, <code>scopes</code>, <code>options?</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/AuthenticationSession"><code>AuthenticationSession</code></a> | <code>undefined</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4445" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4445</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4445" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4445</a></p>
<p>Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
registered, or if the user does not consent to sharing authentication information with
the extension. If there are multiple sessions with the same scopes, the user will be shown a

4
api/@podman-desktop/namespaces/authentication/functions/registerAuthenticationProvider.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>registerAuthenticationProvider</strong>(<code>id</code>, <code>label</code>, <code>provider</code>, <code>options?</code>): <a class="" href="/api/classes/Disposable"><code>Disposable</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4469" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4469</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4469" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4469</a></p>
<p>Register an authentication provider.</p>
<p>There can only be one provider per id and an error is being thrown when an id
has already been used by another provider. Ids are case-sensitive.</p>

4
api/@podman-desktop/namespaces/authentication/variables/onDidChangeSessions.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onDidChangeSessions</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<a class="" href="/api/interfaces/AuthenticationSessionsChangeEvent"><code>AuthenticationSessionsChangeEvent</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4455" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4455</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4455" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4455</a></p>
<p>An <a href="#Event" class="">event</a> which fires when the authentication sessions of an authentication provider have
been added, removed, or changed.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/authentication"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">authentication</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/authentication/functions/getSession"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">getSession</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

2
api/@podman-desktop/namespaces/cli.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/cli/functions/createCliTool.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createCliTool</strong>(<code>options</code>): <a class="" href="/api/interfaces/CliTool"><code>CliTool</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4933" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4933</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4933" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4933</a></p>
<p>Register new CLI Tool</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options<a href="#options" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/cli/functions/getCliTool.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>getCliTool</strong>(<code>id</code>): <a class="" href="/api/interfaces/CliToolInfo"><code>CliToolInfo</code></a> | <code>undefined</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4939" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4939</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4939" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4939</a></p>
<p>given an id, return the corresponding CLI Tool</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/cli/variables/all.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>all</strong>: readonly <a class="" href="/api/interfaces/CliToolInfo"><code>CliToolInfo</code></a>[]</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4944" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4944</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4944" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4944</a></p>
<p>All cli tools currently known to the system.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/cli"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">cli</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/cli/variables/onDidChange"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">onDidChange</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">

4
api/@podman-desktop/namespaces/cli/variables/onDidChange.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onDidChange</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4950" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4950</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4950" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4950</a></p>
<p>An event which fires when <code>cli.all</code> changes. This can happen when cli are
installed, uninstalled, enabled or disabled.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/cli/variables/all"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">all</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/cli/functions/createCliTool"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">createCliTool</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

2
api/@podman-desktop/namespaces/commands.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/commands/functions/executeCommand.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>executeCommand</strong>&lt;<code>T</code>&gt;(<code>command</code>, ...<code>rest</code>): <code>PromiseLike</code>&lt;<code>T</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L814" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:814</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L814" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:814</a></p>
<p>Execute a command, previously registered with <a class="" href="/api/@podman-desktop/namespaces/commands/functions/registerCommand">commands.registerCommand</a>.</p>
<p>For an example, see <a class="" href="/api/@podman-desktop/namespaces/commands">commands</a>.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="type-parameters">Type Parameters<a href="#type-parameters" class="hash-link" aria-label="Direct link to Type Parameters" title="Direct link to Type Parameters" translate="no">​</a></h2>

4
api/@podman-desktop/namespaces/commands/functions/registerCommand.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>registerCommand</strong>(<code>command</code>, <code>callback</code>, <code>thisArg?</code>): <a class="" href="/api/classes/Disposable"><code>Disposable</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L800" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:800</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L800" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:800</a></p>
<p>Define a command, to be executed later, either by calling <a class="" href="/api/@podman-desktop/namespaces/commands/functions/executeCommand">commands.executeCommand</a> or by referencing its name in the <code>command</code> field of a <a class="" href="/api/interfaces/StatusBarItem">StatusBarItem</a>.</p>
<p>For examples, see <a class="" href="/api/@podman-desktop/namespaces/commands">commands</a> and <a class="" href="/api/@podman-desktop/namespaces/window/functions/createStatusBarItem">window.createStatusBarItem</a>.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>

2
api/@podman-desktop/namespaces/configuration.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/configuration/functions/getConfiguration.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>getConfiguration</strong>(<code>section?</code>, <code>scope?</code>): <a class="" href="/api/interfaces/Configuration"><code>Configuration</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L1245" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:1245</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L1245" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:1245</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="section">section?<a href="#section" class="hash-link" aria-label="Direct link to section?" title="Direct link to section?" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/configuration/variables/onDidChangeConfiguration.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onDidChangeConfiguration</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<a class="" href="/api/interfaces/ConfigurationChangeEvent"><code>ConfigurationChangeEvent</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L1250" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:1250</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L1250" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:1250</a></p>
<p>An event that is emitted when the <a class="" href="/api/interfaces/Configuration">configuration</a> changed.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/configuration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/configuration/functions/getConfiguration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">getConfiguration</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">

2
api/@podman-desktop/namespaces/containerEngine.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/containerEngine/functions/buildImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>buildImage</strong>(<code>context</code>, <code>eventCollect</code>, <code>options?</code>): <code>Promise</code>&lt;<code>unknown</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4059" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4059</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4059" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4059</a></p>
<p>Build a container image</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="context">context<a href="#context" class="hash-link" aria-label="Direct link to context" title="Direct link to context" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/createContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createContainer</strong>(<code>engineId</code>, <code>containerCreateOptions</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ContainerCreateResult"><code>ContainerCreateResult</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L3984" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3984</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L3984" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3984</a></p>
<p>Create a new container on a specific container engine</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/createManifest.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createManifest</strong>(<code>options</code>): <code>Promise</code>&lt;{ <code>engineId</code>: <code>string</code>; <code>Id</code>: <code>string</code>; }&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4203" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4203</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4203" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4203</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options<a href="#options" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no">​</a></h3>
<p><a class="" href="/api/interfaces/ManifestCreateOptions"><code>ManifestCreateOptions</code></a></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/createNetwork.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createNetwork</strong>(<code>containerProviderConnection</code>, <code>networkCreateOptions</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/NetworkCreateResult"><code>NetworkCreateResult</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4179" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4179</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4179" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4179</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="containerproviderconnection">containerProviderConnection<a href="#containerproviderconnection" class="hash-link" aria-label="Direct link to containerProviderConnection" title="Direct link to containerProviderConnection" translate="no">​</a></h3>
<p><a class="" href="/api/interfaces/ContainerProviderConnection"><code>ContainerProviderConnection</code></a></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/createPod.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createPod</strong>(<code>podOptions</code>): <code>Promise</code>&lt;{ <code>engineId</code>: <code>string</code>; <code>Id</code>: <code>string</code>; }&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4188" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4188</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4188" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4188</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="podoptions">podOptions<a href="#podoptions" class="hash-link" aria-label="Direct link to podOptions" title="Direct link to podOptions" translate="no">​</a></h3>
<p><a class="" href="/api/interfaces/PodCreateOptions"><code>PodCreateOptions</code></a></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/createVolume.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createVolume</strong>(<code>options?</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/VolumeCreateResponseInfo"><code>VolumeCreateResponseInfo</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4185" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4185</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4185" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4185</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options?<a href="#options" class="hash-link" aria-label="Direct link to options?" title="Direct link to options?" translate="no">​</a></h3>
<p><a class="" href="/api/interfaces/VolumeCreateOptions"><code>VolumeCreateOptions</code></a></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/deleteContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>deleteContainer</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4051" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4051</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4051" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4051</a></p>
<p>Delete an existing container</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/deleteImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>deleteImage</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4144" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4144</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4144" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4144</a></p>
<p>Delete a container image from a local engine</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/deleteVolume.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>deleteVolume</strong>(<code>volumeName</code>, <code>options?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4186" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4186</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4186" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4186</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="volumename">volumeName<a href="#volumename" class="hash-link" aria-label="Direct link to volumeName" title="Direct link to volumeName" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/getImageInspect.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>getImageInspect</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ImageInspectInfo"><code>ImageInspectInfo</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4153" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4153</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4153" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4153</a></p>
<p>Return low-level information about an image</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/info.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>info</strong>(<code>engineId</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ContainerEngineInfo"><code>ContainerEngineInfo</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4155" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4155</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4155" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4155</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/inspectContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>inspectContainer</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ContainerInspectInfo"><code>ContainerInspectInfo</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L3975" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3975</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L3975" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3975</a></p>
<p>Get the complete low-level information about a specific container.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/inspectManifest.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>inspectManifest</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ManifestInspectInfo"><code>ManifestInspectInfo</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4204" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4204</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4204" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4204</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/inspectPod.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>inspectPod</strong>(<code>engineId</code>, <code>podId</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/PodInspectInfo"><code>PodInspectInfo</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4200" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4200</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4200" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4200</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/listContainers.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>listContainers</strong>(): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ContainerInfo"><code>ContainerInfo</code></a>[]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L3966" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3966</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L3966" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3966</a></p>
<p>Returns the list of containers across all container engines, in any state (running or not).</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<a class="" href="/api/interfaces/ContainerInfo"><code>ContainerInfo</code></a>[]&gt;</p>

4
api/@podman-desktop/namespaces/containerEngine/functions/listImages.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>listImages</strong>(<code>options?</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ImageInfo"><code>ImageInfo</code></a>[]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4092" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4092</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4092" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4092</a></p>
<p>List the container images. Only images from a final layer (no children) are returned.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options?<a href="#options" class="hash-link" aria-label="Direct link to options?" title="Direct link to options?" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/listInfos.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>listInfos</strong>(<code>options?</code>): <code>Promise</code>&lt;<a class="" href="/api/interfaces/ContainerEngineInfo"><code>ContainerEngineInfo</code></a>[]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4175" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4175</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4175" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4175</a></p>
<p>List the engines information.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options?<a href="#options" class="hash-link" aria-label="Direct link to options?" title="Direct link to options?" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/listNetworks.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>listNetworks</strong>(): <code>Promise</code>&lt;<a class="" href="/api/interfaces/NetworkInspectInfo"><code>NetworkInspectInfo</code></a>[]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4178" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4178</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4178" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4178</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<a class="" href="/api/interfaces/NetworkInspectInfo"><code>NetworkInspectInfo</code></a>[]&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine/functions/listInfos"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">listInfos</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/listPods"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">listPods</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/containerEngine/functions/listPods.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>listPods</strong>(): <code>Promise</code>&lt;<a class="" href="/api/interfaces/PodInfo"><code>PodInfo</code></a>[]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4197" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4197</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4197" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4197</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<a class="" href="/api/interfaces/PodInfo"><code>PodInfo</code></a>[]&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine/functions/listNetworks"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">listNetworks</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/listVolumes"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">listVolumes</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/containerEngine/functions/listVolumes.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>listVolumes</strong>(): <code>Promise</code>&lt;<a class="" href="/api/interfaces/VolumeListInfo"><code>VolumeListInfo</code></a>[]&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4184" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4184</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4184" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4184</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<a class="" href="/api/interfaces/VolumeListInfo"><code>VolumeListInfo</code></a>[]&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine/functions/listPods"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">listPods</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/logsContainer"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">logsContainer</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/containerEngine/functions/logsContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>logsContainer</strong>(<code>engineId</code>, <code>id</code>, <code>callback</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4004" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4004</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4004" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4004</a></p>
<p>Get the streamed logs of a container</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/pullImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>pullImage</strong>(<code>containerProviderConnection</code>, <code>imageName</code>, <code>callback</code>, <code>platform?</code>, <code>token?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4130" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4130</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4130" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4130</a></p>
<p>Pull an image from a registry</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="containerproviderconnection">containerProviderConnection<a href="#containerproviderconnection" class="hash-link" aria-label="Direct link to containerProviderConnection" title="Direct link to containerProviderConnection" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/pushImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>pushImage</strong>(<code>engineId</code>, <code>imageId</code>, <code>callback</code>, <code>authInfo?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4114" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4114</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4114" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4114</a></p>
<p>Push an image to a registry.</p>
<p>If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, <code>registry.example.com/myimage:latest</code>.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>

4
api/@podman-desktop/namespaces/containerEngine/functions/pushManifest.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>pushManifest</strong>(<code>options</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4205" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4205</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4205" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4205</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options<a href="#options" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no">​</a></h3>
<p><a class="" href="/api/interfaces/ManifestPushOptions"><code>ManifestPushOptions</code></a></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/removeManifest.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>removeManifest</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4206" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4206</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4206" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4206</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/removePod.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>removePod</strong>(<code>engineId</code>, <code>podId</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4199" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4199</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4199" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4199</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/replicatePodmanContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>replicatePodmanContainer</strong>(<code>source</code>, <code>target</code>, <code>overrideParameters</code>): <code>Promise</code>&lt;{ <code>Id</code>: <code>string</code>; <code>Warnings</code>: <code>string</code>[]; }&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4189" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4189</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4189" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4189</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="source">source<a href="#source" class="hash-link" aria-label="Direct link to source" title="Direct link to source" translate="no">​</a></h3>
<h4 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h4>

4
api/@podman-desktop/namespaces/containerEngine/functions/saveImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>saveImage</strong>(<code>engineId</code>, <code>id</code>, <code>filename</code>, <code>token?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4073" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4073</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4073" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4073</a></p>
<p>Save on disk a tarball containing the image and its metadata.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/startContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>startContainer</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L3995" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3995</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L3995" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:3995</a></p>
<p>Start an existing container</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/startPod.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>startPod</strong>(<code>engineId</code>, <code>podId</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4196" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4196</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4196" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4196</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/statsContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>statsContainer</strong>(<code>engineId</code>, <code>id</code>, <code>callback</code>): <code>Promise</code>&lt;<a class="" href="/api/classes/Disposable"><code>Disposable</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4030" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4030</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4030" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4030</a></p>
<p>Get the streamed stats of a running container.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/stopContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>stopContainer</strong>(<code>engineId</code>, <code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4042" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4042</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4042" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4042</a></p>
<p>Stop an existing container</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/functions/stopPod.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>stopPod</strong>(<code>engineId</code>, <code>podId</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4198" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4198</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4198" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4198</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/containerEngine/functions/tagImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>tagImage</strong>(<code>engineId</code>, <code>imageId</code>, <code>repo</code>, <code>tag?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4102" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4102</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4102" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4102</a></p>
<p>Tag an image so that it becomes part of a repository</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="engineid">engineId<a href="#engineid" class="hash-link" aria-label="Direct link to engineId" title="Direct link to engineId" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/containerEngine/variables/onEvent.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onEvent</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<a class="" href="/api/interfaces/ContainerJSONEvent"><code>ContainerJSONEvent</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4176" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4176</a></p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">containerEngine</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/buildImage"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">buildImage</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4176" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4176</a></p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/containerEngine"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">containerEngine</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/containerEngine/functions/buildImage"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">buildImage</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">
<img class="dark:hidden" alt="Cloud Native Computing Foundation" src="/img/cncf-logo.svg">

2
api/@podman-desktop/namespaces/context.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/context/functions/setValue.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>setValue</strong>(<code>key</code>, <code>value</code>, <code>scope?</code>): <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4829" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4829</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4829" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4829</a></p>
<p>Store a new value for key in the context.
This can be used in enablement of command or with the when property.
The key should consists of &#x27;&quot;extension-id&quot;.&quot;actual-key&quot;&#x27;.</p>

2
api/@podman-desktop/namespaces/env.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/env/functions/createTelemetryLogger.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createTelemetryLogger</strong>(<code>sender?</code>, <code>options?</code>): <a class="" href="/api/interfaces/TelemetryLogger"><code>TelemetryLogger</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4537" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4537</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4537" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4537</a></p>
<p>Creates a new <a class="" href="/api/interfaces/TelemetryLogger">telemetry logger</a>.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="sender">sender?<a href="#sender" class="hash-link" aria-label="Direct link to sender?" title="Direct link to sender?" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/env/functions/openExternal.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>openExternal</strong>(<code>uri</code>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4528" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4528</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4528" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4528</a></p>
<p>Opens a link externally using the default application. Depending on the</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="uri">uri<a href="#uri" class="hash-link" aria-label="Direct link to uri" title="Direct link to uri" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/env/variables/appName.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>appName</strong>: <code>string</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4484" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4484</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4484" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4484</a></p>
<p>The name of the application. (e.g., &#x27;Podman Desktop&#x27;)</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">env</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/clipboard"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">clipboard</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">

4
api/@podman-desktop/namespaces/env/variables/clipboard.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>clipboard</strong>: <a class="" href="/api/interfaces/Clipboard"><code>Clipboard</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4542" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4542</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4542" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4542</a></p>
<p>The system clipboard.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/appName"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">appName</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/isLinux"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">isLinux</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">

4
api/@podman-desktop/namespaces/env/variables/isLinux.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>isLinux</strong>: <code>boolean</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4508" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4508</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4508" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4508</a></p>
<p>Flag indicating whether we are running on a Linux operating system.</p>
<p>If the value of this flag is true, it means the current system is Linux.
If the value is false, it means the current system is not Linux.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/clipboard"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">clipboard</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/isMac"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">isMac</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">

4
api/@podman-desktop/namespaces/env/variables/isMac.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>isMac</strong>: <code>boolean</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4492" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4492</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4492" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4492</a></p>
<p>Flag indicating whether we are running on macOS (Mac OS X) operating system.</p>
<p>If the value of this flag is true, it means the current system is macOS.
If the value is false, it means the current system is not macOS.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/isLinux"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">isLinux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/isTelemetryEnabled"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">isTelemetryEnabled</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">

4
api/@podman-desktop/namespaces/env/variables/isTelemetryEnabled.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>isTelemetryEnabled</strong>: <code>boolean</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4514" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4514</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4514" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4514</a></p>
<p>Indicates whether the users has telemetry enabled.
Can be observed to determine if the extension should send telemetry.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/isMac"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">isMac</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/isWindows"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">isWindows</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/env/variables/isWindows.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>isWindows</strong>: <code>boolean</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4500" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4500</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4500" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4500</a></p>
<p>Flag indicating whether we are running on the Windows operating system.</p>
<p>If the value of this flag is true, it means the current system is Windows.
If the value is false, it means the current system is not Windows.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/isTelemetryEnabled"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">isTelemetryEnabled</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/onDidChangeTelemetryEnabled"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">onDidChangeTelemetryEnabled</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">

4
api/@podman-desktop/namespaces/env/variables/onDidChangeTelemetryEnabled.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onDidChangeTelemetryEnabled</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<code>boolean</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4520" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4520</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4520" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4520</a></p>
<p>An <a class="" href="/api/interfaces/Event">Event</a> which fires when the user enabled or disables telemetry.
<code>true</code> if the user has enabled telemetry or <code>false</code> if the user has disabled telemetry.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/isWindows"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">isWindows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/variables/urlProtocol"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">urlProtocol</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/env/variables/urlProtocol.html vendored
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>urlProtocol</strong>: <code>string</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L4548" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4548</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L4548" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:4548</a></p>
<p>The custom URL protocol scheme registered by the application (e.g., &#x27;podman-desktop&#x27;).
This is the protocol used for deep linking into the application.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/env/variables/onDidChangeTelemetryEnabled"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">onDidChangeTelemetryEnabled</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/env/functions/createTelemetryLogger"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">createTelemetryLogger</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

2
api/@podman-desktop/namespaces/extensions.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/extensions/functions/getExtension.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>getExtension</strong>&lt;<code>T</code>&gt;(<code>extensionId</code>): <a class="" href="/api/interfaces/Extension"><code>Extension</code></a>&lt;<code>T</code>&gt; | <code>undefined</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L271" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:271</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L271" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:271</a></p>
<p>Get an extension by its full identifier in the form of: <code>publisher.name</code>.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="type-parameters">Type Parameters<a href="#type-parameters" class="hash-link" aria-label="Direct link to Type Parameters" title="Direct link to Type Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="t">T<a href="#t" class="hash-link" aria-label="Direct link to T" title="Direct link to T" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/extensions/variables/all.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>all</strong>: readonly <a class="" href="/api/interfaces/Extension"><code>Extension</code></a>&lt;<code>any</code>&gt;[]</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L277" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:277</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L277" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:277</a></p>
<p>All extensions currently known to the system.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/extensions"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">extensions</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/extensions/variables/onDidChange"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">onDidChange</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">

4
api/@podman-desktop/namespaces/extensions/variables/onDidChange.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onDidChange</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L283" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:283</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L283" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:283</a></p>
<p>An event which fires when <code>extensions.all</code> changes. This can happen when extensions are
installed, uninstalled, enabled or disabled.</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/extensions/variables/all"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">all</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/extensions/functions/getExtension"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">getExtension</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

2
api/@podman-desktop/namespaces/fs.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/fs/functions/createFileSystemWatcher.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createFileSystemWatcher</strong>(<code>path</code>): <a class="" href="/api/interfaces/FileSystemWatcher"><code>FileSystemWatcher</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L2012" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2012</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L2012" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2012</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="path">path<a href="#path" class="hash-link" aria-label="Direct link to path" title="Direct link to path" translate="no">​</a></h3>
<p><code>string</code></p>

2
api/@podman-desktop/namespaces/imageChecker.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/imageChecker/functions/registerImageCheckerProvider.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>registerImageCheckerProvider</strong>(<code>imageCheckerProvider</code>, <code>metadata?</code>): <a class="" href="/api/classes/Disposable"><code>Disposable</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5020" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5020</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5020" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5020</a></p>
<p>Register the extension as an Image Checker.</p>
<p>As an image checker, a provider needs to implement a specific interface, so the core
application can call the provider with specific tasks when necessary.</p>

2
api/@podman-desktop/namespaces/kubernetes.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/kubernetes/functions/createResources.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>createResources</strong>(<code>context</code>, <code>manifests</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L2475" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2475</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L2475" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2475</a></p>
<p>Create one or several Kubernetes resources on the Kubernetes contenxt.</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="context">context<a href="#context" class="hash-link" aria-label="Direct link to context" title="Direct link to context" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/kubernetes/functions/getKubeconfig.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>getKubeconfig</strong>(): <a class="" href="/api/classes/Uri"><code>Uri</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L2465" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2465</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L2465" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2465</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><a class="" href="/api/classes/Uri"><code>Uri</code></a></p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/kubernetes/functions/createResources"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">createResources</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/kubernetes/functions/registerKubernetesGenerator"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">registerKubernetesGenerator</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/kubernetes/functions/registerKubernetesGenerator.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>registerKubernetesGenerator</strong>(<code>provider</code>): <a class="" href="/api/classes/Disposable"><code>Disposable</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L2481" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2481</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L2481" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2481</a></p>
<p>Add a KubernetesGenerator to KubernetesGeneratorRegistry</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="provider">provider<a href="#provider" class="hash-link" aria-label="Direct link to provider" title="Direct link to provider" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/kubernetes/functions/setKubeconfig.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>setKubeconfig</strong>(<code>kubeconfig</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L2467" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2467</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L2467" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2467</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="kubeconfig">kubeconfig<a href="#kubeconfig" class="hash-link" aria-label="Direct link to kubeconfig" title="Direct link to kubeconfig" translate="no">​</a></h3>
<p><a class="" href="/api/classes/Uri"><code>Uri</code></a></p>

4
api/@podman-desktop/namespaces/kubernetes/variables/onDidUpdateKubeconfig.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><code>const</code> <strong>onDidUpdateKubeconfig</strong>: <a class="" href="/api/interfaces/Event"><code>Event</code></a>&lt;<a class="" href="/api/interfaces/KubeconfigUpdateEvent"><code>KubeconfigUpdateEvent</code></a>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L2466" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2466</a></p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/kubernetes"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">kubernetes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/kubernetes/functions/createResources"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">createResources</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L2466" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:2466</a></p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/kubernetes"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">kubernetes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/kubernetes/functions/createResources"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">createResources</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">
<div class="w-96 mt-8 mb-8">
<img class="dark:hidden" alt="Cloud Native Computing Foundation" src="/img/cncf-logo.svg">

2
api/@podman-desktop/namespaces/navigation.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
api/@podman-desktop/namespaces/navigation/functions/navigate.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigate</strong>(<code>routeId</code>, ...<code>args</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5150" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5150</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5150" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5150</a></p>
<p>Allow extension to navigate to a custom route.
The route needs to have been registered using <a class="" href="/api/@podman-desktop/namespaces/navigation/functions/register">navigation.register</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToAuthentication.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToAuthentication</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5092" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5092</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5092" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5092</a></p>
<p>Navigate to Authentication settings page</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigate"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigate</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToCliTools"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToCliTools</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">

4
api/@podman-desktop/namespaces/navigation/functions/navigateToCliTools.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToCliTools</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5076" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5076</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5076" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5076</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToAuthentication"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigateToAuthentication</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToContainer"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToContainer</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/navigation/functions/navigateToContainer.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToContainer</strong>(<code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5050" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5050</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5050" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5050</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToContainerInspect.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToContainerInspect</strong>(<code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5054" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5054</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5054" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5054</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToContainerLogs.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToContainerLogs</strong>(<code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5052" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5052</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5052" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5052</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToContainerTerminal.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToContainerTerminal</strong>(<code>id</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5056" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5056</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5056" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5056</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToContainers.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToContainers</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5048" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5048</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5048" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5048</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToContainerLogs"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigateToContainerLogs</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToContainerTerminal"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToContainerTerminal</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/navigation/functions/navigateToContribution.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToContribution</strong>(<code>name</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5079" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5079</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5079" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5079</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="name">name<a href="#name" class="hash-link" aria-label="Direct link to name" title="Direct link to name" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToCreateProviderConnection.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToCreateProviderConnection</strong>(<code>providerId</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5103" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5103</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5103" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5103</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="providerid">providerId<a href="#providerid" class="hash-link" aria-label="Direct link to providerId" title="Direct link to providerId" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToDashboard.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToDashboard</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5046" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5046</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5046" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5046</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToCreateProviderConnection"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigateToCreateProviderConnection</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToEditProviderContainerConnection"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToEditProviderContainerConnection</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/navigation/functions/navigateToEditProviderContainerConnection.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToEditProviderContainerConnection</strong>(<code>connection</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5101" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5101</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5101" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5101</a></p>
<p>Navigate to the Edit Provider Container Connection page</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="connection">connection<a href="#connection" class="hash-link" aria-label="Direct link to connection" title="Direct link to connection" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToExtensionsCatalog.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToExtensionsCatalog</strong>(<code>options</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5114" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5114</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5114" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5114</a></p>
<p>Navigate to the Catalog tab of the Extensions page</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="options">options<a href="#options" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToImage.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToImage</strong>(<code>id</code>, <code>engineId</code>, <code>tag</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5063" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5063</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5063" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5063</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToImageBuild.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToImageBuild</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5061" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5061</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5061" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5061</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToImage"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigateToImage</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToImages"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToImages</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/navigation/functions/navigateToImages.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToImages</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5059" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5059</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5059" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5059</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToImageBuild"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigateToImageBuild</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToOnboarding"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToOnboarding</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

4
api/@podman-desktop/namespaces/navigation/functions/navigateToOnboarding.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToOnboarding</strong>(<code>extensionId?</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5109" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5109</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5109" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5109</a></p>
<p>Navigate to a specific onboarding page referenced by its extensionId</p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="extensionid">extensionId?<a href="#extensionid" class="hash-link" aria-label="Direct link to extensionId?" title="Direct link to extensionId?" translate="no">​</a></h3>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToPod.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToPod</strong>(<code>kind</code>, <code>name</code>, <code>engineId</code>): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5073" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5073</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5073" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5073</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no">​</a></h2>
<h3 class="anchor anchorTargetStickyNavbar_tleR" id="kind">kind<a href="#kind" class="hash-link" aria-label="Direct link to kind" title="Direct link to kind" translate="no">​</a></h3>
<p><code>string</code></p>

4
api/@podman-desktop/namespaces/navigation/functions/navigateToPods.html
View file

@ -14,7 +14,7 @@
<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<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.5c13bc1e.css">
<script src="/assets/js/runtime~main.685b0e64.js" defer="defer"></script>
<script src="/assets/js/runtime~main.fac21ac3.js" defer="defer"></script>
<script src="/assets/js/main.cfd35e42.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -25,7 +25,7 @@
<blockquote>
<p><strong>navigateToPods</strong>(): <code>Promise</code>&lt;<code>void</code>&gt;</p>
</blockquote>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/c250891a691fdee28127a3c704eba6d9949ad770/packages/extension-api/src/extension-api.d.ts#L5071" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5071</a></p>
<p>Defined in: <a href="https://github.com/podman-desktop/podman-desktop/blob/7e0b9fbb85b81cc94b19e32f536628b39afbafea/packages/extension-api/src/extension-api.d.ts#L5071" target="_blank" rel="noopener noreferrer" class="">packages/extension-api/src/extension-api.d.ts:5071</a></p>
<h2 class="anchor anchorTargetStickyNavbar_tleR" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no">​</a></h2>
<p><code>Promise</code>&lt;<code>void</code>&gt;</p></div></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToPod"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">navigateToPod</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/@podman-desktop/namespaces/navigation/functions/navigateToResources"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">navigateToResources</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="#returns" class="table-of-contents__link toc-highlight">Returns</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column 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="theme-layout-footer-column 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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></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 width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/orgs/podman-desktop/projects/4/views/3" target="_blank" rel="noopener noreferrer" class="footer__link-item">Current Sprint<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPrP"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="flex flex-col items-start text-left gap-4">

Some files were not shown because too many files have changed in this diff Show more