mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
docker-documentation/images/docker-netbox/index.html

68 wiersze
53 KiB
HTML
Czysty Zwykły widok Historia

Deployed 0caeb93d with MkDocs version: 1.4.2
2023-01-07 23:55:34 +00:00
<!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-netbox/ rel=canonical><link rel=icon href="https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media"><meta name=generator content="mkdocs-1.4.2, mkdocs-material-8.5.10"><title>netbox - LinuxServer.io</title><link rel=stylesheet href=../../assets/stylesheets/main.975780f9.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.2505c338.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=#linuxservernetbox 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="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> netbox </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 3Z"/></svg> </label> </form> <label class="md-header__button md-icon" for=__search> <svg xmln
Deployed 28602349 with MkDocs version: 1.4.2
2022-12-02 02:14:39 +00:00
version: &quot;2.1&quot;
services:
netbox:
image: lscr.io/linuxserver/netbox:latest
container_name: netbox
environment:
- PUID=1000
- PGID=1000
- TZ=&lt;TZ&gt;
- SUPERUSER_EMAIL=&lt;SUPERUSER_EMAIL&gt;
- SUPERUSER_PASSWORD=&lt;SUPERUSER_PASSWORD&gt;
- ALLOWED_HOST=&lt;ALLOWED_HOST&gt;
- DB_NAME=&lt;DB_NAME&gt;
- DB_USER=&lt;DB_USER&gt;
- DB_PASSWORD=&lt;DB_PASSWORD&gt;
- DB_HOST=&lt;DB_HOST&gt;
- DB_PORT=&lt;DB_PORT&gt;
- REDIS_HOST=&lt;REDIS_HOST&gt;
- REDIS_PORT=&lt;REDIS_PORT&gt;
- REDIS_PASSWORD=&lt;REDIS_PASSWORD&gt;
- REDIS_DB_TASK=&lt;REDIS_DB_TASK&gt;
- REDIS_DB_CACHE=&lt;REDIS_DB_CACHE&gt;
- BASE_PATH=&lt;BASE_PATH&gt; #optional
- REMOTE_AUTH_ENABLED=&lt;REMOTE_AUTH_ENABLED&gt; #optional
- REMOTE_AUTH_BACKEND=&lt;REMOTE_AUTH_BACKEND&gt; #optional
- REMOTE_AUTH_HEADER=&lt;REMOTE_AUTH_HEADER&gt; #optional
- REMOTE_AUTH_AUTO_CREATE_USER=&lt;REMOTE_AUTH_AUTO_CREATE_USER&gt; #optional
- REMOTE_AUTH_DEFAULT_GROUPS=&lt;REMOTE_AUTH_DEFAULT_GROUPS&gt; #optional
- REMOTE_AUTH_DEFAULT_PERMISSIONS=&lt;REMOTE_AUTH_DEFAULT_PERMISSIONS&gt; #optional
volumes:
- &lt;path to data on host&gt;:/config
ports:
- 8000:8000
restart: unless-stopped
</code></pre> <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> <pre><code class=language-bash>docker run -d \
--name=netbox \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=&lt;TZ&gt; \
-e SUPERUSER_EMAIL=&lt;SUPERUSER_EMAIL&gt; \
-e SUPERUSER_PASSWORD=&lt;SUPERUSER_PASSWORD&gt; \
-e ALLOWED_HOST=&lt;ALLOWED_HOST&gt; \
-e DB_NAME=&lt;DB_NAME&gt; \
-e DB_USER=&lt;DB_USER&gt; \
-e DB_PASSWORD=&lt;DB_PASSWORD&gt; \
-e DB_HOST=&lt;DB_HOST&gt; \
-e DB_PORT=&lt;DB_PORT&gt; \
-e REDIS_HOST=&lt;REDIS_HOST&gt; \
-e REDIS_PORT=&lt;REDIS_PORT&gt; \
-e REDIS_PASSWORD=&lt;REDIS_PASSWORD&gt; \
-e REDIS_DB_TASK=&lt;REDIS_DB_TASK&gt; \
-e REDIS_DB_CACHE=&lt;REDIS_DB_CACHE&gt; \
-e BASE_PATH=&lt;BASE_PATH&gt; `#optional` \
-e REMOTE_AUTH_ENABLED=&lt;REMOTE_AUTH_ENABLED&gt; `#optional` \
-e REMOTE_AUTH_BACKEND=&lt;REMOTE_AUTH_BACKEND&gt; `#optional` \
-e REMOTE_AUTH_HEADER=&lt;REMOTE_AUTH_HEADER&gt; `#optional` \
-e REMOTE_AUTH_AUTO_CREATE_USER=&lt;REMOTE_AUTH_AUTO_CREATE_USER&gt; `#optional` \
-e REMOTE_AUTH_DEFAULT_GROUPS=&lt;REMOTE_AUTH_DEFAULT_GROUPS&gt; `#optional` \
-e REMOTE_AUTH_DEFAULT_PERMISSIONS=&lt;REMOTE_AUTH_DEFAULT_PERMISSIONS&gt; `#optional` \
-p 8000:8000 \
-v &lt;path to data on host&gt;:/config \
--restart unless-stopped \
lscr.io/linuxserver/netbox:latest
</code></pre> <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>8000</code></td> <td>will map the container's port 8000 to port 8000 on the host</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=&lt;TZ&gt;</code></td> <td>Timezone (i.e., America/New_York)</td> </tr> <tr> <td align=center><code>SUPERUSER_EMAIL=&lt;SUPERUSER_EMAIL&gt;</code></td> <td>Email address for <code>admin</code> account</td> </tr> <tr> <td align=center><code>SUPERUSER_PASSWORD=&lt;SUPERUSER_PASSWORD&gt;</code></td> <td>Password for <code>admin</code> account</td> </tr> <tr> <td align=center><code>ALLOWED_HOST=&lt;ALLOWED_HOST&gt;</code></td> <td>The hostname you will use to access the app (i.e., netbox.example.com)</td> </tr> <tr> <td align=center><code>DB_NAME=&lt;DB_NAME&gt;</code></td> <td>Database name (default: netbox)</td> </tr> <tr> <td align=center><code>DB_USER=&lt;DB_USER&gt;</code></td> <td>Database user</td> </tr> <tr> <td align=center><code>DB_PASSWORD=&lt;DB_PASSWORD&gt;</code></td> <td>Database password</td> </tr> <tr> <td align=center><code>DB_HOST=&lt;DB_HOST&gt;</code></td> <td>Database host (default: postgres)</td> </tr> <tr> <td align=center><code>DB_PORT=&lt;DB_PORT&gt;</code></td> <td>Database port (defaul: 5432)</td> </tr> <tr> <td align=center><code>REDIS_HOST=&lt;REDIS_HOST&gt;</code></td> <td>Redis host (default: redis)</td> </tr> <tr> <td align=center><code>REDIS_PORT=&lt;REDIS_PORT&gt;</code></td> <td>Redis port number (default: 6379)</td> </tr> <tr> <td align=center><code>REDIS_PASSWORD=&lt;REDIS_PASSWORD&gt;</code></td> <td>Redis password (default: none)</td> </tr> <tr> <td align=center><code>REDIS_DB_TASK=&lt;REDIS_DB_TASK&gt;</code></td> <td>Redis database ID for tasks (default: 0)</td> </tr> <tr> <td align=center><code>REDIS_DB_CACHE=&lt;REDIS_DB_CACHE&gt;</code></td> <td>Redis database ID for caching (default: 1)</td> </tr> <tr> <td align=center><code>BASE_PATH=&lt;BASE_PATH&gt;</code></td> <td>The path you will use to access the app (i.e., /netbox, optional, default: none)</td> </tr> <tr> <td align=center><code>REMOTE_AUTH_ENABLED=&lt;REMOTE_AUTH_ENABLED&gt;</code></td> <td>Enable remote authentication (optional, default: False)</td> </tr> <tr> <td align=center><code>REMOTE_AUTH_BACKEND=&lt;REMOTE_AUTH_BACKEND&gt;</code></td> <td>Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)</td> </tr> <tr> <td align=center><code>REMOTE_AUTH_HEADER=&lt;REMOTE_AUTH_HEADER&gt;</code></td> <td>Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)</td> </tr> <tr> <td align=center><code>REMOTE_AUTH_AUTO_CREATE_USER=&lt;REMOTE_AUTH_AUTO_CREATE_USER&gt;</code></td> <td>If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)</td> </tr> <tr> <td align=center><code>REMOTE_AUTH_DEFAULT_GROUPS=&lt;REMOTE_AUTH_DEFAULT_GROUPS&gt;</code></td> <td>The list of groups to assign a new user account when created using remote authentication (optional, default: [])</td> </tr> <tr> <td align=center><c
</code></pre> <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> <pre><code class=language-bash> $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Deployed 61bb67c0 with MkDocs version: 1.4.2
2022-12-02 02:18:29 +00:00
</code></pre> <h2 id=docker-mods>Docker Mods</h2> <p><a href="https://mods.linuxserver.io/?mod=netbox" 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=netbox&query=%24.mods%5B%27netbox%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 netbox /bin/bash</code></li> <li>To monitor the logs of the container in realtime:</li> <li><code>docker logs -f netbox</code></li> <li>Container version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox</code></li> <li>Image version number</li> <li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbox:latest</code></li> </ul> <h2 id=versions>Versions</h2> <ul> <li><strong>02.11.22:</strong> - Rebase to Alpine 3.16, migrate to s6v3.</li> <li><strong>01.08.22:</strong> - Remove py3-pillow, add tiff to fix deps.</li> <li><strong>26.07.22:</strong> - Add py3-pillow package back on arm to fix build issue.</li> <li><strong>10.12.21:</strong> - Remove py3-pillow package to fix dependency issue with 3.2.0.</li> <li><strong>10.12.21:</strong> - Rebase to Alpine 3.15.</li> <li><strong>26.04.21:</strong> - Added Redis database environment variables.</li> <li><strong>03.02.21:</strong> - Added remote authentication environment variables.</li> <li><strong>02.01.21:</strong> - Added BASE_PATH environment variable.</li> <li><strong>23.08.20:</strong> - Initial Release.</li> </ul> </article> </div> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../docker-netbootxyz/ class="md-footer__link md-footer__link--prev" aria-label="Previous: netbootxyz" rel=prev> <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> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> netbootxyz </div> </div> </a> <a href=../docker-nextcloud/ class="md-footer__link md-footer__link--next" aria-label="Next: nextcloud" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> nextcloud </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; 2022 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://github.com/linuxserver target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY