docker-documentation/images/docker-beets/index.html

32 wiersze
55 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-beets/ rel=canonical><link href=../docker-bazarr/ rel=prev><link href=../docker-blender/ rel=next><link rel=icon href="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media"><meta name=generator content="mkdocs-1.4.3, mkdocs-material-9.1.16"><title>beets - LinuxServer.io</title><link rel=stylesheet href=../../assets/stylesheets/main.26e3688c.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ecc896b0.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> <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script> <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=#linuxserverbeets class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class="md-header md-header--shadow" 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="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media" 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> beets </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_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></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_2> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3
<span class=nt>version</span><span class=p>:</span><span class=w> </span><span class=s>&quot;2.1&quot;</span>
<span class=nt>services</span><span class=p>:</span>
<span class=w> </span><span class=nt>beets</span><span class=p>:</span>
<span class=w> </span><span class=nt>image</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">lscr.io/linuxserver/beets:latest</span>
<span class=w> </span><span class=nt>container_name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">beets</span>
<span class=w> </span><span class=nt>environment</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">PUID=1000</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">PGID=1000</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">TZ=Etc/UTC</span>
<span class=w> </span><span class=nt>volumes</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">&lt;/path/to/appdata/config&gt;:/config</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">&lt;/path/to/music/library&gt;:/music</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">&lt;/path/to/ingest&gt;:/downloads</span>
<span class=w> </span><span class=nt>ports</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">8337:8337</span>
<span class=w> </span><span class=nt>restart</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">unless-stopped</span>
</code></pre></div> <h3 id=docker-cli-click-here-for-more-info>docker cli (<a href=https://docs.docker.com/engine/reference/commandline/cli/ >click here for more info</a>)</h3> <div class=highlight><pre><span></span><code>docker<span class=w> </span>run<span class=w> </span>-d<span class=w> </span><span class=se>\</span>
<span class=w> </span>--name<span class=o>=</span>beets<span class=w> </span><span class=se>\</span>
<span class=w> </span>-e<span class=w> </span><span class=nv>PUID</span><span class=o>=</span><span class=m>1000</span><span class=w> </span><span class=se>\</span>
<span class=w> </span>-e<span class=w> </span><span class=nv>PGID</span><span class=o>=</span><span class=m>1000</span><span class=w> </span><span class=se>\</span>
<span class=w> </span>-e<span class=w> </span><span class=nv>TZ</span><span class=o>=</span>Etc/UTC<span class=w> </span><span class=se>\</span>
<span class=w> </span>-p<span class=w> </span><span class=m>8337</span>:8337<span class=w> </span><span class=se>\</span>
<span class=w> </span>-v<span class=w> </span>&lt;/path/to/appdata/config&gt;:/config<span class=w> </span><span class=se>\</span>
<span class=w> </span>-v<span class=w> </span>&lt;/path/to/music/library&gt;:/music<span class=w> </span><span class=se>\</span>
<span class=w> </span>-v<span class=w> </span>&lt;/path/to/ingest&gt;:/downloads<span class=w> </span><span class=se>\</span>
<span class=w> </span>--restart<span class=w> </span>unless-stopped<span class=w> </span><span class=se>\</span>
<span class=w> </span>lscr.io/linuxserver/beets:latest
</code></pre></div> <h2 id=parameters>Parameters</h2> <p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code>&lt;external&gt;:&lt;internal&gt;</code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p> <h3 id=ports-p>Ports (<code>-p</code>)</h3> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>8337</code></td> <td>Application WebUI</td> </tr> </tbody> </table> <h3 id=environment-variables-e>Environment Variables (<code>-e</code>)</h3> <table> <thead> <tr> <th align=center>Env</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>PUID=1000</code></td> <td>for UserID - see below for explanation</td> </tr> <tr> <td align=center><code>PGID=1000</code></td> <td>for GroupID - see below for explanation</td> </tr> <tr> <td align=center><code>TZ=Etc/UTC</code></td> <td>specify a timezone to use, see this <a href=https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List>list</a>.</td> </tr> </tbody> </table> <h3 id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3> <table> <thead> <tr> <th align=center>Volume</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td align=center><code>/config</code></td> <td>Configuration files.</td> </tr> <tr> <td align=center><code>/music</code></td> <td>Music library</td> </tr> <tr> <td align=center><code>/downloads</code></td> <td>Non processed music</td> </tr> </tbody> </table> <h4 id=miscellaneous-options>Miscellaneous Options</h4> <table> <thead> <tr> <th align=center>Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td></td> <td></td> </tr> </tbody> </table> <h2 id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2> <p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p> <p>As an example:</p> <div class=highlight><pre><span></span><code>-e<span class=w> </span><span class=nv>FILE__PASSWORD</span><span class=o>=</span>/run/secrets/mysecretpassword
</code></pre></div> <p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p> <h2 id=umask-for-running-applications>Umask for running applications</h2> <p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <a href=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p> <h2 id=user-group-identifiers>User / Group Identifiers</h2> <p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p> <p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p> <p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p> <div class=highlight><pre><span></span><code><span class=w> </span>$<span class=w> </span>id<span class=w> </span>username
<span class=w> </span><span class=nv>uid</span><span class=o>=</span><span class=m>1000</span><span class=o>(</span>dockeruser<span class=o>)</span><span class=w> </span><span class=nv>gid</span><span class=o>=</span><span class=m>1000</span><span class=o>(</span>dockergroup<span class=o>)</span><span class=w> </span><span class=nv>groups</span><span class=o>=</span><span class=m>1000</span><span class=o>(</span>dockergroup<span class=o>)</span>
</code></pre></div> <h2 id=docker-mods>Docker Mods</h2> <p><a href="https://mods.linuxserver.io/?mod=beets" title="view available mods for this container."><img alt="Docker Mods" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=beets&query=%24.mods%5B%27beets%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a> <a href="https://mods.linuxserver.io/?mod=universal" title="view available universal mods."><img alt="Docker Universal Mods" src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p> <p>We publish various <a href=https://github.com/linuxserver/docker-mods>Docker Mods</a> to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.</p> <h2 id=support-info>Support Info</h2> <ul> <li>Shell access whilst the container is running:</li> <li><code>docker exec -it beets /bin/bash</code></li> <li>To monitor the logs of the container in realtime:</li> <li><code>docker logs -f beets</code></li> <li>Container version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' beets</code></li> <li>Image version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/beets:latest</code></li> </ul> <h2 id=versions>Versions</h2> <ul> <li><strong>25.03.23:</strong> - Add requests_oauthlib required for <a href=https://beets.readthedocs.io/en/stable/plugins/beatport.html>beatport plugin</a>.</li> <li><strong>24.02.23:</strong> - Rebase to Alpine 3.17, migrate to s6v3, install chromaprint from Alpine repos, add beetcamp plugin.</li> <li><strong>15.01.22:</strong> - Rebasing to alpine 3.15.</li> <li><strong>19.12.19:</strong> - Rebasing to alpine 3.11.</li> <li><strong>28.06.19:</strong> - Rebasing to alpine 3.10.</li> <li><strong>12.05.19:</strong> - Add flac and mp3val binaries required for badfiles plugin.</li> <li><strong>12.04.19:</strong> - Rebase to Alpine 3.9.</li> <li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li> <li><strong>11.03.19:</strong> - Swap copyartifacts for extrafiles, update endpoints with nightly tag.</li> <li><strong>01.03.19:</strong> - Switch to python3.</li> <li><strong>07.02.19:</strong> - Add fftw-dev build dependency for chromaprint.</li> <li><strong>28.01.19:</strong> - Add pipeline logic and multi arch.</li> <li><strong>15.08.18:</strong> - Rebase to alpine 3.8, use alpine repo version of pylast.</li> <li><strong>12.08.18:</strong> - Add requests pip package.</li> <li><strong>04.03.18:</strong> - Upgrade mp3gain to 1.6.1.</li> <li><strong>02.01.18:</strong> - Deprecate cpu_core routine lack of scaling.</li> <li><strong>27.12.17:</strong> - Add beautifulsoup4 pip package.</li> <li><strong>06.12.17:</strong> - Rebase to alpine linux 3.7.</li> <li><strong>25.05.17:</strong> - Rebase to alpine linux 3.6.</li> <li><strong>06.02.17:</strong> - Rebase to alpine linux 3.5.</li> <li><strong>16.01.17:</strong> - Add packages required for replaygain.</li> <li><strong>24.12.16:</strong> - Add <a href=https://github.com/sbarakat/beets-copyartifacts>beets-copyartifacts</a> plugin.</li> <li><strong>07.12.16:</strong> - Edit cmake options for chromaprint, should now build and install fpcalc, add gstreamer lib</li> <li><strong>14.10.16:</strong> - Add version layer information.</li> <li><strong>01.10.16:</strong> - Add nano and editor variable to allow editing of the config from the container command line.</li> <li><strong>30.09.16:</strong> - Fix umask.</li> <li><strong>24.09.16:</strong> - Rebase to alpine linux.</li> <li><strong>10.09.16:</strong> - Add layer badges to README.</li> <li><