Deployed f7fc67e with MkDocs version: 1.6.1

images/docker-speedtest-tracker/index.html

@@ -45,7 +45,7 @@
 </span><span id=__span-1-19><a id=__codelineno-1-19 name=__codelineno-1-19 href=#__codelineno-1-19></a><span class=w>  </span>-v<span class=w> </span>/path/to/speedtest-tracker/data:/config<span class=w> </span><span class=se>\</span>
 </span><span id=__span-1-20><a id=__codelineno-1-20 name=__codelineno-1-20 href=#__codelineno-1-20></a><span class=w>  </span>--restart<span class=w> </span>unless-stopped<span class=w> </span><span class=se>\</span>
 </span><span id=__span-1-21><a id=__codelineno-1-21 name=__codelineno-1-21 href=#__codelineno-1-21></a><span class=w>  </span>lscr.io/linuxserver/speedtest-tracker:latest
-</span></code></pre></div> <h2 id=parameters>Parameters<a class=headerlink href=#parameters title="Permanent link">&para;</a></h2> <p>Containers 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>)<a class=headerlink href=#ports-p title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th style="text-align: center;">Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>80:80</code></td> <td>Web UI</td> </tr> </tbody> </table> <h3 id=environment-variables-e>Environment Variables (<code>-e</code>)<a class=headerlink href=#environment-variables-e title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th style="text-align: center;">Env</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>PUID=1000</code></td> <td>for UserID - see below for explanation</td> </tr> <tr> <td style="text-align: center;"><code>PGID=1000</code></td> <td>for GroupID - see below for explanation</td> </tr> <tr> <td style="text-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> <tr> <td style="text-align: center;"><code>APP_KEY=</code></td> <td>App key used for encrypting stored data. You can generate a key at <a href=https://speedtest-tracker.dev>https://speedtest-tracker.dev</a></td> </tr> <tr> <td style="text-align: center;"><code>APP_URL=</code></td> <td>The IP:port or URL your application will be accessed on (ie. <code>http://192.168.1.1:6875</code> or <code>https://bookstack.mydomain.com</code></td> </tr> <tr> <td style="text-align: center;"><code>DB_CONNECTION=sqlite</code></td> <td>Set the database type to use. <code>sqlite</code>, <code>pgsql</code>, or <code>mysql</code></td> </tr> <tr> <td style="text-align: center;"><code>SPEEDTEST_SCHEDULE=</code></td> <td>Set the test schedule in cron format. e.g. <code>0 */6 * * *</code></td> </tr> <tr> <td style="text-align: center;"><code>SPEEDTEST_SERVERS=</code></td> <td>A comma-separated list of server IDs to test against. Run <code>docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers</code> to get a list of nearby servers.</td> </tr> <tr> <td style="text-align: center;"><code>DB_HOST=</code></td> <td>Database hostname (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_PORT=</code></td> <td>Database port (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_DATABASE=</code></td> <td>Database name (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_USERNAME=</code></td> <td>Database username (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_PASSWORD=</code></td> <td>Database password (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DISPLAY_TIMEZONE=Etc/UTC</code></td> <td>Timezone for the UI.</td> </tr> <tr> <td style="text-align: center;"><code>PRUNE_RESULTS_OLDER_THAN=0</code></td> <td>Days to keep test results.</td> </tr> </tbody> </table> <h3 id=volume-mappings-v>Volume Mappings (<code>-v</code>)<a class=headerlink href=#volume-mappings-v title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th style="text-align: center;">Volume</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>/config</code></td> <td>Contains speedtest-tracker config and database, if using sqlite.</td> </tr> </tbody> </table> <h4 id=miscellaneous-options>Miscellaneous Options<a class=headerlink href=#miscellaneous-options title="Permanent link">&para;</a></h4> <table> <thead> <tr> <th style="text-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)<a class=headerlink href=#environment-variables-from-files-docker-secrets title="Permanent link">&para;</a></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="language-bash highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>-e<span class=w> </span><span class=nv>FILE__MYVAR</span><span class=o>=</span>/run/secrets/mysecretvariable
+</span></code></pre></div> <h2 id=parameters>Parameters<a class=headerlink href=#parameters title="Permanent link">&para;</a></h2> <p>Containers 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>)<a class=headerlink href=#ports-p title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th style="text-align: center;">Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>80:80</code></td> <td>Web UI</td> </tr> </tbody> </table> <h3 id=environment-variables-e>Environment Variables (<code>-e</code>)<a class=headerlink href=#environment-variables-e title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th style="text-align: center;">Env</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>PUID=1000</code></td> <td>for UserID - see below for explanation</td> </tr> <tr> <td style="text-align: center;"><code>PGID=1000</code></td> <td>for GroupID - see below for explanation</td> </tr> <tr> <td style="text-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> <tr> <td style="text-align: center;"><code>APP_KEY=</code></td> <td>App key used for encrypting stored data. You can generate a key as per <a href=https://docs.speedtest-tracker.dev/getting-started/installation/using-docker-compose#install-with-docker-compose>https://speedtest-tracker.dev</a></td> </tr> <tr> <td style="text-align: center;"><code>APP_URL=</code></td> <td>The IP:port or URL your application will be accessed on (ie. <code>http://192.168.1.1:6875</code> or <code>https://bookstack.mydomain.com</code></td> </tr> <tr> <td style="text-align: center;"><code>DB_CONNECTION=sqlite</code></td> <td>Set the database type to use. <code>sqlite</code>, <code>pgsql</code>, or <code>mysql</code></td> </tr> <tr> <td style="text-align: center;"><code>SPEEDTEST_SCHEDULE=</code></td> <td>Set the test schedule in cron format. e.g. <code>0 */6 * * *</code></td> </tr> <tr> <td style="text-align: center;"><code>SPEEDTEST_SERVERS=</code></td> <td>A comma-separated list of server IDs to test against. Run <code>docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/speedtest-tracker:latest list-servers</code> to get a list of nearby servers.</td> </tr> <tr> <td style="text-align: center;"><code>DB_HOST=</code></td> <td>Database hostname (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_PORT=</code></td> <td>Database port (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_DATABASE=</code></td> <td>Database name (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_USERNAME=</code></td> <td>Database username (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DB_PASSWORD=</code></td> <td>Database password (postgres/mysql).</td> </tr> <tr> <td style="text-align: center;"><code>DISPLAY_TIMEZONE=Etc/UTC</code></td> <td>Timezone for the UI.</td> </tr> <tr> <td style="text-align: center;"><code>PRUNE_RESULTS_OLDER_THAN=0</code></td> <td>Days to keep test results.</td> </tr> </tbody> </table> <h3 id=volume-mappings-v>Volume Mappings (<code>-v</code>)<a class=headerlink href=#volume-mappings-v title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th style="text-align: center;">Volume</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>/config</code></td> <td>Contains speedtest-tracker config and database, if using sqlite.</td> </tr> </tbody> </table> <h4 id=miscellaneous-options>Miscellaneous Options<a class=headerlink href=#miscellaneous-options title="Permanent link">&para;</a></h4> <table> <thead> <tr> <th style="text-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)<a class=headerlink href=#environment-variables-from-files-docker-secrets title="Permanent link">&para;</a></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="language-bash highlight"><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1 href=#__codelineno-2-1></a>-e<span class=w> </span><span class=nv>FILE__MYVAR</span><span class=o>=</span>/run/secrets/mysecretvariable
 </span></code></pre></div> <p>Will set the environment variable <code>MYVAR</code> based on the contents of the <code>/run/secrets/mysecretvariable</code> file.</p> <h2 id=umask-for-running-applications>Umask for running applications<a class=headerlink href=#umask-for-running-applications title="Permanent link">&para;</a></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<a class=headerlink href=#user-group-identifiers title="Permanent link">&para;</a></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 your_user</code> as below:</p> <div class="language-bash highlight"><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>id<span class=w> </span>your_user
 </span></code></pre></div> <p>Example output:</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>uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 </span></code></pre></div> <h2 id=docker-mods>Docker Mods<a class=headerlink href=#docker-mods title="Permanent link">&para;</a></h2> <p><a href="https://mods.linuxserver.io/?mod=speedtest-tracker" 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=speedtest-tracker&query=%24.mods%5B%27speedtest-tracker%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<a class=headerlink href=#support-info title="Permanent link">&para;</a></h2> <ul> <li> <p>Shell access whilst the container is running:</p> <div class="language-bash highlight"><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1 href=#__codelineno-5-1></a>docker<span class=w> </span><span class=nb>exec</span><span class=w> </span>-it<span class=w> </span>speedtest-tracker<span class=w> </span>/bin/bash