docker-documentation/images/docker-baseimage-kasmvnc/index.html

34 wiersze
77 KiB
HTML
Czysty Zwykły widok Historia

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Welcome to the home of the LinuxServer.io documentation!"><meta name=author content=LinuxServer.io><link href=https://docs.linuxserver.io/images/docker-baseimage-kasmvnc/ rel=canonical><link href=../docker-baseimage-fedora/ rel=prev><link href=../docker-baseimage-rdesktop/ rel=next><link rel=icon href=../../assets/favicon.ico><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.5.13"><title>baseimage-kasmvnc - LinuxServer.io</title><link rel=stylesheet href=../../assets/stylesheets/main.7e359304.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.06af60db.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=purple data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#kasmvnc-base-images-from-linuxserver class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title=LinuxServer.io class="md-header__button md-logo" aria-label=LinuxServer.io data-md-component=logo> <img src=../../assets/icon.svg alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> LinuxServer.io </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> baseimage-kasmvnc </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=purple data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=purple data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg> </label> </form> <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.me
</span><span id=__span-0-2><a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a>-e INSTALL_PACKAGES=font-noto-cjk
</span><span id=__span-0-3><a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a>-e LC_ALL=zh_CN.UTF-8
</span></code></pre></div> <p>The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled it will perform the same as a local Linux installation set to your locale.</p> <h1 id=available-distros>Available Distros<a class=headerlink href=#available-distros title="Permanent link">&para;</a></h1> <p>All base images are built for x86_64 and aarch64 platforms.</p> <table> <thead> <tr> <th style="text-align: center;">Distro</th> <th>Current Tag</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">Alpine</td> <td>alpine319</td> </tr> <tr> <td style="text-align: center;">Arch</td> <td>arch</td> </tr> <tr> <td style="text-align: center;">Debian</td> <td>debianbullseye</td> </tr> <tr> <td style="text-align: center;">Debian</td> <td>debianbookworm</td> </tr> <tr> <td style="text-align: center;">Fedora</td> <td>fedora39</td> </tr> <tr> <td style="text-align: center;">Ubuntu</td> <td>ubuntujammy</td> </tr> </tbody> </table> <h1 id=i-like-to-read-documentation>I like to read documentation<a class=headerlink href=#i-like-to-read-documentation title="Permanent link">&para;</a></h1> <h2 id=building-images>Building images<a class=headerlink href=#building-images title="Permanent link">&para;</a></h2> <h3 id=application-containers>Application containers<a class=headerlink href=#application-containers title="Permanent link">&para;</a></h3> <p>Included in these base images is a simple <a href=http://openbox.org/ >Openbox DE</a> and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile: </p> <div class="language-text highlight"><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a>FROM ghcr.io/linuxserver/baseimage-kasmvnc:alpine318
</span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a>RUN apk add --no-cache firefox
</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3 href=#__codelineno-1-3></a>COPY /root /
</span></code></pre></div> <p>And we can define the application to start using: </p> <div class="language-text highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>mkdir -p root/defaults
</span><span id=__span-2-2><a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a>echo &quot;firefox&quot; &gt; root/defaults/autostart
</span></code></pre></div> <p>Resulting in a folder that looks like this: </p> <div class="language-text highlight"><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>├── Dockerfile
</span><span id=__span-3-2><a id=__codelineno-3-2 name=__codelineno-3-2 href=#__codelineno-3-2></a>└── root
</span><span id=__span-3-3><a id=__codelineno-3-3 name=__codelineno-3-3 href=#__codelineno-3-3></a> └── defaults
</span><span id=__span-3-4><a id=__codelineno-3-4 name=__codelineno-3-4 href=#__codelineno-3-4></a> └── autostart
</span></code></pre></div> <p>Now build and test:</p> <div class="language-text highlight"><pre><span></span><code><span id=__span-4-1><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a>docker build -t firefox .
</span><span id=__span-4-2><a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a>docker run --rm -it -p 3000:3000 firefox bash
</span></code></pre></div> <p>On http://localhost:3000 you should be presented with a Firefox web browser interface.</p> <p>This similar setup can be used to embed any Linux Desktop application in a web accesible container.</p> <p><strong>If building images it is important to note that many application will not work inside of Docker without <code>--security-opt seccomp=unconfined</code>, they may have launch flags to not use syscalls blocked by Docker like with chromium based applications and <code>--no-sandbox</code>. In general do not expect every application will simply work like a native Linux installation without some modifications</strong></p> <h4 id=in-container-application-launching>In container application launching<a class=headerlink href=#in-container-application-launching title="Permanent link">&para;</a></h4> <p>Also included in the init logic is the ability to define application launchers. As the user has the ability to close the application or if they want to open multiple instances of it this can be useful. Here is an example of a menu definition file for Firefox:</p> <div class="language-text highlight"><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a>&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2 href=#__codelineno-5-2></a>&lt;openbox_menu xmlns=&quot;http://openbox.org/3.4/menu&quot;&gt;
</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3 href=#__codelineno-5-3></a>&lt;menu id=&quot;root-menu&quot; label=&quot;MENU&quot;&gt;
</span><span id=__span-5-4><a id=__codelineno-5-4 name=__codelineno-5-4 href=#__codelineno-5-4></a>&lt;item label=&quot;xterm&quot; icon=&quot;/usr/share/pixmaps/xterm-color_48x48.xpm&quot;&gt;&lt;action name=&quot;Execute&quot;&gt;&lt;command&gt;/usr/bin/xterm&lt;/command&gt;&lt;/action&gt;&lt;/item&gt;
</span><span id=__span-5-5><a id=__codelineno-5-5 name=__codelineno-5-5 href=#__codelineno-5-5></a>&lt;item label=&quot;FireFox&quot; icon=&quot;/usr/share/icons/hicolor/48x48/apps/firefox.png&quot;&gt;&lt;action name=&quot;Execute&quot;&gt;&lt;command&gt;/usr/bin/firefox&lt;/command&gt;&lt;/action&gt;&lt;/item&gt;
</span><span id=__span-5-6><a id=__codelineno-5-6 name=__codelineno-5-6 href=#__codelineno-5-6></a>&lt;/menu&gt;
</span><span id=__span-5-7><a id=__codelineno-5-7 name=__codelineno-5-7 href=#__codelineno-5-7></a>&lt;/openbox_menu&gt;
</span></code></pre></div> <p>Simply create this file and add it to your defaults folder as <code>menu.xml</code>: </p> <div class="language-text highlight"><pre><span></span><code><span id=__span-6-1><a id=__codelineno-6-1 name=__codelineno-6-1 href=#__codelineno-6-1></a>├── Dockerfile
</span><span id=__span-6-2><a id=__codelineno-6-2 name=__codelineno-6-2 href=#__codelineno-6-2></a>└── root
</span><span id=__span-6-3><a id=__codelineno-6-3 name=__codelineno-6-3 href=#__codelineno-6-3></a> └── defaults
</span><span id=__span-6-4><a id=__codelineno-6-4 name=__codelineno-6-4 href=#__codelineno-6-4></a> └── autostart
</span><span id=__span-6-5><a id=__codelineno-6-5 name=__codelineno-6-5 href=#__codelineno-6-5></a> └── menu.xml
</span></code></pre></div> <p>This allows users to right click the desktop background to launch the application.</p> <h3 id=full-desktop-environments>Full Desktop environments<a class=headerlink href=#full-desktop-environments title="Permanent link">&para;</a></h3> <p>When building an application container we are leveraging the Openbox DE to handle window management, but it is also possible to completely replace the DE that is launched on container init using the <code>startwm.sh</code> script, located again in defaults: </p> <div class="language-text highlight"><pre><span></span><code><span id=__span-7-1><a id=__codelineno-7-1 name=__codelineno-7-1 href=#__codelineno-7-1></a>├── Dockerfile
</span><span id=__span-7-2><a id=__codelineno-7-2 name=__codelineno-7-2 href=#__codelineno-7-2></a>└── root
</span><span id=__span-7-3><a id=__codelineno-7-3 name=__codelineno-7-3 href=#__codelineno-7-3></a> └── defaults
</span><span id=__span-7-4><a id=__codelineno-7-4 name=__codelineno-7-4 href=#__codelineno-7-4></a> └── startwm.sh
</span></code></pre></div> <p>If included in the build logic it will be launched in place of Openbox. Examples for this kind of configuration can be found in our <a href=https://github.com/linuxserver/docker-webtop>Webtop repository</a></p> <h3 id=kasm-workspaces-compatibility>Kasm Workspaces compatibility<a class=headerlink href=#kasm-workspaces-compatibility title="Permanent link">&para;</a></h3> <p>Included in these base images are binary blobs <code>/kasmbins</code> and a special init process <code>/kasminit</code> to maintain compatibility with <a href=https://www.kasmweb.com/ >Kasm Workspaces</a>, If using this base image as reccomended with the <code>startwm.sh</code> or <code>autostart</code> entrypoints. They will be able to be used on that platform without issue.</p> <h2 id=docker-in-docker-dind>Docker in Docker (DinD)<a class=headerlink href=#docker-in-docker-dind title="Permanent link">&para;</a></h2> <p>These base images include an installation of Docker that can be used in two ways. The simple method is simply leveraging the Docker/Docker Compose cli bins to manage the host level Docker installation by mounting in <code>-v /var/run/docker.sock:/var/run/docker.sock</code>. </p> <p>The base images can also run an isolated in container DinD setup simply by passing <code>--privileged</code> to the container when launching. If for any reason the application needs privilege but Docker is not wanted the <code>-e START_DOCKER=false</code> can be set at runtime or in the Dockerfile. In container Docker (DinD) will most likely use the fuse-overlayfs driver for storage which is not as fast as native overlay2. To increase perormance the <code>/var/lib/docker/</code> directory in the container can be mounted out to a Linux host and will use overlay2. Keep in mind Docker runs as root and the contents of this directory will not respect the PUID/PGID environment variables available on all LinuxServer.io containers.</p> <h2 id=dri3-gpu-acceleration>DRI3 GPU Acceleration<a class=headerlink href=#dri3-gpu-acceleration title="Permanent link">&para;</a></h2> <p>For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using: </p> <p><code>--device /dev/dri:/dev/dri</code></p> <p>This feature only supports <strong>Open Source</strong> GPU drivers:</p> <table> <thead> <tr> <th style="text-align: center;">Driver</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">Intel</td> <td>i965 and i915 drivers for Intel iGPU chipsets</td> </tr> <tr> <td style="text-align: center;">AMD</td> <td>AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets</td> </tr> <tr> <td style="text-align: center;">NVIDIA</td> <td>nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support</td> </tr> </tbody> </table> <p>The <code>DRINODE</code> environment variable can be used to point to a specific GPU. Up to date information can be found <a href=https://www.kasmweb.com/kasmvnc/docs/master/gpu_acceleration.html>here</a></p> <h3 id=display-compositing-desktop-effects>Display Compositing (desktop effects)<a class=headerlink href=#display-compositing-desktop-effects title="Permanent link">&para;</a></h3> <p>When using this image in tandem with a supported video card, compositing will function albeit with a performance hit when syncing the frames with pixmaps for the applications using it. This can greatly increase app compatibility if the application in question requires compositing, but requires a real GPU to be mounted into the container. By default we disable compositing at a DE level for performance reasons on our downstream images, but it can be enabled by the user and programs using compositing will still function even if the DE has it disabled in its settings. When building desktop images be sure you understand that with it enabled by default only users that have a compatible GPU mounted in will be able to use your image.</p> <h2 id=lossless>Lossless<a class=headerlink href=#lossless title="Permanent link">&para;</a></h2> <p>These images support all
</span><span id=__span-8-2><a id=__codelineno-8-2 name=__codelineno-8-2 href=#__codelineno-8-2></a>add_header &#39;Cross-Origin-Opener-Policy&#39; &#39;same-origin&#39;;
</span><span id=__span-8-3><a id=__codelineno-8-3 name=__codelineno-8-3 href=#__codelineno-8-3></a>add_header &#39;Cross-Origin-Resource-Policy&#39; &#39;same-site&#39;;
</span></code></pre></div> <p>More information <a href=https://www.kasmweb.com/docs/latest/how_to/lossless.html>here</a></p> <p>The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 11, 2024</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">March 9, 2019</span> </span> </aside> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../docker-baseimage-fedora/ class="md-footer__link md-footer__link--prev" aria-label="Previous: baseimage-fedora"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> baseimage-fedora </div> </div> </a> <a href=../docker-baseimage-rdesktop/ class="md-footer__link md-footer__link--next" aria-label="Next: baseimage-rdesktop"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> baseimage-rdesktop </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2024 LinuxServer.io </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://linuxserver.io target=_blank rel=noopener title=linuxserver.io class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 640 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m181.5 197.1 12.9 6.4c5.9 3 12.4 4.5 19.1 4.5 23.5 0 42.6-19.1 42.6-42.6V144c0-35.3-28.7-64-64-64H128c-35.3 0-64 28.7-64 64v21.4c0 23.5 19.1 42.6 42.6 42.6 6.6 0 13.1-1.5 19.1-4.5l12.9-6.4 8.4-4.2-11.9-7.9c-4.5-3-7.1-8-7.1-13.3V168c0-13.3 10.7-24 24-24h16c13.3 0 24 10.7 24 24v3.7c0 5.3-2.7 10.3-7.1 13.3l-11.8 7.9 8.4 4.2zm-8.6 49.4L160 240l-12.9 6.4c-12.6 6.3-26.5 9.6-40.5 9.6-3.6 0-7.1-.2-10.6-.6v.6c0 35.3 28.7 64 64 64h64c17.7 0 32 14.3 32 32s-14.3 3