├── root ├── etc │ └── s6-overlay │ │ └── s6-rc.d │ │ ├── svc-netbox │ │ ├── type │ │ ├── notification-fd │ │ ├── dependencies.d │ │ │ └── svc-netbox-prepare │ │ └── run │ │ ├── user │ │ └── contents.d │ │ │ ├── svc-netbox │ │ │ ├── init-netbox-config │ │ │ └── svc-netbox-prepare │ │ ├── init-netbox-config │ │ ├── type │ │ ├── dependencies.d │ │ │ └── init-config │ │ ├── up │ │ └── run │ │ ├── svc-netbox-prepare │ │ ├── type │ │ ├── dependencies.d │ │ │ └── init-services │ │ ├── up │ │ └── run │ │ └── init-config-end │ │ └── dependencies.d │ │ └── init-netbox-config └── defaults │ ├── uwsgi.ini │ └── configuration.py ├── .github ├── FUNDING.yml ├── workflows │ ├── permissions.yml │ ├── call_issues_cron.yml │ ├── call_issue_pr_tracker.yml │ ├── greetings.yml │ ├── external_trigger_scheduler.yml │ ├── package_trigger_scheduler.yml │ └── external_trigger.yml ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── issue.feature.yml │ └── issue.bug.yml ├── PULL_REQUEST_TEMPLATE.md └── CONTRIBUTING.md ├── .dockerignore ├── .gitattributes ├── .editorconfig ├── .gitignore ├── jenkins-vars.yml ├── Dockerfile ├── Dockerfile.aarch64 ├── readme-vars.yml ├── package_versions.txt ├── README.md ├── LICENSE └── Jenkinsfile /root/etc/s6-overlay/s6-rc.d/svc-netbox/type: -------------------------------------------------------------------------------- 1 | longrun 2 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/user/contents.d/svc-netbox: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/init-netbox-config/type: -------------------------------------------------------------------------------- 1 | oneshot 2 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox-prepare/type: -------------------------------------------------------------------------------- 1 | oneshot 2 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox/notification-fd: -------------------------------------------------------------------------------- 1 | 3 2 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/user/contents.d/init-netbox-config: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/user/contents.d/svc-netbox-prepare: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/init-netbox-config/dependencies.d/init-config: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox/dependencies.d/svc-netbox-prepare: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: linuxserver 2 | open_collective: linuxserver 3 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/init-config-end/dependencies.d/init-netbox-config: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox-prepare/dependencies.d/init-services: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/init-netbox-config/up: -------------------------------------------------------------------------------- 1 | /etc/s6-overlay/s6-rc.d/init-netbox-config/run 2 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox-prepare/up: -------------------------------------------------------------------------------- 1 | /etc/s6-overlay/s6-rc.d/svc-netbox-prepare/run 2 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | .gitignore 3 | .github 4 | .gitattributes 5 | READMETEMPLATE.md 6 | README.md 7 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bash 2 | # shellcheck shell=bash 3 | 4 | exec \ 5 | s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 8000" \ 6 | cd /app/netbox/netbox s6-setuidgid abc /usr/sbin/uwsgi uwsgi.ini 7 | -------------------------------------------------------------------------------- /.github/workflows/permissions.yml: -------------------------------------------------------------------------------- 1 | name: Permission check 2 | on: 3 | pull_request_target: 4 | paths: 5 | - '**/run' 6 | - '**/finish' 7 | - '**/check' 8 | - 'root/migrations/*' 9 | 10 | jobs: 11 | permission_check: 12 | uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1 13 | -------------------------------------------------------------------------------- /.github/workflows/call_issues_cron.yml: -------------------------------------------------------------------------------- 1 | name: Mark stale issues and pull requests 2 | on: 3 | schedule: 4 | - cron: '57 20 * * *' 5 | workflow_dispatch: 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | stale: 12 | permissions: 13 | issues: write 14 | pull-requests: write 15 | uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1 16 | secrets: inherit 17 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Discord chat support 4 | url: https://linuxserver.io/discord 5 | about: Realtime support / chat with the community and the team. 6 | 7 | - name: Discourse discussion forum 8 | url: https://discourse.linuxserver.io 9 | about: Post on our community forum. 10 | 11 | - name: Documentation 12 | url: https://docs.linuxserver.io/images/docker-netbox 13 | about: Documentation - information about all of our containers. 14 | -------------------------------------------------------------------------------- /root/defaults/uwsgi.ini: -------------------------------------------------------------------------------- 1 | [uwsgi] 2 | http-socket = :8000 3 | buffer-size = 32768 4 | enable-threads 5 | plugin = python3 6 | virtualenv = /lsiopy 7 | module = netbox.wsgi:application 8 | static-map = /static=static 9 | static-gzip-dir = static/CACHE 10 | static-index = index.html 11 | hook-pre-app = exec:python3 ./manage.py collectstatic --noinput 12 | hook-pre-app = exec:python3 ./manage.py remove_stale_contenttypes --no-input 13 | hook-pre-app = exec:python3 ./manage.py clearsessions 14 | attach-daemon = python3 ./manage.py rqworker 15 | -------------------------------------------------------------------------------- /.github/workflows/call_issue_pr_tracker.yml: -------------------------------------------------------------------------------- 1 | name: Issue & PR Tracker 2 | 3 | on: 4 | issues: 5 | types: [opened,reopened,labeled,unlabeled,closed] 6 | pull_request_target: 7 | types: [opened,reopened,review_requested,review_request_removed,labeled,unlabeled,closed] 8 | pull_request_review: 9 | types: [submitted,edited,dismissed] 10 | 11 | permissions: 12 | contents: read 13 | 14 | jobs: 15 | manage-project: 16 | permissions: 17 | issues: write 18 | uses: linuxserver/github-workflows/.github/workflows/issue-pr-tracker.yml@v1 19 | secrets: inherit 20 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # This file is globally distributed to all container image projects from 2 | # https://github.com/linuxserver/docker-jenkins-builder/blob/master/.editorconfig 3 | 4 | # top-most EditorConfig file 5 | root = true 6 | 7 | # Unix-style newlines with a newline ending every file 8 | [*] 9 | end_of_line = lf 10 | insert_final_newline = true 11 | # trim_trailing_whitespace may cause unintended issues and should not be globally set true 12 | trim_trailing_whitespace = false 13 | 14 | [{Dockerfile*,**.yml}] 15 | indent_style = space 16 | indent_size = 2 17 | 18 | [{**.sh,root/etc/s6-overlay/s6-rc.d/**,root/etc/cont-init.d/**,root/etc/services.d/**}] 19 | indent_style = space 20 | indent_size = 4 21 | -------------------------------------------------------------------------------- /.github/workflows/greetings.yml: -------------------------------------------------------------------------------- 1 | name: Greetings 2 | 3 | on: [pull_request_target, issues] 4 | 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | greeting: 10 | permissions: 11 | issues: write 12 | pull-requests: write 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/first-interaction@v1 16 | with: 17 | issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.' 18 | pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-netbox/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!' 19 | repo-token: ${{ secrets.GITHUB_TOKEN }} 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Windows image file caches 2 | Thumbs.db 3 | ehthumbs.db 4 | 5 | # Folder config file 6 | Desktop.ini 7 | 8 | # Recycle Bin used on file shares 9 | $RECYCLE.BIN/ 10 | 11 | # Windows Installer files 12 | *.cab 13 | *.msi 14 | *.msm 15 | *.msp 16 | 17 | # Windows shortcuts 18 | *.lnk 19 | 20 | # ========================= 21 | # Operating System Files 22 | # ========================= 23 | 24 | # OSX 25 | # ========================= 26 | 27 | .DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Thumbnails 32 | ._* 33 | 34 | # Files that might appear on external disk 35 | .Spotlight-V100 36 | .Trashes 37 | 38 | # Directories potentially created on remote AFP share 39 | .AppleDB 40 | .AppleDesktop 41 | Network Trash Folder 42 | Temporary Items 43 | .apdisk 44 | 45 | .history/ 46 | .jenkins-external 47 | -------------------------------------------------------------------------------- /jenkins-vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # jenkins variables 4 | project_name: docker-netbox 5 | external_type: github_stable 6 | release_type: stable 7 | release_tag: latest 8 | ls_branch: master 9 | repo_vars: 10 | - EXT_GIT_BRANCH = 'master' 11 | - EXT_USER = 'netbox-community' 12 | - EXT_REPO = 'netbox' 13 | - BUILD_VERSION_ARG = 'NETBOX_RELEASE' 14 | - LS_USER = 'linuxserver' 15 | - LS_REPO = 'docker-netbox' 16 | - CONTAINER_NAME = 'netbox' 17 | - DOCKERHUB_IMAGE = 'linuxserver/netbox' 18 | - DEV_DOCKERHUB_IMAGE = 'lsiodev/netbox' 19 | - PR_DOCKERHUB_IMAGE = 'lspipepr/netbox' 20 | - DIST_IMAGE = 'alpine' 21 | - MULTIARCH='true' 22 | - CI='true' 23 | - CI_WEB='false' 24 | - CI_PORT='8000' 25 | - CI_SSL='false' 26 | - CI_DELAY='120' 27 | - CI_DOCKERENV='' 28 | - CI_AUTH='' 29 | - CI_WEBPATH='' 30 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/issue.feature.yml: -------------------------------------------------------------------------------- 1 | # Based on the issue template 2 | name: Feature request 3 | description: Suggest an idea for this project 4 | title: "[FEAT] " 5 | labels: [enhancement] 6 | body: 7 | - type: checkboxes 8 | attributes: 9 | label: Is this a new feature request? 10 | description: Please search to see if a feature request already exists. 11 | options: 12 | - label: I have searched the existing issues 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Wanted change 17 | description: Tell us what you want to happen. 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Reason for change 23 | description: Justify your request, why do you want it, what is the benefit. 24 | validations: 25 | required: true 26 | - type: textarea 27 | attributes: 28 | label: Proposed code change 29 | description: Do you have a potential code change in mind? 30 | validations: 31 | required: false 32 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/svc-netbox-prepare/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bash 2 | # shellcheck shell=bash 3 | 4 | cd /app/netbox/netbox || exit 1 5 | 6 | s6-setuidgid abc python3 ./manage.py migrate 7 | 8 | if [[ -n "$SUPERUSER_EMAIL" ]] && [[ -n "$SUPERUSER_PASSWORD" ]]; then 9 | cat << EOF | s6-setuidgid abc python3 /app/netbox/netbox/manage.py shell 10 | from users.models import Token, User; 11 | 12 | username = 'admin'; 13 | password = '$SUPERUSER_PASSWORD'; 14 | email = '$SUPERUSER_EMAIL'; 15 | 16 | if not User.objects.filter(username='admin'): 17 | User.objects.create_superuser(username, email, password); 18 | print('Superuser created.'); 19 | else: 20 | print('Superuser creation skipped. Already exists.'); 21 | EOF 22 | fi 23 | 24 | # build docs 25 | if [[ ! -e "/app/netbox/netbox/project-static/docs/index.html" ]]; then 26 | cd /app/netbox || exit 1 27 | echo "Building local documentation" 28 | mkdocs build -q 29 | cd /app/netbox/netbox || exit 1 30 | fi 31 | 32 | # permissions 33 | lsiown -R abc:abc \ 34 | /app/netbox/netbox/static 35 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM ghcr.io/linuxserver/baseimage-alpine:3.20 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG NETBOX_RELEASE 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="alex-phillips" 11 | 12 | RUN \ 13 | echo "**** install build packages ****" && \ 14 | apk add --no-cache --upgrade --virtual=build-dependencies \ 15 | build-base \ 16 | cargo \ 17 | jpeg-dev \ 18 | libffi-dev \ 19 | libxslt-dev \ 20 | libxml2-dev \ 21 | openldap-dev \ 22 | openssl-dev \ 23 | postgresql-dev \ 24 | python3-dev \ 25 | zlib-dev && \ 26 | echo "**** install runtime packages ****" && \ 27 | apk add --no-cache --upgrade \ 28 | libldap \ 29 | postgresql-client \ 30 | python3 \ 31 | tiff \ 32 | uwsgi \ 33 | uwsgi-python && \ 34 | echo "**** install netbox ****" && \ 35 | mkdir -p /app/netbox && \ 36 | if [ -z ${NETBOX_RELEASE+x} ]; then \ 37 | NETBOX_RELEASE=$(curl -sX GET "https://api.github.com/repos/netbox-community/netbox/releases/latest" \ 38 | | awk '/tag_name/{print $4;exit}' FS='[""]'); \ 39 | fi && \ 40 | curl -o \ 41 | /tmp/netbox.tar.gz -L \ 42 | "https://github.com/netbox-community/netbox/archive/${NETBOX_RELEASE}.tar.gz" && \ 43 | tar xf \ 44 | /tmp/netbox.tar.gz -C \ 45 | /app/netbox/ --strip-components=1 && \ 46 | echo "**** install pip packages ****" && \ 47 | cd /app/netbox && \ 48 | python3 -m venv /lsiopy && \ 49 | pip install -U --no-cache-dir \ 50 | pip \ 51 | wheel && \ 52 | pip install --no-cache-dir --find-links https://wheel-index.linuxserver.io/alpine-3.20/ -r requirements.txt && \ 53 | pip install --no-cache-dir django-auth-ldap && \ 54 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 55 | echo "**** cleanup ****" && \ 56 | apk del --purge \ 57 | build-dependencies && \ 58 | rm -rf \ 59 | /tmp/* \ 60 | ${HOME}/.cargo \ 61 | ${HOME}/.cache 62 | 63 | # copy local files 64 | COPY root/ / 65 | 66 | # ports and volumes 67 | EXPOSE 8000 68 | 69 | VOLUME /config 70 | -------------------------------------------------------------------------------- /Dockerfile.aarch64: -------------------------------------------------------------------------------- 1 | # syntax=docker/dockerfile:1 2 | 3 | FROM ghcr.io/linuxserver/baseimage-alpine:arm64v8-3.20 4 | 5 | # set version label 6 | ARG BUILD_DATE 7 | ARG VERSION 8 | ARG NETBOX_RELEASE 9 | LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" 10 | LABEL maintainer="alex-phillips" 11 | 12 | RUN \ 13 | echo "**** install build packages ****" && \ 14 | apk add --no-cache --upgrade --virtual=build-dependencies \ 15 | build-base \ 16 | cargo \ 17 | jpeg-dev \ 18 | libffi-dev \ 19 | libxslt-dev \ 20 | libxml2-dev \ 21 | openldap-dev \ 22 | openssl-dev \ 23 | postgresql-dev \ 24 | python3-dev \ 25 | zlib-dev && \ 26 | echo "**** install runtime packages ****" && \ 27 | apk add --no-cache --upgrade \ 28 | libldap \ 29 | postgresql-client \ 30 | python3 \ 31 | tiff \ 32 | uwsgi \ 33 | uwsgi-python && \ 34 | echo "**** install netbox ****" && \ 35 | mkdir -p /app/netbox && \ 36 | if [ -z ${NETBOX_RELEASE+x} ]; then \ 37 | NETBOX_RELEASE=$(curl -sX GET "https://api.github.com/repos/netbox-community/netbox/releases/latest" \ 38 | | awk '/tag_name/{print $4;exit}' FS='[""]'); \ 39 | fi && \ 40 | curl -o \ 41 | /tmp/netbox.tar.gz -L \ 42 | "https://github.com/netbox-community/netbox/archive/${NETBOX_RELEASE}.tar.gz" && \ 43 | tar xf \ 44 | /tmp/netbox.tar.gz -C \ 45 | /app/netbox/ --strip-components=1 && \ 46 | echo "**** install pip packages ****" && \ 47 | cd /app/netbox && \ 48 | python3 -m venv /lsiopy && \ 49 | pip install -U --no-cache-dir \ 50 | pip \ 51 | wheel && \ 52 | pip install --no-cache-dir --find-links https://wheel-index.linuxserver.io/alpine-3.20/ -r requirements.txt && \ 53 | pip install --no-cache-dir django-auth-ldap && \ 54 | printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \ 55 | echo "**** cleanup ****" && \ 56 | apk del --purge \ 57 | build-dependencies && \ 58 | rm -rf \ 59 | /tmp/* \ 60 | ${HOME}/.cargo \ 61 | ${HOME}/.cache 62 | 63 | # copy local files 64 | COPY root/ / 65 | 66 | # ports and volumes 67 | EXPOSE 8000 68 | 69 | VOLUME /config 70 | -------------------------------------------------------------------------------- /root/etc/s6-overlay/s6-rc.d/init-netbox-config/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bash 2 | # shellcheck shell=bash 3 | 4 | mkdir -p \ 5 | /app/netbox/netbox/static \ 6 | /config/scripts 7 | 8 | declare -A NETBOX_CONF 9 | NETBOX_CONF[ALLOWED_HOST]=${ALLOWED_HOST:-netbox.example.com} 10 | NETBOX_CONF[BASE_PATH]=${BASE_PATH:-} 11 | NETBOX_CONF[DB_NAME]=${DB_NAME:-netbox} 12 | NETBOX_CONF[DB_USER]=${DB_USER:-root} 13 | NETBOX_CONF[DB_PASSWORD]=${DB_PASSWORD:-} 14 | NETBOX_CONF[DB_HOST]=${DB_HOST:-postgres} 15 | NETBOX_CONF[DB_PORT]=${DB_PORT:-} 16 | NETBOX_CONF[REDIS_HOST]=${REDIS_HOST:-redis} 17 | NETBOX_CONF[REDIS_PORT]=${REDIS_PORT:-6379} 18 | NETBOX_CONF[REDIS_PASSWORD]=${REDIS_PASSWORD:-} 19 | NETBOX_CONF[REDIS_DB_TASK]=${REDIS_DB_TASK:-0} 20 | NETBOX_CONF[REDIS_DB_CACHE]=${REDIS_DB_CACHE:-1} 21 | NETBOX_CONF[REMOTE_AUTH_ENABLED]=${REMOTE_AUTH_ENABLED:-False} 22 | NETBOX_CONF[REMOTE_AUTH_BACKEND]=${REMOTE_AUTH_BACKEND:-netbox.authentication.RemoteUserBackend} 23 | NETBOX_CONF[REMOTE_AUTH_HEADER]=${REMOTE_AUTH_HEADER:-HTTP_REMOTE_USER} 24 | NETBOX_CONF[REMOTE_AUTH_AUTO_CREATE_USER]=${REMOTE_AUTH_AUTO_CREATE_USER:-False} 25 | NETBOX_CONF[REMOTE_AUTH_DEFAULT_GROUPS]=${REMOTE_AUTH_DEFAULT_GROUPS:-[]} 26 | NETBOX_CONF[REMOTE_AUTH_DEFAULT_PERMISSIONS]=${REMOTE_AUTH_DEFAULT_PERMISSIONS:-{}} 27 | 28 | cd /app/netbox/netbox || exit 1 29 | 30 | NETBOX_CONF[SECRET_KEY]=${SECRET_KEY:-$(python3 ./generate_secret_key.py)} 31 | 32 | if [[ ! -f "/config/configuration.py" ]]; then 33 | cp /defaults/configuration.py /config/configuration.py 34 | 35 | # sed in values or skip if value not set 36 | for KEY in "${!NETBOX_CONF[@]}"; do \ 37 | sed -i 's|{{'$KEY'}}|'${NETBOX_CONF[$KEY]}'|g' /config/configuration.py 38 | done 39 | fi 40 | 41 | if [[ ! -e "/config/media" ]]; then 42 | mv /app/netbox/netbox/media /config/media 43 | fi 44 | 45 | rm -rf /app/netbox/netbox/media 46 | ln -sf /config/media /app/netbox/netbox/media 47 | 48 | ln -sf /config/configuration.py /app/netbox/netbox/netbox/configuration.py 49 | 50 | touch /config/ldap_config.py 51 | ln -sf /config/ldap_config.py /app/netbox/netbox/netbox/ldap_config.py 52 | 53 | mv /defaults/uwsgi.ini /app/netbox/netbox/uwsgi.ini > /dev/null 2>&1 54 | 55 | # permissions 56 | lsiown -R abc:abc \ 57 | /config 58 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/issue.bug.yml: -------------------------------------------------------------------------------- 1 | # Based on the issue template 2 | name: Bug report 3 | description: Create a report to help us improve 4 | title: "[BUG] <title>" 5 | labels: [Bug] 6 | body: 7 | - type: checkboxes 8 | attributes: 9 | label: Is there an existing issue for this? 10 | description: Please search to see if an issue already exists for the bug you encountered. 11 | options: 12 | - label: I have searched the existing issues 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Current Behavior 17 | description: Tell us what happens instead of the expected behavior. 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Expected Behavior 23 | description: Tell us what should happen. 24 | validations: 25 | required: false 26 | - type: textarea 27 | attributes: 28 | label: Steps To Reproduce 29 | description: Steps to reproduce the behavior. 30 | placeholder: | 31 | 1. In this environment... 32 | 2. With this config... 33 | 3. Run '...' 34 | 4. See error... 35 | validations: 36 | required: true 37 | - type: textarea 38 | attributes: 39 | label: Environment 40 | description: | 41 | examples: 42 | - **OS**: Ubuntu 20.04 43 | - **How docker service was installed**: distro's packagemanager 44 | value: | 45 | - OS: 46 | - How docker service was installed: 47 | render: markdown 48 | validations: 49 | required: false 50 | - type: dropdown 51 | attributes: 52 | label: CPU architecture 53 | options: 54 | - x86-64 55 | - arm64 56 | validations: 57 | required: true 58 | - type: textarea 59 | attributes: 60 | label: Docker creation 61 | description: | 62 | Command used to create docker container 63 | Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container 64 | render: bash 65 | validations: 66 | required: true 67 | - type: textarea 68 | attributes: 69 | description: | 70 | Provide a full docker log, output of "docker logs netbox" 71 | label: Container logs 72 | placeholder: | 73 | Output of `docker logs netbox` 74 | render: bash 75 | validations: 76 | required: true 77 | -------------------------------------------------------------------------------- /.github/workflows/external_trigger_scheduler.yml: -------------------------------------------------------------------------------- 1 | name: External Trigger Scheduler 2 | 3 | on: 4 | schedule: 5 | - cron: '57 * * * *' 6 | workflow_dispatch: 7 | 8 | permissions: 9 | contents: read 10 | 11 | jobs: 12 | external-trigger-scheduler: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4.1.1 16 | with: 17 | fetch-depth: '0' 18 | 19 | - name: External Trigger Scheduler 20 | run: | 21 | printf "# External trigger scheduler for docker-netbox\n\n" >> $GITHUB_STEP_SUMMARY 22 | printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY 23 | for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes) 24 | do 25 | if [[ "${br}" == "HEAD" ]]; then 26 | printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY 27 | continue 28 | fi 29 | printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY 30 | ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-netbox/${br}/jenkins-vars.yml) 31 | ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch') 32 | ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type') 33 | if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then 34 | echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY 35 | if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-netbox/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then 36 | echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY 37 | curl -iX POST \ 38 | -H "Authorization: token ${{ secrets.CR_PAT }}" \ 39 | -H "Accept: application/vnd.github.v3+json" \ 40 | -d "{\"ref\":\"refs/heads/${br}\"}" \ 41 | https://api.github.com/repos/linuxserver/docker-netbox/actions/workflows/external_trigger.yml/dispatches 42 | else 43 | echo "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY 44 | fi 45 | else 46 | echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY 47 | fi 48 | done 49 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | <!--- Provide a general summary of your changes in the Title above --> 2 | 3 | [linuxserverurl]: https://linuxserver.io 4 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] 5 | 6 | 7 | <!--- Before submitting a pull request please check the following --> 8 | 9 | <!--- If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR --> 10 | <!--- Ask yourself if this modification is something the whole userbase will benefit from, if this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ --> 11 | <!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message --> 12 | <!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message --> 13 | <!--- We maintain a changelog of major revisions to the container at the end of readme-vars.yml in the root of this repository, please add your changes there if appropriate --> 14 | 15 | 16 | <!--- Coding guidelines: --> 17 | <!--- 1. Installed packages in the Dockerfiles should be in alphabetical order --> 18 | <!--- 2. Changes to Dockerfile should be replicated in Dockerfile.armhf and Dockerfile.aarch64 if applicable --> 19 | <!--- 3. Indentation style (tabs vs 4 spaces vs 1 space) should match the rest of the document --> 20 | <!--- 4. Readme is auto generated from readme-vars.yml, make your changes there --> 21 | 22 | ------------------------------ 23 | 24 | - [ ] I have read the [contributing](https://github.com/linuxserver/docker-netbox/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications 25 | 26 | ------------------------------ 27 | 28 | <!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. --> 29 | 30 | ## Description: 31 | <!--- Describe your changes in detail --> 32 | 33 | ## Benefits of this PR and context: 34 | <!--- Please explain why we should accept this PR. If this fixes an outstanding bug, please reference the issue # --> 35 | 36 | ## How Has This Been Tested? 37 | <!--- Please describe in detail how you tested your changes. --> 38 | <!--- Include details of your testing environment, and the tests you ran to --> 39 | <!--- see how your change affects other areas of the code, etc. --> 40 | 41 | 42 | ## Source / References: 43 | <!--- Please include any forum posts/github links relevant to the PR --> 44 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to netbox 2 | 3 | ## Gotchas 4 | 5 | * While contributing make sure to make all your changes before creating a Pull Request, as our pipeline builds each commit after the PR is open. 6 | * Read, and fill the Pull Request template 7 | * If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR 8 | * If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message 9 | * If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://linuxserver.io/discord) 10 | 11 | ## Common files 12 | 13 | | File | Use case | 14 | | :----: | --- | 15 | | `Dockerfile` | Dockerfile used to build amd64 images | 16 | | `Dockerfile.aarch64` | Dockerfile used to build 64bit ARM architectures | 17 | | `Dockerfile.armhf` | Dockerfile used to build 32bit ARM architectures | 18 | | `Jenkinsfile` | This file is a product of our builder and should not be edited directly. This is used to build the image | 19 | | `jenkins-vars.yml` | This file is used to generate the `Jenkinsfile` mentioned above, it only affects the build-process | 20 | | `package_versions.txt` | This file is generated as a part of the build-process and should not be edited directly. It lists all the installed packages and their versions | 21 | | `README.md` | This file is a product of our builder and should not be edited directly. This displays the readme for the repository and image registries | 22 | | `readme-vars.yml` | This file is used to generate the `README.md` | 23 | 24 | ## Readme 25 | 26 | If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit. 27 | Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-netbox/edit/master/readme-vars.yml). 28 | 29 | These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play. 30 | Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-netbox) 31 | 32 | ### Fixing typos or clarify the text in the readme 33 | 34 | There are variables for multiple parts of the readme, the most common ones are: 35 | 36 | | Variable | Description | 37 | | :----: | --- | 38 | | `project_blurb` | This is the short excerpt shown above the project logo. | 39 | | `app_setup_block` | This is the text that shows up under "Application Setup" if enabled | 40 | 41 | ### Parameters 42 | 43 | The compose and run examples are also generated from these variables. 44 | 45 | We have a [reference file](https://github.com/linuxserver/docker-jenkins-builder/blob/master/vars/_container-vars-blank) in our Jenkins Builder. 46 | 47 | These are prefixed with `param_` for required parameters, or `opt_param` for optional parameters, except for `cap_add`. 48 | Remember to enable param, if currently disabled. This differs between parameters, and can be seen in the reference file. 49 | 50 | Devices, environment variables, ports and volumes expects its variables in a certain way. 51 | 52 | ### Devices 53 | 54 | ```yml 55 | param_devices: 56 | - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" } 57 | opt_param_devices: 58 | - { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" } 59 | ``` 60 | 61 | ### Environment variables 62 | 63 | ```yml 64 | param_env_vars: 65 | - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } 66 | opt_param_env_vars: 67 | - { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." } 68 | ``` 69 | 70 | ### Ports 71 | 72 | ```yml 73 | param_ports: 74 | - { external_port: "80", internal_port: "80", port_desc: "Application WebUI" } 75 | opt_param_ports: 76 | - { external_port: "80", internal_port: "80", port_desc: "Application WebUI" } 77 | ``` 78 | 79 | ### Volumes 80 | 81 | ```yml 82 | param_volumes: 83 | - { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." } 84 | opt_param_volumes: 85 | - { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." } 86 | ``` 87 | 88 | ### Testing template changes 89 | 90 | After you make any changes to the templates, you can use our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) to have the files updated from the modified templates. Please use the command found under `Running Locally` [on this page](https://github.com/linuxserver/docker-jenkins-builder/blob/master/README.md) to generate them prior to submitting a PR. 91 | 92 | ## Dockerfiles 93 | 94 | We use multiple Dockerfiles in our repos, this is because sometimes some CPU architectures needs different packages to work. 95 | If you are proposing additional packages to be added, ensure that you added the packages to all the Dockerfiles in alphabetical order. 96 | 97 | ### Testing your changes 98 | 99 | ```bash 100 | git clone https://github.com/linuxserver/docker-netbox.git 101 | cd docker-netbox 102 | docker build \ 103 | --no-cache \ 104 | --pull \ 105 | -t linuxserver/netbox:latest . 106 | ``` 107 | 108 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static` 109 | 110 | ```bash 111 | docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset 112 | ``` 113 | 114 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 115 | 116 | ## Update the changelog 117 | 118 | If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-netbox/tree/master/root), add an entry to the changelog 119 | 120 | ```yml 121 | changelogs: 122 | - { date: "DD.MM.YY:", desc: "Added some love to templates" } 123 | ``` 124 | -------------------------------------------------------------------------------- /.github/workflows/package_trigger_scheduler.yml: -------------------------------------------------------------------------------- 1 | name: Package Trigger Scheduler 2 | 3 | on: 4 | schedule: 5 | - cron: '29 15 * * 4' 6 | workflow_dispatch: 7 | 8 | permissions: 9 | contents: read 10 | 11 | jobs: 12 | package-trigger-scheduler: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4.1.1 16 | with: 17 | fetch-depth: '0' 18 | 19 | - name: Package Trigger Scheduler 20 | env: 21 | SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }} 22 | run: | 23 | printf "# Package trigger scheduler for docker-netbox\n\n" >> $GITHUB_STEP_SUMMARY 24 | printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY 25 | for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes) 26 | do 27 | if [[ "${br}" == "HEAD" ]]; then 28 | printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY 29 | continue 30 | fi 31 | printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY 32 | JENKINS_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-netbox/${br}/jenkins-vars.yml) 33 | if ! curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-netbox/${br}/Jenkinsfile >/dev/null 2>&1; then 34 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 35 | echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY 36 | skipped_branches="${skipped_branches}${br} " 37 | elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then 38 | echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY 39 | README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-netbox/${br}/readme-vars.yml) 40 | if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then 41 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 42 | echo "> Branch appears to be deprecated; skipping trigger." >> $GITHUB_STEP_SUMMARY 43 | skipped_branches="${skipped_branches}${br} " 44 | elif [[ $(yq -r '.skip_package_check' <<< "${JENKINS_VARS}") == "true" ]]; then 45 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 46 | echo "> Skipping branch ${br} due to \`skip_package_check\` being set in \`jenkins-vars.yml\`." >> $GITHUB_STEP_SUMMARY 47 | skipped_branches="${skipped_branches}${br} " 48 | elif grep -q "^netbox_${br}" <<< "${SKIP_PACKAGE_TRIGGER}"; then 49 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 50 | echo "> Github organizational variable \`SKIP_PACKAGE_TRIGGER\` contains \`netbox_${br}\`; skipping trigger." >> $GITHUB_STEP_SUMMARY 51 | skipped_branches="${skipped_branches}${br} " 52 | elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-netbox/job/${br}/lastBuild/api/json | jq -r '.building' 2>/dev/null) == "true" ]; then 53 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 54 | echo "> There already seems to be an active build on Jenkins; skipping package trigger for ${br}" >> $GITHUB_STEP_SUMMARY 55 | skipped_branches="${skipped_branches}${br} " 56 | else 57 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 58 | echo "> Triggering package trigger for branch ${br}" >> $GITHUB_STEP_SUMMARY 59 | printf "> To disable, add \`netbox_%s\` into the Github organizational variable \`SKIP_PACKAGE_TRIGGER\`.\n\n" "${br}" >> $GITHUB_STEP_SUMMARY 60 | triggered_branches="${triggered_branches}${br} " 61 | response=$(curl -iX POST \ 62 | https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-netbox/job/${br}/buildWithParameters?PACKAGE_CHECK=true \ 63 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|") 64 | if [[ -z "${response}" ]]; then 65 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 66 | echo "> Jenkins build could not be triggered. Skipping branch." 67 | continue 68 | fi 69 | echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY 70 | echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY 71 | sleep 10 72 | buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') 73 | buildurl="${buildurl%$'\r'}" 74 | echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY 75 | echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY 76 | if ! curl -ifX POST \ 77 | "${buildurl}submitDescription" \ 78 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ 79 | --data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ 80 | --data-urlencode "Submit=Submit"; then 81 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 82 | echo "> Unable to change the Jenkins job description." 83 | fi 84 | sleep 20 85 | fi 86 | else 87 | echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY 88 | fi 89 | done 90 | if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then 91 | if [[ -n "${triggered_branches}" ]]; then 92 | NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n" 93 | NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-netbox/activity/ \n" 94 | echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****" 95 | fi 96 | if [[ -n "${skipped_branches}" ]]; then 97 | NOTIFY_BRANCHES="${NOTIFY_BRANCHES}**Skipped:** ${skipped_branches} \n" 98 | fi 99 | echo "**** Notifying Discord ****" 100 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 101 | "description": "**Package Check Build(s) for netbox** \n'"${NOTIFY_BRANCHES}"''"${NOTIFY_BUILD_URL}"'"}], 102 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 103 | fi 104 | -------------------------------------------------------------------------------- /readme-vars.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # project information 4 | project_name: netbox 5 | project_url: "https://github.com/netbox-community/netbox" 6 | project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/netbox-logo.png" 7 | project_blurb: | 8 | [{{ project_name|capitalize }}]({{ project_url }}) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. 9 | project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" 10 | project_categories: "Administration,Business" 11 | # supported architectures 12 | available_architectures: 13 | - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"} 14 | - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} 15 | # container parameters 16 | param_container_name: "{{ project_name }}" 17 | param_usage_include_vols: true 18 | param_volumes: 19 | - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"} 20 | param_usage_include_env: true 21 | param_env_vars: 22 | - {env_var: "SUPERUSER_EMAIL", env_value: "", desc: "Email address for `admin` account"} 23 | - {env_var: "SUPERUSER_PASSWORD", env_value: "", desc: "Password for `admin` account"} 24 | - {env_var: "ALLOWED_HOST", env_value: "", desc: "The hostname you will use to access the app (i.e., netbox.example.com)"} 25 | - {env_var: "DB_NAME", env_value: "", desc: "Database name (default: netbox)"} 26 | - {env_var: "DB_USER", env_value: "", desc: "Database user"} 27 | - {env_var: "DB_PASSWORD", env_value: "", desc: "Database password"} 28 | - {env_var: "DB_HOST", env_value: "", desc: "Database host (default: postgres)"} 29 | - {env_var: "DB_PORT", env_value: "", desc: "Database port (default: 5432)"} 30 | - {env_var: "REDIS_HOST", env_value: "", desc: "Redis host (default: redis)"} 31 | - {env_var: "REDIS_PORT", env_value: "", desc: "Redis port number (default: 6379)"} 32 | - {env_var: "REDIS_PASSWORD", env_value: "", desc: "Redis password (default: none)"} 33 | - {env_var: "REDIS_DB_TASK", env_value: "", desc: "Redis database ID for tasks (default: 0)"} 34 | - {env_var: "REDIS_DB_CACHE", env_value: "", desc: "Redis database ID for caching (default: 1)"} 35 | opt_param_usage_include_env: true 36 | opt_param_env_vars: 37 | - {env_var: "BASE_PATH", env_value: "", desc: "The path you will use to access the app (i.e., /netbox, optional, default: none)"} 38 | - {env_var: "REMOTE_AUTH_ENABLED", env_value: "", desc: "Enable remote authentication (optional, default: False)"} 39 | - {env_var: "REMOTE_AUTH_BACKEND", env_value: "", desc: "Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)"} 40 | - {env_var: "REMOTE_AUTH_HEADER", env_value: "", desc: "Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)"} 41 | - {env_var: "REMOTE_AUTH_AUTO_CREATE_USER", env_value: "", desc: "If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)"} 42 | - {env_var: "REMOTE_AUTH_DEFAULT_GROUPS", env_value: "", desc: "The list of groups to assign a new user account when created using remote authentication (optional, default: [])"} 43 | - {env_var: "REMOTE_AUTH_DEFAULT_PERMISSIONS", env_value: "", desc: "A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})"} 44 | param_usage_include_ports: true 45 | param_ports: 46 | - {external_port: "8000", internal_port: "8000", port_desc: "will map the container's port 8000 to port 8000 on the host"} 47 | # application setup block 48 | app_setup_block_enabled: true 49 | app_setup_block: | 50 | Netbox requires a postgres database and a redis instance. 51 | 52 | Access the WebUI at <your-ip>:8000. For more information, check out [NetBox](https://github.com/netbox-community/netbox). 53 | # init diagram 54 | init_diagram: | 55 | "netbox:latest": { 56 | docker-mods 57 | base { 58 | fix-attr +\nlegacy cont-init 59 | } 60 | docker-mods -> base 61 | legacy-services 62 | custom services 63 | init-services -> legacy-services 64 | init-services -> custom services 65 | custom services -> legacy-services 66 | legacy-services -> ci-service-check 67 | init-migrations -> init-adduser 68 | init-os-end -> init-config 69 | init-config -> init-config-end 70 | init-netbox-config -> init-config-end 71 | init-os-end -> init-crontab-config 72 | init-mods-end -> init-custom-files 73 | init-adduser -> init-device-perms 74 | base -> init-envfile 75 | base -> init-migrations 76 | base -> init-mods 77 | init-config-end -> init-mods 78 | init-mods -> init-mods-end 79 | init-mods-package-install -> init-mods-end 80 | init-mods -> init-mods-package-install 81 | init-config -> init-netbox-config 82 | base -> init-os-end 83 | init-adduser -> init-os-end 84 | init-device-perms -> init-os-end 85 | init-envfile -> init-os-end 86 | init-migrations -> init-os-end 87 | init-custom-files -> init-services 88 | init-mods-end -> init-services 89 | init-services -> svc-cron 90 | svc-cron -> legacy-services 91 | svc-netbox-prepare -> svc-netbox 92 | svc-netbox -> legacy-services 93 | init-services -> svc-netbox-prepare 94 | svc-netbox-prepare -> legacy-services 95 | } 96 | Base Images: { 97 | "baseimage-alpine:3.20" 98 | } 99 | "netbox:latest" <- Base Images 100 | # changelog 101 | changelogs: 102 | - {date: "26.08.24:", desc: "Restructure init to allow for plugins as mods."} 103 | - {date: "16.07.24:", desc: "Add required packages for LDAP support."} 104 | - {date: "01.06.24:", desc: "Rebase to Alpine 3.20."} 105 | - {date: "23.12.23:", desc: "Rebase to Alpine 3.19."} 106 | - {date: "11.06.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."} 107 | - {date: "14.05.23:", desc: "Build local docs on first run."} 108 | - {date: "05.03.23:", desc: "Rebase to Alpine 3.17."} 109 | - {date: "02.11.22:", desc: "Rebase to Alpine 3.16, migrate to s6v3."} 110 | - {date: "01.08.22:", desc: "Remove py3-pillow, add tiff to fix deps."} 111 | - {date: "26.07.22:", desc: "Add py3-pillow package back on arm to fix build issue."} 112 | - {date: "10.12.21:", desc: "Remove py3-pillow package to fix dependency issue with 3.2.0."} 113 | - {date: "10.12.21:", desc: "Rebase to Alpine 3.15."} 114 | - {date: "26.04.21:", desc: "Added Redis database environment variables."} 115 | - {date: "03.02.21:", desc: "Added remote authentication environment variables."} 116 | - {date: "02.01.21:", desc: "Added BASE_PATH environment variable."} 117 | - {date: "23.08.20:", desc: "Initial Release."} 118 | -------------------------------------------------------------------------------- /.github/workflows/external_trigger.yml: -------------------------------------------------------------------------------- 1 | name: External Trigger Main 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | permissions: 7 | contents: read 8 | 9 | jobs: 10 | external-trigger-master: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v4.1.1 14 | 15 | - name: External Trigger 16 | if: github.ref == 'refs/heads/master' 17 | env: 18 | SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }} 19 | run: | 20 | printf "# External trigger for docker-netbox\n\n" >> $GITHUB_STEP_SUMMARY 21 | if grep -q "^netbox_master_" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 22 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 23 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`netbox_master_\`; will skip trigger if version matches." >> $GITHUB_STEP_SUMMARY 24 | elif grep -q "^netbox_master" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 25 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 26 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`netbox_master\`; skipping trigger." >> $GITHUB_STEP_SUMMARY 27 | exit 0 28 | fi 29 | echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY 30 | echo "> External trigger running off of master branch. To disable this trigger, add \`netbox_master\` into the Github organizational variable \`SKIP_EXTERNAL_TRIGGER\`." >> $GITHUB_STEP_SUMMARY 31 | printf "\n## Retrieving external version\n\n" >> $GITHUB_STEP_SUMMARY 32 | EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/netbox-community/netbox/releases/latest" | jq -r '. | .tag_name') 33 | echo "Type is \`github_stable\`" >> $GITHUB_STEP_SUMMARY 34 | if grep -q "^netbox_master_${EXT_RELEASE}" <<< "${SKIP_EXTERNAL_TRIGGER}"; then 35 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 36 | echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` matches current external release; skipping trigger." >> $GITHUB_STEP_SUMMARY 37 | exit 0 38 | fi 39 | if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then 40 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 41 | echo "> Can't retrieve external version, exiting" >> $GITHUB_STEP_SUMMARY 42 | FAILURE_REASON="Can't retrieve external version for netbox branch master" 43 | GHA_TRIGGER_URL="https://github.com/linuxserver/docker-netbox/actions/runs/${{ github.run_id }}" 44 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, 45 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n**Trigger URL:** '"${GHA_TRIGGER_URL}"' \n"}], 46 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 47 | exit 1 48 | fi 49 | EXT_RELEASE_SANITIZED=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g') 50 | echo "Sanitized external version: \`${EXT_RELEASE_SANITIZED}\`" >> $GITHUB_STEP_SUMMARY 51 | echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY 52 | image="linuxserver/netbox" 53 | tag="latest" 54 | token=$(curl -sX GET \ 55 | "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fnetbox%3Apull" \ 56 | | jq -r '.token') 57 | multidigest=$(curl -s \ 58 | --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ 59 | --header "Accept: application/vnd.oci.image.index.v1+json" \ 60 | --header "Authorization: Bearer ${token}" \ 61 | "https://ghcr.io/v2/${image}/manifests/${tag}") 62 | if jq -e '.layers // empty' <<< "${multidigest}" >/dev/null 2>&1; then 63 | # If there's a layer element it's a single-arch manifest so just get that digest 64 | digest=$(jq -r '.config.digest' <<< "${multidigest}") 65 | else 66 | # Otherwise it's multi-arch or has manifest annotations 67 | if jq -e '.manifests[]?.annotations // empty' <<< "${multidigest}" >/dev/null 2>&1; then 68 | # Check for manifest annotations and delete if found 69 | multidigest=$(jq 'del(.manifests[] | select(.annotations))' <<< "${multidigest}") 70 | fi 71 | if [[ $(jq '.manifests | length' <<< "${multidigest}") -gt 1 ]]; then 72 | # If there's still more than one digest, it's multi-arch 73 | multidigest=$(jq -r ".manifests[] | select(.platform.architecture == \"amd64\").digest?" <<< "${multidigest}") 74 | else 75 | # Otherwise it's single arch 76 | multidigest=$(jq -r ".manifests[].digest?" <<< "${multidigest}") 77 | fi 78 | if digest=$(curl -s \ 79 | --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \ 80 | --header "Accept: application/vnd.oci.image.manifest.v1+json" \ 81 | --header "Authorization: Bearer ${token}" \ 82 | "https://ghcr.io/v2/${image}/manifests/${multidigest}"); then 83 | digest=$(jq -r '.config.digest' <<< "${digest}"); 84 | fi 85 | fi 86 | image_info=$(curl -sL \ 87 | --header "Authorization: Bearer ${token}" \ 88 | "https://ghcr.io/v2/${image}/blobs/${digest}") 89 | if [[ $(echo $image_info | jq -r '.container_config') == "null" ]]; then 90 | image_info=$(echo $image_info | jq -r '.config') 91 | else 92 | image_info=$(echo $image_info | jq -r '.container_config') 93 | fi 94 | IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}') 95 | IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}') 96 | if [ -z "${IMAGE_VERSION}" ]; then 97 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 98 | echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY 99 | FAILURE_REASON="Can't retrieve last pushed version for netbox tag latest" 100 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680, 101 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 102 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 103 | exit 1 104 | fi 105 | echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY 106 | if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then 107 | echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY 108 | exit 0 109 | elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-netbox/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then 110 | echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY 111 | exit 0 112 | else 113 | if [[ "${artifacts_found}" == "false" ]]; then 114 | echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY 115 | echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY 116 | FAILURE_REASON="New version ${EXT_RELEASE} for netbox tag latest is detected, however not all artifacts are uploaded to upstream release yet. Will try again later." 117 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 118 | "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}], 119 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 120 | else 121 | printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY 122 | echo "New sanitized version \`${EXT_RELEASE_SANITIZED}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY 123 | if [[ "${artifacts_found}" == "true" ]]; then 124 | echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY 125 | fi 126 | response=$(curl -iX POST \ 127 | https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-netbox/job/master/buildWithParameters?PACKAGE_CHECK=false \ 128 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|") 129 | echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY 130 | echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY 131 | sleep 10 132 | buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url') 133 | buildurl="${buildurl%$'\r'}" 134 | echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY 135 | echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY 136 | curl -iX POST \ 137 | "${buildurl}submitDescription" \ 138 | --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \ 139 | --data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \ 140 | --data-urlencode "Submit=Submit" 141 | echo "**** Notifying Discord ****" 142 | TRIGGER_REASON="A version change was detected for netbox tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE_SANITIZED}" 143 | curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903, 144 | "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}], 145 | "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }} 146 | fi 147 | fi 148 | -------------------------------------------------------------------------------- /root/defaults/configuration.py: -------------------------------------------------------------------------------- 1 | ######################### 2 | # # 3 | # Required settings # 4 | # # 5 | ######################### 6 | 7 | # This is a list of valid fully-qualified domain names (FQDNs) for the NetBox server. NetBox will not permit write 8 | # access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name. 9 | # 10 | # Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local'] 11 | ALLOWED_HOSTS = ['{{ALLOWED_HOST}}'] 12 | 13 | # PostgreSQL database configuration. See the Django documentation for a complete list of available parameters: 14 | # https://docs.djangoproject.com/en/stable/ref/settings/#databases 15 | DATABASE = { 16 | 'NAME': '{{DB_NAME}}', # Database name 17 | 'USER': '{{DB_USER}}', # PostgreSQL username 18 | 'PASSWORD': '{{DB_PASSWORD}}', # PostgreSQL password 19 | 'HOST': '{{DB_HOST}}', # Database server 20 | 'PORT': '{{DB_PORT}}', # Database port (leave blank for default) 21 | 'CONN_MAX_AGE': 300, # Max database connection age 22 | } 23 | 24 | # Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate 25 | # configuration exists for each. Full connection details are required in both sections, and it is strongly recommended 26 | # to use two separate database IDs. 27 | REDIS = { 28 | 'tasks': { 29 | 'HOST': '{{REDIS_HOST}}', 30 | 'PORT': {{REDIS_PORT}}, 31 | # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel 32 | # 'SENTINELS': [('mysentinel.redis.example.com', 6379)], 33 | # 'SENTINEL_SERVICE': 'netbox', 34 | 'PASSWORD': '{{REDIS_PASSWORD}}', 35 | 'DATABASE': {{REDIS_DB_TASK}}, 36 | 'SSL': False, 37 | # Set this to True to skip TLS certificate verification 38 | # This can expose the connection to attacks, be careful 39 | # 'INSECURE_SKIP_TLS_VERIFY': False, 40 | }, 41 | 'caching': { 42 | 'HOST': '{{REDIS_HOST}}', 43 | 'PORT': {{REDIS_PORT}}, 44 | # Comment out `HOST` and `PORT` lines and uncomment the following if using Redis Sentinel 45 | # 'SENTINELS': [('mysentinel.redis.example.com', 6379)], 46 | # 'SENTINEL_SERVICE': 'netbox', 47 | 'PASSWORD': '{{REDIS_PASSWORD}}', 48 | 'DATABASE': {{REDIS_DB_CACHE}}, 49 | 'SSL': False, 50 | # Set this to True to skip TLS certificate verification 51 | # This can expose the connection to attacks, be careful 52 | # 'INSECURE_SKIP_TLS_VERIFY': False, 53 | } 54 | } 55 | 56 | # This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file. 57 | # For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and 58 | # symbols. NetBox will not run without this defined. For more information, see 59 | # https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY 60 | SECRET_KEY = '{{SECRET_KEY}}' 61 | 62 | 63 | ######################### 64 | # # 65 | # Optional settings # 66 | # # 67 | ######################### 68 | 69 | # Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of 70 | # application errors (assuming correct email settings are provided). 71 | ADMINS = [ 72 | # ('John Doe', 'jdoe@example.com'), 73 | ] 74 | 75 | # URL schemes that are allowed within links in NetBox 76 | ALLOWED_URL_SCHEMES = ( 77 | 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp', 78 | ) 79 | 80 | # Optionally display a persistent banner at the top and/or bottom of every page. HTML is allowed. To display the same 81 | # content in both banners, define BANNER_TOP and set BANNER_BOTTOM = BANNER_TOP. 82 | BANNER_TOP = '' 83 | BANNER_BOTTOM = '' 84 | 85 | # Text to include on the login page above the login form. HTML is allowed. 86 | BANNER_LOGIN = '' 87 | 88 | # Base URL path if accessing NetBox within a directory. For example, if installed at https://example.com/netbox/, set: 89 | # BASE_PATH = 'netbox/' 90 | BASE_PATH = '{{BASE_PATH}}' 91 | 92 | # Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90) 93 | CHANGELOG_RETENTION = 90 94 | 95 | # API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be 96 | # allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or 97 | # CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers 98 | CORS_ORIGIN_ALLOW_ALL = False 99 | CORS_ORIGIN_WHITELIST = [ 100 | # 'https://hostname.example.com', 101 | ] 102 | CORS_ORIGIN_REGEX_WHITELIST = [ 103 | # r'^(https?://)?(\w+\.)?example\.com$', 104 | ] 105 | 106 | # Specify any custom validators here, as a mapping of model to a list of validators classes. Validators should be 107 | # instances of or inherit from CustomValidator. 108 | # from extras.validators import CustomValidator 109 | CUSTOM_VALIDATORS = { 110 | # 'dcim.site': [ 111 | # CustomValidator({ 112 | # 'name': { 113 | # 'min_length': 10, 114 | # 'regex': r'\d{3}$', 115 | # } 116 | # }) 117 | # ], 118 | } 119 | 120 | # Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal 121 | # sensitive information about your installation. Only enable debugging while performing testing. Never enable debugging 122 | # on a production system. 123 | DEBUG = False 124 | 125 | # Email settings 126 | EMAIL = { 127 | 'SERVER': 'localhost', 128 | 'PORT': 25, 129 | 'USERNAME': '', 130 | 'PASSWORD': '', 131 | 'USE_SSL': False, 132 | 'USE_TLS': False, 133 | 'TIMEOUT': 10, # seconds 134 | 'FROM_EMAIL': '', 135 | } 136 | 137 | # Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table 138 | # (all prefixes and IP addresses not assigned to a VRF), set ENFORCE_GLOBAL_UNIQUE to True. 139 | ENFORCE_GLOBAL_UNIQUE = False 140 | 141 | # Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and 142 | # by anonymous users. List models in the form `<app>.<model>`. Add '*' to this list to exempt all models. 143 | EXEMPT_VIEW_PERMISSIONS = [ 144 | # 'dcim.site', 145 | # 'dcim.region', 146 | # 'ipam.prefix', 147 | ] 148 | 149 | # Enable the GraphQL API 150 | GRAPHQL_ENABLED = True 151 | 152 | # HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for webhooks). 153 | # HTTP_PROXIES = { 154 | # 'http': 'http://10.10.1.10:3128', 155 | # 'https': 'http://10.10.1.10:1080', 156 | # } 157 | 158 | # IP addresses recognized as internal to the system. The debugging toolbar will be available only to clients accessing 159 | # NetBox from an internal IP. 160 | INTERNAL_IPS = ('127.0.0.1', '::1') 161 | 162 | # Enable custom logging. Please see the Django documentation for detailed guidance on configuring custom logs: 163 | # https://docs.djangoproject.com/en/stable/topics/logging/ 164 | LOGGING = {} 165 | 166 | # Automatically reset the lifetime of a valid session upon each authenticated request. Enables users to remain 167 | # authenticated to NetBox indefinitely. 168 | LOGIN_PERSISTENCE = False 169 | 170 | # Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users 171 | # are permitted to access most data in NetBox but not make any changes. 172 | LOGIN_REQUIRED = False 173 | 174 | # The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to 175 | # re-authenticate. (Default: 1209600 [14 days]) 176 | LOGIN_TIMEOUT = None 177 | 178 | # Setting this to True will display a "maintenance mode" banner at the top of every page. 179 | MAINTENANCE_MODE = False 180 | 181 | # The URL to use when mapping physical addresses or GPS coordinates 182 | MAPS_URL = 'https://maps.google.com/?q=' 183 | 184 | # An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g. 185 | # "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request 186 | # all objects by specifying "?limit=0". 187 | MAX_PAGE_SIZE = 1000 188 | 189 | # The file path where uploaded media such as image attachments are stored. A trailing slash is not needed. Note that 190 | # the default value of this setting is derived from the installed location. 191 | # MEDIA_ROOT = '/opt/netbox/netbox/media' 192 | 193 | # By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the 194 | # class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example: 195 | # STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage' 196 | # STORAGE_CONFIG = { 197 | # 'AWS_ACCESS_KEY_ID': 'Key ID', 198 | # 'AWS_SECRET_ACCESS_KEY': 'Secret', 199 | # 'AWS_STORAGE_BUCKET_NAME': 'netbox', 200 | # 'AWS_S3_REGION_NAME': 'eu-west-1', 201 | # } 202 | 203 | # Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics' 204 | METRICS_ENABLED = False 205 | 206 | # Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM. 207 | NAPALM_USERNAME = '' 208 | NAPALM_PASSWORD = '' 209 | 210 | # NAPALM timeout (in seconds). (Default: 30) 211 | NAPALM_TIMEOUT = 30 212 | 213 | # NAPALM optional arguments (see https://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must 214 | # be provided as a dictionary. 215 | NAPALM_ARGS = {} 216 | 217 | # Determine how many objects to display per page within a list. (Default: 50) 218 | PAGINATE_COUNT = 50 219 | 220 | # Enable installed plugins. Add the name of each plugin to the list. 221 | PLUGINS = [] 222 | 223 | # Plugins configuration settings. These settings are used by various plugins that the user may have installed. 224 | # Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings. 225 | # PLUGINS_CONFIG = { 226 | # 'my_plugin': { 227 | # 'foo': 'bar', 228 | # 'buzz': 'bazz' 229 | # } 230 | # } 231 | 232 | # When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to 233 | # prefer IPv4 instead. 234 | PREFER_IPV4 = False 235 | 236 | # Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1. 237 | RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = 22 238 | RACK_ELEVATION_DEFAULT_UNIT_WIDTH = 220 239 | 240 | # Remote authentication support 241 | REMOTE_AUTH_ENABLED = {{REMOTE_AUTH_ENABLED}} 242 | REMOTE_AUTH_BACKEND = '{{REMOTE_AUTH_BACKEND}}' 243 | REMOTE_AUTH_HEADER = '{{REMOTE_AUTH_HEADER}}' 244 | REMOTE_AUTH_AUTO_CREATE_USER = {{REMOTE_AUTH_AUTO_CREATE_USER}} 245 | REMOTE_AUTH_DEFAULT_GROUPS = {{REMOTE_AUTH_DEFAULT_GROUPS}} 246 | REMOTE_AUTH_DEFAULT_PERMISSIONS = {{REMOTE_AUTH_DEFAULT_PERMISSIONS}} 247 | 248 | # This repository is used to check whether there is a new release of NetBox available. Set to None to disable the 249 | # version check or use the URL below to check for release in the official NetBox repository. 250 | RELEASE_CHECK_URL = None 251 | # RELEASE_CHECK_URL = 'https://api.github.com/repos/netbox-community/netbox/releases' 252 | 253 | # The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of 254 | # this setting is derived from the installed location. 255 | # REPORTS_ROOT = '/opt/netbox/netbox/reports' 256 | 257 | # Maximum execution time for background tasks, in seconds. 258 | RQ_DEFAULT_TIMEOUT = 300 259 | 260 | # The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of 261 | # this setting is derived from the installed location. 262 | SCRIPTS_ROOT = '/config/scripts' 263 | 264 | # The name to use for the session cookie. 265 | SESSION_COOKIE_NAME = 'sessionid' 266 | 267 | # By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use 268 | # local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only 269 | # database access.) Note that the user as which NetBox runs must have read and write permissions to this path. 270 | SESSION_FILE_PATH = None 271 | 272 | # Time zone (default: UTC) 273 | TIME_ZONE = 'UTC' 274 | 275 | # Date/time formatting. See the following link for supported formats: 276 | # https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date 277 | DATE_FORMAT = 'N j, Y' 278 | SHORT_DATE_FORMAT = 'Y-m-d' 279 | TIME_FORMAT = 'g:i a' 280 | SHORT_TIME_FORMAT = 'H:i:s' 281 | DATETIME_FORMAT = 'N j, Y g:i a' 282 | SHORT_DATETIME_FORMAT = 'Y-m-d H:i' 283 | -------------------------------------------------------------------------------- /package_versions.txt: -------------------------------------------------------------------------------- 1 | NAME VERSION TYPE 2 | Simple Launcher 1.1.0.14 binary (+5 duplicates) 3 | alpine-baselayout 3.6.5-r0 apk 4 | alpine-baselayout-data 3.6.5-r0 apk 5 | alpine-keys 2.4-r1 apk 6 | alpine-release 3.20.8-r0 apk 7 | apk-tools 2.14.4-r1 apk 8 | asgiref 3.11.0 python 9 | attrs 25.4.0 python 10 | babel 2.17.0 python 11 | backrefs 6.1 python 12 | bash 5.2.26-r0 apk 13 | brotli-libs 1.1.0-r2 apk 14 | busybox 1.36.1-r31 apk 15 | busybox-binsh 1.36.1-r31 apk 16 | c-ares 1.33.1-r0 apk 17 | ca-certificates 20250911-r0 apk 18 | ca-certificates-bundle 20250911-r0 apk 19 | catatonit 0.2.0-r0 apk 20 | certifi 2025.11.12 python 21 | cffi 2.0.0 python 22 | charset-normalizer 3.4.4 python 23 | click 8.3.1 python 24 | colorama 0.4.6 python 25 | coreutils 9.5-r2 apk 26 | coreutils-env 9.5-r2 apk 27 | coreutils-fmt 9.5-r2 apk 28 | coreutils-sha512sum 9.5-r2 apk 29 | croniter 6.0.0 python 30 | cryptography 46.0.3 python 31 | curl 8.14.1-r2 apk 32 | defusedxml 0.7.1 python 33 | django 5.2.9 python 34 | django-auth-ldap 5.2.0 python 35 | django-cors-headers 4.9.0 python 36 | django-debug-toolbar 6.1.0 python 37 | django-filter 25.2 python 38 | django-graphiql-debug-toolbar 0.2.0 python 39 | django-htmx 1.27.0 python 40 | django-js-asset 3.1.2 python 41 | django-mptt 0.17.0 python 42 | django-pglocks 1.0.4 python 43 | django-prometheus 2.4.1 python 44 | django-redis 6.0.0 python 45 | django-rich 2.2.0 python 46 | django-rq 3.2.1 python 47 | django-storages 1.14.6 python 48 | django-tables2 2.8.0 python 49 | django-taggit 6.1.0 python 50 | django-timezone-field 7.2.1 python 51 | djangorestframework 3.16.1 python 52 | drf-spectacular 0.29.0 python 53 | drf-spectacular-sidecar 2025.12.1 python 54 | feedparser 6.0.12 python 55 | findutils 4.9.0-r5 apk 56 | gdbm 1.23-r1 apk 57 | ghp-import 2.1.0 python 58 | gmp 6.3.0-r1 apk 59 | graphene 3.4.3 python 60 | graphene-django 3.2.3 python 61 | graphql-core 3.2.7 python 62 | graphql-relay 3.2.0 python 63 | griffe 1.15.0 python 64 | gunicorn 23.0.0 python 65 | idna 3.11 python 66 | inflection 0.5.1 python 67 | jansson 2.14-r4 apk 68 | jinja2 3.1.6 python 69 | jq 1.7.1-r0 apk 70 | jsonschema 4.25.1 python 71 | jsonschema-specifications 2025.9.1 python 72 | lia-web 0.2.3 python 73 | libacl 2.3.2-r0 apk 74 | libattr 2.5.2-r0 apk 75 | libbsd 0.12.2-r0 apk 76 | libbz2 1.0.8-r6 apk 77 | libcap2 2.70-r0 apk 78 | libcrypto3 3.3.5-r0 apk 79 | libcurl 8.14.1-r2 apk 80 | libexpat 2.7.3-r0 apk 81 | libffi 3.4.6-r0 apk 82 | libgcc 13.2.1_git20240309-r1 apk 83 | libidn2 2.3.7-r0 apk 84 | libintl 0.22.5-r0 apk 85 | libjpeg-turbo 3.0.3-r0 apk 86 | libldap 2.6.8-r0 apk 87 | libmd 1.1.0-r0 apk 88 | libncursesw 6.4_p20240420-r2 apk 89 | libpanelw 6.4_p20240420-r2 apk 90 | libpq 16.11-r0 apk 91 | libproc2 4.0.4-r0 apk 92 | libpsl 0.21.5-r1 apk 93 | libsasl 2.1.28-r6 apk 94 | libsharpyuv 1.3.2-r0 apk 95 | libssl3 3.3.5-r0 apk 96 | libstdc++ 13.2.1_git20240309-r1 apk 97 | libunistring 1.2-r0 apk 98 | libwebp 1.3.2-r0 apk 99 | libxml2 2.12.10-r0 apk 100 | linux-pam 1.6.0-r0 apk 101 | lz4-libs 1.9.4-r5 apk 102 | mailcap 2.1.54-r0 apk 103 | markdown 3.10 python 104 | markdown-it-py 4.0.0 python 105 | markupsafe 3.0.3 python 106 | mdurl 0.1.2 python 107 | mergedeep 1.3.4 python 108 | mkdocs 1.6.1 python 109 | mkdocs-autorefs 1.4.3 python 110 | mkdocs-get-deps 0.2.0 python 111 | mkdocs-material 9.7.0 python 112 | mkdocs-material-extensions 1.3.1 python 113 | mkdocstrings 1.0.0 python 114 | mkdocstrings-python 2.0.1 python 115 | mpdecimal 4.0.0-r0 apk 116 | musl 1.2.5-r1 apk 117 | musl-utils 1.2.5-r1 apk 118 | ncurses-terminfo-base 6.4_p20240420-r2 apk 119 | netaddr 1.3.0 python 120 | netbox 4.4.0 npm 121 | netbox-graphiql 4.3.0 npm 122 | netcat-openbsd 1.226-r0 apk 123 | nghttp2-libs 1.62.1-r0 apk 124 | nh3 0.3.2 python 125 | oauthlib 3.3.1 python 126 | oniguruma 6.9.9-r0 apk 127 | packaging 25.0 python 128 | paginate 0.5.7 python 129 | pathspec 0.12.1 python 130 | pcre2 10.43-r0 apk 131 | pillow 12.0.0 python 132 | pip 25.3 python 133 | platformdirs 4.5.1 python 134 | postgresql-common 1.2-r1 apk 135 | postgresql16-client 16.11-r0 apk 136 | procps-ng 4.0.4-r0 apk 137 | prometheus-client 0.23.1 python 138 | promise 2.3 python 139 | psycopg 3.3.2 python 140 | psycopg-c 3.3.2 python 141 | psycopg-pool 3.3.0 python 142 | pyasn1 0.6.1 python 143 | pyasn1-modules 0.4.2 python 144 | pyc 3.12.12-r0 apk 145 | pycparser 2.23 python 146 | pygments 2.19.2 python 147 | pyjwt 2.10.1 python 148 | pymdown-extensions 10.18 python 149 | python-dateutil 2.9.0.post0 python 150 | python-ldap 3.4.5 python 151 | python3 3.12.12-r0 apk 152 | python3-openid 3.2.0 python 153 | python3-pyc 3.12.12-r0 apk 154 | python3-pycache-pyc0 3.12.12-r0 apk 155 | pytz 2025.2 python 156 | pyyaml 6.0.3 python 157 | pyyaml-env-tag 1.1 python 158 | readline 8.2.10-r0 apk 159 | redis 7.1.0 python 160 | referencing 0.37.0 python 161 | requests 2.32.5 python 162 | requests-oauthlib 2.0.0 python 163 | rich 14.2.0 python 164 | rpds-py 0.30.0 python 165 | rq 2.6.1 python 166 | scanelf 1.3.7-r2 apk 167 | sgmllib3k 1.0.0 python 168 | shadow 4.15.1-r0 apk 169 | six 1.17.0 python 170 | skalibs 2.14.1.1-r0 apk 171 | social-auth-app-django 5.6.0 python 172 | social-auth-core 4.8.1 python 173 | sorl-thumbnail 12.11.0 python 174 | sqlite-libs 3.45.3-r2 apk 175 | sqlparse 0.5.4 python 176 | ssl_client 1.36.1-r31 apk 177 | strawberry-graphql 0.287.2 python 178 | strawberry-graphql-django 0.70.1 python 179 | svgwrite 1.4.3 python 180 | tablib 3.9.0 python 181 | text-unidecode 1.3 python 182 | tiff 4.6.0t-r0 apk 183 | typing-extensions 4.15.0 python 184 | tzdata 2025.2 python 185 | tzdata 2025b-r0 apk 186 | uritemplate 4.2.0 python 187 | urllib3 2.6.1 python 188 | utmps-libs 0.1.2.2-r1 apk 189 | uwsgi 2.0.25.1-r1 apk 190 | uwsgi-python3 2.0.25.1-r1 apk 191 | watchdog 6.0.0 python 192 | wheel 0.45.1 python 193 | xz-libs 5.6.2-r1 apk 194 | zlib 1.3.1-r1 apk 195 | zstd-libs 1.5.6-r0 apk 196 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | <!-- DO NOT EDIT THIS FILE MANUALLY --> 2 | <!-- Please read https://github.com/linuxserver/docker-netbox/blob/master/.github/CONTRIBUTING.md --> 3 | [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io) 4 | 5 | [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!") 6 | [![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://linuxserver.io/discord "realtime support / chat with the community and the team.") 7 | [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.") 8 | [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.") 9 | [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget") 10 | 11 | The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring: 12 | 13 | * regular and timely application updates 14 | * easy user mappings (PGID, PUID) 15 | * custom base image with s6 overlay 16 | * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth 17 | * regular security updates 18 | 19 | Find us at: 20 | 21 | * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! 22 | * [Discord](https://linuxserver.io/discord) - realtime support / chat with the community and the team. 23 | * [Discourse](https://discourse.linuxserver.io) - post on our community forum. 24 | * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories. 25 | * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget 26 | 27 | # [linuxserver/netbox](https://github.com/linuxserver/docker-netbox) 28 | 29 | [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fnetbox?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh) 30 | [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-netbox.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-netbox) 31 | [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-netbox.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-netbox/releases) 32 | [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-netbox/packages) 33 | [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-netbox/container_registry) 34 | [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/netbox) 35 | [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/netbox.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/netbox) 36 | [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/netbox.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/netbox) 37 | [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-netbox%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-netbox/job/master/) 38 | [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fnetbox%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/netbox/latest/index.html) 39 | 40 | [Netbox](https://github.com/netbox-community/netbox) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. 41 | 42 | [![netbox](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/netbox-logo.png)](https://github.com/netbox-community/netbox) 43 | 44 | ## Supported Architectures 45 | 46 | We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). 47 | 48 | Simply pulling `lscr.io/linuxserver/netbox:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. 49 | 50 | The architectures supported by this image are: 51 | 52 | | Architecture | Available | Tag | 53 | | :----: | :----: | ---- | 54 | | x86-64 | ✅ | amd64-\<version tag\> | 55 | | arm64 | ✅ | arm64v8-\<version tag\> | 56 | 57 | ## Application Setup 58 | 59 | Netbox requires a postgres database and a redis instance. 60 | 61 | Access the WebUI at <your-ip>:8000. For more information, check out [NetBox](https://github.com/netbox-community/netbox). 62 | 63 | ## Usage 64 | 65 | To help you get started creating a container from this image you can either use docker-compose or the docker cli. 66 | 67 | >[!NOTE] 68 | >Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. 69 | 70 | ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) 71 | 72 | ```yaml 73 | --- 74 | services: 75 | netbox: 76 | image: lscr.io/linuxserver/netbox:latest 77 | container_name: netbox 78 | environment: 79 | - PUID=1000 80 | - PGID=1000 81 | - TZ=Etc/UTC 82 | - SUPERUSER_EMAIL= 83 | - SUPERUSER_PASSWORD= 84 | - ALLOWED_HOST= 85 | - DB_NAME= 86 | - DB_USER= 87 | - DB_PASSWORD= 88 | - DB_HOST= 89 | - DB_PORT= 90 | - REDIS_HOST= 91 | - REDIS_PORT= 92 | - REDIS_PASSWORD= 93 | - REDIS_DB_TASK= 94 | - REDIS_DB_CACHE= 95 | - BASE_PATH= #optional 96 | - REMOTE_AUTH_ENABLED= #optional 97 | - REMOTE_AUTH_BACKEND= #optional 98 | - REMOTE_AUTH_HEADER= #optional 99 | - REMOTE_AUTH_AUTO_CREATE_USER= #optional 100 | - REMOTE_AUTH_DEFAULT_GROUPS= #optional 101 | - REMOTE_AUTH_DEFAULT_PERMISSIONS= #optional 102 | volumes: 103 | - /path/to/netbox/config:/config 104 | ports: 105 | - 8000:8000 106 | restart: unless-stopped 107 | ``` 108 | 109 | ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) 110 | 111 | ```bash 112 | docker run -d \ 113 | --name=netbox \ 114 | -e PUID=1000 \ 115 | -e PGID=1000 \ 116 | -e TZ=Etc/UTC \ 117 | -e SUPERUSER_EMAIL= \ 118 | -e SUPERUSER_PASSWORD= \ 119 | -e ALLOWED_HOST= \ 120 | -e DB_NAME= \ 121 | -e DB_USER= \ 122 | -e DB_PASSWORD= \ 123 | -e DB_HOST= \ 124 | -e DB_PORT= \ 125 | -e REDIS_HOST= \ 126 | -e REDIS_PORT= \ 127 | -e REDIS_PASSWORD= \ 128 | -e REDIS_DB_TASK= \ 129 | -e REDIS_DB_CACHE= \ 130 | -e BASE_PATH= `#optional` \ 131 | -e REMOTE_AUTH_ENABLED= `#optional` \ 132 | -e REMOTE_AUTH_BACKEND= `#optional` \ 133 | -e REMOTE_AUTH_HEADER= `#optional` \ 134 | -e REMOTE_AUTH_AUTO_CREATE_USER= `#optional` \ 135 | -e REMOTE_AUTH_DEFAULT_GROUPS= `#optional` \ 136 | -e REMOTE_AUTH_DEFAULT_PERMISSIONS= `#optional` \ 137 | -p 8000:8000 \ 138 | -v /path/to/netbox/config:/config \ 139 | --restart unless-stopped \ 140 | lscr.io/linuxserver/netbox:latest 141 | ``` 142 | 143 | ## Parameters 144 | 145 | Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. 146 | 147 | | Parameter | Function | 148 | | :----: | --- | 149 | | `-p 8000:8000` | will map the container's port 8000 to port 8000 on the host | 150 | | `-e PUID=1000` | for UserID - see below for explanation | 151 | | `-e PGID=1000` | for GroupID - see below for explanation | 152 | | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | 153 | | `-e SUPERUSER_EMAIL=` | Email address for `admin` account | 154 | | `-e SUPERUSER_PASSWORD=` | Password for `admin` account | 155 | | `-e ALLOWED_HOST=` | The hostname you will use to access the app (i.e., netbox.example.com) | 156 | | `-e DB_NAME=` | Database name (default: netbox) | 157 | | `-e DB_USER=` | Database user | 158 | | `-e DB_PASSWORD=` | Database password | 159 | | `-e DB_HOST=` | Database host (default: postgres) | 160 | | `-e DB_PORT=` | Database port (default: 5432) | 161 | | `-e REDIS_HOST=` | Redis host (default: redis) | 162 | | `-e REDIS_PORT=` | Redis port number (default: 6379) | 163 | | `-e REDIS_PASSWORD=` | Redis password (default: none) | 164 | | `-e REDIS_DB_TASK=` | Redis database ID for tasks (default: 0) | 165 | | `-e REDIS_DB_CACHE=` | Redis database ID for caching (default: 1) | 166 | | `-e BASE_PATH=` | The path you will use to access the app (i.e., /netbox, optional, default: none) | 167 | | `-e REMOTE_AUTH_ENABLED=` | Enable remote authentication (optional, default: False) | 168 | | `-e REMOTE_AUTH_BACKEND=` | Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend) | 169 | | `-e REMOTE_AUTH_HEADER=` | Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER) | 170 | | `-e REMOTE_AUTH_AUTO_CREATE_USER=` | If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False) | 171 | | `-e REMOTE_AUTH_DEFAULT_GROUPS=` | The list of groups to assign a new user account when created using remote authentication (optional, default: []) | 172 | | `-e REMOTE_AUTH_DEFAULT_PERMISSIONS=` | A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {}) | 173 | | `-v /config` | Persistent config files | 174 | 175 | ## Environment variables from files (Docker secrets) 176 | 177 | You can set any environment variable from a file by using a special prepend `FILE__`. 178 | 179 | As an example: 180 | 181 | ```bash 182 | -e FILE__MYVAR=/run/secrets/mysecretvariable 183 | ``` 184 | 185 | Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file. 186 | 187 | ## Umask for running applications 188 | 189 | For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. 190 | Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support. 191 | 192 | ## User / Group Identifiers 193 | 194 | When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. 195 | 196 | Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. 197 | 198 | In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below: 199 | 200 | ```bash 201 | id your_user 202 | ``` 203 | 204 | Example output: 205 | 206 | ```text 207 | uid=1000(your_user) gid=1000(your_user) groups=1000(your_user) 208 | ``` 209 | 210 | ## Docker Mods 211 | 212 | [![Docker Mods](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)](https://mods.linuxserver.io/?mod=netbox "view available mods for this container.") [![Docker Universal Mods](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)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") 213 | 214 | We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) 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. 215 | 216 | ## Support Info 217 | 218 | * Shell access whilst the container is running: 219 | 220 | ```bash 221 | docker exec -it netbox /bin/bash 222 | ``` 223 | 224 | * To monitor the logs of the container in realtime: 225 | 226 | ```bash 227 | docker logs -f netbox 228 | ``` 229 | 230 | * Container version number: 231 | 232 | ```bash 233 | docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox 234 | ``` 235 | 236 | * Image version number: 237 | 238 | ```bash 239 | docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbox:latest 240 | ``` 241 | 242 | ## Updating Info 243 | 244 | Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image. 245 | 246 | Below are the instructions for updating containers: 247 | 248 | ### Via Docker Compose 249 | 250 | * Update images: 251 | * All images: 252 | 253 | ```bash 254 | docker-compose pull 255 | ``` 256 | 257 | * Single image: 258 | 259 | ```bash 260 | docker-compose pull netbox 261 | ``` 262 | 263 | * Update containers: 264 | * All containers: 265 | 266 | ```bash 267 | docker-compose up -d 268 | ``` 269 | 270 | * Single container: 271 | 272 | ```bash 273 | docker-compose up -d netbox 274 | ``` 275 | 276 | * You can also remove the old dangling images: 277 | 278 | ```bash 279 | docker image prune 280 | ``` 281 | 282 | ### Via Docker Run 283 | 284 | * Update the image: 285 | 286 | ```bash 287 | docker pull lscr.io/linuxserver/netbox:latest 288 | ``` 289 | 290 | * Stop the running container: 291 | 292 | ```bash 293 | docker stop netbox 294 | ``` 295 | 296 | * Delete the container: 297 | 298 | ```bash 299 | docker rm netbox 300 | ``` 301 | 302 | * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) 303 | * You can also remove the old dangling images: 304 | 305 | ```bash 306 | docker image prune 307 | ``` 308 | 309 | ### Image Update Notifications - Diun (Docker Image Update Notifier) 310 | 311 | >[!TIP] 312 | >We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. 313 | 314 | ## Building locally 315 | 316 | If you want to make local modifications to these images for development purposes or just to customize the logic: 317 | 318 | ```bash 319 | git clone https://github.com/linuxserver/docker-netbox.git 320 | cd docker-netbox 321 | docker build \ 322 | --no-cache \ 323 | --pull \ 324 | -t lscr.io/linuxserver/netbox:latest . 325 | ``` 326 | 327 | The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static` 328 | 329 | ```bash 330 | docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset 331 | ``` 332 | 333 | Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. 334 | 335 | ## Versions 336 | 337 | * **26.08.24:** - Restructure init to allow for plugins as mods. 338 | * **16.07.24:** - Add required packages for LDAP support. 339 | * **01.06.24:** - Rebase to Alpine 3.20. 340 | * **23.12.23:** - Rebase to Alpine 3.19. 341 | * **11.06.23:** - Rebase to Alpine 3.18, deprecate armhf. 342 | * **14.05.23:** - Build local docs on first run. 343 | * **05.03.23:** - Rebase to Alpine 3.17. 344 | * **02.11.22:** - Rebase to Alpine 3.16, migrate to s6v3. 345 | * **01.08.22:** - Remove py3-pillow, add tiff to fix deps. 346 | * **26.07.22:** - Add py3-pillow package back on arm to fix build issue. 347 | * **10.12.21:** - Remove py3-pillow package to fix dependency issue with 3.2.0. 348 | * **10.12.21:** - Rebase to Alpine 3.15. 349 | * **26.04.21:** - Added Redis database environment variables. 350 | * **03.02.21:** - Added remote authentication environment variables. 351 | * **02.01.21:** - Added BASE_PATH environment variable. 352 | * **23.08.20:** - Initial Release. 353 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | <one line to give the program's name and a brief idea of what it does.> 635 | Copyright (C) <year> <name of author> 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see <https://www.gnu.org/licenses/>. 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | <program> Copyright (C) <year> <name of author> 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | <https://www.gnu.org/licenses/>. 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | <https://www.gnu.org/licenses/why-not-lgpl.html>. 675 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent { 3 | label 'X86-64-MULTI' 4 | } 5 | options { 6 | buildDiscarder(logRotator(numToKeepStr: '10', daysToKeepStr: '60')) 7 | parallelsAlwaysFailFast() 8 | } 9 | // Input to determine if this is a package check 10 | parameters { 11 | string(defaultValue: 'false', description: 'package check run', name: 'PACKAGE_CHECK') 12 | } 13 | // Configuration for the variables used for this specific repo 14 | environment { 15 | BUILDS_DISCORD=credentials('build_webhook_url') 16 | GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab') 17 | GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0') 18 | GITLAB_NAMESPACE=credentials('gitlab-namespace-id') 19 | DOCKERHUB_TOKEN=credentials('docker-hub-ci-pat') 20 | QUAYIO_API_TOKEN=credentials('quayio-repo-api-token') 21 | GIT_SIGNING_KEY=credentials('484fbca6-9a4f-455e-b9e3-97ac98785f5f') 22 | EXT_GIT_BRANCH = 'master' 23 | EXT_USER = 'netbox-community' 24 | EXT_REPO = 'netbox' 25 | BUILD_VERSION_ARG = 'NETBOX_RELEASE' 26 | LS_USER = 'linuxserver' 27 | LS_REPO = 'docker-netbox' 28 | CONTAINER_NAME = 'netbox' 29 | DOCKERHUB_IMAGE = 'linuxserver/netbox' 30 | DEV_DOCKERHUB_IMAGE = 'lsiodev/netbox' 31 | PR_DOCKERHUB_IMAGE = 'lspipepr/netbox' 32 | DIST_IMAGE = 'alpine' 33 | MULTIARCH='true' 34 | CI='true' 35 | CI_WEB='false' 36 | CI_PORT='8000' 37 | CI_SSL='false' 38 | CI_DELAY='120' 39 | CI_DOCKERENV='' 40 | CI_AUTH='' 41 | CI_WEBPATH='' 42 | } 43 | stages { 44 | stage("Set git config"){ 45 | steps{ 46 | sh '''#!/bin/bash 47 | cat ${GIT_SIGNING_KEY} > /config/.ssh/id_sign 48 | chmod 600 /config/.ssh/id_sign 49 | ssh-keygen -y -f /config/.ssh/id_sign > /config/.ssh/id_sign.pub 50 | echo "Using $(ssh-keygen -lf /config/.ssh/id_sign) to sign commits" 51 | git config --global gpg.format ssh 52 | git config --global user.signingkey /config/.ssh/id_sign 53 | git config --global commit.gpgsign true 54 | ''' 55 | } 56 | } 57 | // Setup all the basic environment variables needed for the build 58 | stage("Set ENV Variables base"){ 59 | steps{ 60 | echo "Running on node: ${NODE_NAME}" 61 | sh '''#! /bin/bash 62 | echo "Pruning builder" 63 | docker builder prune -f --builder container || : 64 | containers=$(docker ps -q) 65 | if [[ -n "${containers}" ]]; then 66 | BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit') 67 | for container in ${containers}; do 68 | if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then 69 | echo "skipping buildx container in docker stop" 70 | else 71 | echo "Stopping container ${container}" 72 | docker stop ${container} 73 | fi 74 | done 75 | fi 76 | docker system prune -f --volumes || : 77 | docker image prune -af || : 78 | ''' 79 | script{ 80 | env.EXIT_STATUS = '' 81 | env.LS_RELEASE = sh( 82 | script: '''docker run --rm quay.io/skopeo/stable:v1 inspect docker://ghcr.io/${LS_USER}/${CONTAINER_NAME}:latest 2>/dev/null | jq -r '.Labels.build_version' | awk '{print $3}' | grep '\\-ls' || : ''', 83 | returnStdout: true).trim() 84 | env.LS_RELEASE_NOTES = sh( 85 | script: '''cat readme-vars.yml | awk -F \\" '/date: "[0-9][0-9].[0-9][0-9].[0-9][0-9]:/ {print $4;exit;}' | sed -E ':a;N;$!ba;s/\\r{0,1}\\n/\\\\n/g' ''', 86 | returnStdout: true).trim() 87 | env.GITHUB_DATE = sh( 88 | script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''', 89 | returnStdout: true).trim() 90 | env.COMMIT_SHA = sh( 91 | script: '''git rev-parse HEAD''', 92 | returnStdout: true).trim() 93 | env.GH_DEFAULT_BRANCH = sh( 94 | script: '''git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||' ''', 95 | returnStdout: true).trim() 96 | env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT 97 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/' 98 | env.PULL_REQUEST = env.CHANGE_ID 99 | env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE .editorconfig ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE/config.yml ./.github/ISSUE_TEMPLATE/issue.bug.yml ./.github/ISSUE_TEMPLATE/issue.feature.yml ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/external_trigger_scheduler.yml ./.github/workflows/greetings.yml ./.github/workflows/package_trigger_scheduler.yml ./.github/workflows/call_issue_pr_tracker.yml ./.github/workflows/call_issues_cron.yml ./.github/workflows/permissions.yml ./.github/workflows/external_trigger.yml' 100 | if ( env.SYFT_IMAGE_TAG == null ) { 101 | env.SYFT_IMAGE_TAG = 'latest' 102 | } 103 | } 104 | echo "Using syft image tag ${SYFT_IMAGE_TAG}" 105 | sh '''#! /bin/bash 106 | echo "The default github branch detected as ${GH_DEFAULT_BRANCH}" ''' 107 | script{ 108 | env.LS_RELEASE_NUMBER = sh( 109 | script: '''echo ${LS_RELEASE} |sed 's/^.*-ls//g' ''', 110 | returnStdout: true).trim() 111 | } 112 | script{ 113 | env.LS_TAG_NUMBER = sh( 114 | script: '''#! /bin/bash 115 | tagsha=$(git rev-list -n 1 ${LS_RELEASE} 2>/dev/null) 116 | if [ "${tagsha}" == "${COMMIT_SHA}" ]; then 117 | echo ${LS_RELEASE_NUMBER} 118 | elif [ -z "${GIT_COMMIT}" ]; then 119 | echo ${LS_RELEASE_NUMBER} 120 | else 121 | echo $((${LS_RELEASE_NUMBER} + 1)) 122 | fi''', 123 | returnStdout: true).trim() 124 | } 125 | } 126 | } 127 | /* ####################### 128 | Package Version Tagging 129 | ####################### */ 130 | // Grab the current package versions in Git to determine package tag 131 | stage("Set Package tag"){ 132 | steps{ 133 | script{ 134 | env.PACKAGE_TAG = sh( 135 | script: '''#!/bin/bash 136 | if [ -e package_versions.txt ] ; then 137 | cat package_versions.txt | md5sum | cut -c1-8 138 | else 139 | echo none 140 | fi''', 141 | returnStdout: true).trim() 142 | } 143 | } 144 | } 145 | /* ######################## 146 | External Release Tagging 147 | ######################## */ 148 | // If this is a stable github release use the latest endpoint from github to determine the ext tag 149 | stage("Set ENV github_stable"){ 150 | steps{ 151 | script{ 152 | env.EXT_RELEASE = sh( 153 | script: '''curl -H "Authorization: token ${GITHUB_TOKEN}" -s https://api.github.com/repos/${EXT_USER}/${EXT_REPO}/releases/latest | jq -r '. | .tag_name' ''', 154 | returnStdout: true).trim() 155 | } 156 | } 157 | } 158 | // If this is a stable or devel github release generate the link for the build message 159 | stage("Set ENV github_link"){ 160 | steps{ 161 | script{ 162 | env.RELEASE_LINK = 'https://github.com/' + env.EXT_USER + '/' + env.EXT_REPO + '/releases/tag/' + env.EXT_RELEASE 163 | } 164 | } 165 | } 166 | // Sanitize the release tag and strip illegal docker or github characters 167 | stage("Sanitize tag"){ 168 | steps{ 169 | script{ 170 | env.EXT_RELEASE_CLEAN = sh( 171 | script: '''echo ${EXT_RELEASE} | sed 's/[~,%@+;:/ ]//g' ''', 172 | returnStdout: true).trim() 173 | 174 | def semver = env.EXT_RELEASE_CLEAN =~ /(\d+)\.(\d+)\.(\d+)/ 175 | if (semver.find()) { 176 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${semver[0][3]}" 177 | } else { 178 | semver = env.EXT_RELEASE_CLEAN =~ /(\d+)\.(\d+)(?:\.(\d+))?(.*)/ 179 | if (semver.find()) { 180 | if (semver[0][3]) { 181 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${semver[0][3]}" 182 | } else if (!semver[0][3] && !semver[0][4]) { 183 | env.SEMVER = "${semver[0][1]}.${semver[0][2]}.${(new Date()).format('YYYYMMdd')}" 184 | } 185 | } 186 | } 187 | 188 | if (env.SEMVER != null) { 189 | if (BRANCH_NAME != "${env.GH_DEFAULT_BRANCH}") { 190 | env.SEMVER = "${env.SEMVER}-${BRANCH_NAME}" 191 | } 192 | println("SEMVER: ${env.SEMVER}") 193 | } else { 194 | println("No SEMVER detected") 195 | } 196 | 197 | } 198 | } 199 | } 200 | // If this is a master build use live docker endpoints 201 | stage("Set ENV live build"){ 202 | when { 203 | branch "master" 204 | environment name: 'CHANGE_ID', value: '' 205 | } 206 | steps { 207 | script{ 208 | env.IMAGE = env.DOCKERHUB_IMAGE 209 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/' + env.CONTAINER_NAME 210 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/' + env.CONTAINER_NAME 211 | env.QUAYIMAGE = 'quay.io/linuxserver.io/' + env.CONTAINER_NAME 212 | if (env.MULTIARCH == 'true') { 213 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 214 | } else { 215 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 216 | } 217 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 218 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 219 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 220 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 221 | env.CITEST_IMAGETAG = 'latest' 222 | } 223 | } 224 | } 225 | // If this is a dev build use dev docker endpoints 226 | stage("Set ENV dev build"){ 227 | when { 228 | not {branch "master"} 229 | environment name: 'CHANGE_ID', value: '' 230 | } 231 | steps { 232 | script{ 233 | env.IMAGE = env.DEV_DOCKERHUB_IMAGE 234 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/lsiodev-' + env.CONTAINER_NAME 235 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lsiodev-' + env.CONTAINER_NAME 236 | env.QUAYIMAGE = 'quay.io/linuxserver.io/lsiodev-' + env.CONTAINER_NAME 237 | if (env.MULTIARCH == 'true') { 238 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 239 | } else { 240 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 241 | } 242 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 243 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA 244 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 245 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/' 246 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 247 | env.CITEST_IMAGETAG = 'develop' 248 | } 249 | } 250 | } 251 | // If this is a pull request build use dev docker endpoints 252 | stage("Set ENV PR build"){ 253 | when { 254 | not {environment name: 'CHANGE_ID', value: ''} 255 | } 256 | steps { 257 | script{ 258 | env.IMAGE = env.PR_DOCKERHUB_IMAGE 259 | env.GITHUBIMAGE = 'ghcr.io/' + env.LS_USER + '/lspipepr-' + env.CONTAINER_NAME 260 | env.GITLABIMAGE = 'registry.gitlab.com/linuxserver.io/' + env.LS_REPO + '/lspipepr-' + env.CONTAINER_NAME 261 | env.QUAYIMAGE = 'quay.io/linuxserver.io/lspipepr-' + env.CONTAINER_NAME 262 | if (env.MULTIARCH == 'true') { 263 | env.CI_TAGS = 'amd64-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST + '|arm64v8-' + env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 264 | } else { 265 | env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 266 | } 267 | env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 268 | env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA + '-pr-' + env.PULL_REQUEST 269 | env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN 270 | env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST 271 | env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/' 272 | env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache' 273 | env.CITEST_IMAGETAG = 'develop' 274 | } 275 | } 276 | } 277 | // Run ShellCheck 278 | stage('ShellCheck') { 279 | when { 280 | environment name: 'CI', value: 'true' 281 | } 282 | steps { 283 | withCredentials([ 284 | string(credentialsId: 'ci-tests-s3-key-id', variable: 'S3_KEY'), 285 | string(credentialsId: 'ci-tests-s3-secret-access-key', variable: 'S3_SECRET') 286 | ]) { 287 | script{ 288 | env.SHELLCHECK_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/shellcheck-result.xml' 289 | } 290 | sh '''curl -sL https://raw.githubusercontent.com/linuxserver/docker-jenkins-builder/master/checkrun.sh | /bin/bash''' 291 | sh '''#! /bin/bash 292 | docker run --rm \ 293 | -v ${WORKSPACE}:/mnt \ 294 | -e AWS_ACCESS_KEY_ID=\"${S3_KEY}\" \ 295 | -e AWS_SECRET_ACCESS_KEY=\"${S3_SECRET}\" \ 296 | ghcr.io/linuxserver/baseimage-alpine:3 s6-envdir -fn -- /var/run/s6/container_environment /bin/bash -c "\ 297 | apk add --no-cache python3 && \ 298 | python3 -m venv /lsiopy && \ 299 | pip install --no-cache-dir -U pip && \ 300 | pip install --no-cache-dir s3cmd && \ 301 | s3cmd put --no-preserve --acl-public -m text/xml /mnt/shellcheck-result.xml s3://ci-tests.linuxserver.io/${IMAGE}/${META_TAG}/shellcheck-result.xml" || :''' 302 | } 303 | } 304 | } 305 | // Use helper containers to render templated files 306 | stage('Update-Templates') { 307 | when { 308 | branch "master" 309 | environment name: 'CHANGE_ID', value: '' 310 | expression { 311 | env.CONTAINER_NAME != null 312 | } 313 | } 314 | steps { 315 | sh '''#! /bin/bash 316 | set -e 317 | TEMPDIR=$(mktemp -d) 318 | docker pull ghcr.io/linuxserver/jenkins-builder:latest 319 | # Cloned repo paths for templating: 320 | # ${TEMPDIR}/docker-${CONTAINER_NAME}: Cloned branch master of ${LS_USER}/${LS_REPO} for running the jenkins builder on 321 | # ${TEMPDIR}/repo/${LS_REPO}: Cloned branch master of ${LS_USER}/${LS_REPO} for commiting various templated file changes and pushing back to Github 322 | # ${TEMPDIR}/docs/docker-documentation: Cloned docs repo for pushing docs updates to Github 323 | # ${TEMPDIR}/unraid/docker-templates: Cloned docker-templates repo to check for logos 324 | # ${TEMPDIR}/unraid/templates: Cloned templates repo for commiting unraid template changes and pushing back to Github 325 | git clone --branch master --depth 1 https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/docker-${CONTAINER_NAME} 326 | docker run --rm -v ${TEMPDIR}/docker-${CONTAINER_NAME}:/tmp -e LOCAL=true -e PUID=$(id -u) -e PGID=$(id -g) ghcr.io/linuxserver/jenkins-builder:latest 327 | echo "Starting Stage 1 - Jenkinsfile update" 328 | if [[ "$(md5sum Jenkinsfile | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile | awk '{ print $1 }')" ]]; then 329 | mkdir -p ${TEMPDIR}/repo 330 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 331 | cd ${TEMPDIR}/repo/${LS_REPO} 332 | git checkout -f master 333 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile ${TEMPDIR}/repo/${LS_REPO}/ 334 | git add Jenkinsfile 335 | git commit -m 'Bot Updating Templated Files' 336 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 337 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 338 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 339 | echo "Updating Jenkinsfile and exiting build, new one will trigger based on commit" 340 | rm -Rf ${TEMPDIR} 341 | exit 0 342 | else 343 | echo "Jenkinsfile is up to date." 344 | fi 345 | echo "Starting Stage 2 - Delete old templates" 346 | OLD_TEMPLATES=".github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/issue.bug.md .github/ISSUE_TEMPLATE/issue.feature.md .github/workflows/call_invalid_helper.yml .github/workflows/stale.yml .github/workflows/package_trigger.yml" 347 | for i in ${OLD_TEMPLATES}; do 348 | if [[ -f "${i}" ]]; then 349 | TEMPLATES_TO_DELETE="${i} ${TEMPLATES_TO_DELETE}" 350 | fi 351 | done 352 | if [[ -n "${TEMPLATES_TO_DELETE}" ]]; then 353 | mkdir -p ${TEMPDIR}/repo 354 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 355 | cd ${TEMPDIR}/repo/${LS_REPO} 356 | git checkout -f master 357 | for i in ${TEMPLATES_TO_DELETE}; do 358 | git rm "${i}" 359 | done 360 | git commit -m 'Bot Updating Templated Files' 361 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 362 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 363 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 364 | echo "Deleting old/deprecated templates and exiting build, new one will trigger based on commit" 365 | rm -Rf ${TEMPDIR} 366 | exit 0 367 | else 368 | echo "No templates to delete" 369 | fi 370 | echo "Starting Stage 2.5 - Update init diagram" 371 | if ! grep -q 'init_diagram:' readme-vars.yml; then 372 | echo "Adding the key 'init_diagram' to readme-vars.yml" 373 | sed -i '\\|^#.*changelog.*$|d' readme-vars.yml 374 | sed -i 's|^changelogs:|# init diagram\\ninit_diagram:\\n\\n# changelog\\nchangelogs:|' readme-vars.yml 375 | fi 376 | mkdir -p ${TEMPDIR}/d2 377 | docker run --rm -v ${TEMPDIR}/d2:/output -e PUID=$(id -u) -e PGID=$(id -g) -e RAW="true" ghcr.io/linuxserver/d2-builder:latest ${CONTAINER_NAME}:latest 378 | ls -al ${TEMPDIR}/d2 379 | yq -ei ".init_diagram |= load_str(\\"${TEMPDIR}/d2/${CONTAINER_NAME}-latest.d2\\")" readme-vars.yml 380 | if [[ $(md5sum readme-vars.yml | cut -c1-8) != $(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/readme-vars.yml | cut -c1-8) ]]; then 381 | echo "'init_diagram' has been updated. Updating repo and exiting build, new one will trigger based on commit." 382 | mkdir -p ${TEMPDIR}/repo 383 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 384 | cd ${TEMPDIR}/repo/${LS_REPO} 385 | git checkout -f master 386 | cp ${WORKSPACE}/readme-vars.yml ${TEMPDIR}/repo/${LS_REPO}/readme-vars.yml 387 | git add readme-vars.yml 388 | git commit -m 'Bot Updating Templated Files' 389 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 390 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 391 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 392 | echo "Updating templates and exiting build, new one will trigger based on commit" 393 | rm -Rf ${TEMPDIR} 394 | exit 0 395 | else 396 | echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 397 | echo "Init diagram is unchanged" 398 | fi 399 | echo "Starting Stage 3 - Update templates" 400 | CURRENTHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8) 401 | cd ${TEMPDIR}/docker-${CONTAINER_NAME} 402 | NEWHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8) 403 | if [[ "${CURRENTHASH}" != "${NEWHASH}" ]] || ! grep -q '.jenkins-external' "${WORKSPACE}/.gitignore" 2>/dev/null; then 404 | mkdir -p ${TEMPDIR}/repo 405 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO} 406 | cd ${TEMPDIR}/repo/${LS_REPO} 407 | git checkout -f master 408 | cd ${TEMPDIR}/docker-${CONTAINER_NAME} 409 | mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/workflows 410 | mkdir -p ${TEMPDIR}/repo/${LS_REPO}/.github/ISSUE_TEMPLATE 411 | cp --parents ${TEMPLATED_FILES} ${TEMPDIR}/repo/${LS_REPO}/ || : 412 | cp --parents readme-vars.yml ${TEMPDIR}/repo/${LS_REPO}/ || : 413 | cd ${TEMPDIR}/repo/${LS_REPO}/ 414 | if ! grep -q '.jenkins-external' .gitignore 2>/dev/null; then 415 | echo ".jenkins-external" >> .gitignore 416 | git add .gitignore 417 | fi 418 | git add readme-vars.yml ${TEMPLATED_FILES} 419 | git commit -m 'Bot Updating Templated Files' 420 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 421 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 422 | echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 423 | echo "Updating templates and exiting build, new one will trigger based on commit" 424 | rm -Rf ${TEMPDIR} 425 | exit 0 426 | else 427 | echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER} 428 | echo "No templates to update" 429 | fi 430 | echo "Starting Stage 4 - External repo updates: Docs, Unraid Template and Readme Sync to Docker Hub" 431 | mkdir -p ${TEMPDIR}/docs 432 | git clone --depth=1 https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation 433 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then 434 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/ 435 | cd ${TEMPDIR}/docs/docker-documentation 436 | GH_DOCS_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||') 437 | git add docs/images/docker-${CONTAINER_NAME}.md 438 | echo "Updating docs repo" 439 | git commit -m 'Bot Updating Documentation' 440 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase 441 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} || \ 442 | (MAXWAIT="10" && echo "Push to docs failed, trying again in ${MAXWAIT} seconds" && \ 443 | sleep $((RANDOM % MAXWAIT)) && \ 444 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase && \ 445 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH}) 446 | else 447 | echo "Docs update not needed, skipping" 448 | fi 449 | mkdir -p ${TEMPDIR}/unraid 450 | git clone --depth=1 https://github.com/linuxserver/docker-templates.git ${TEMPDIR}/unraid/docker-templates 451 | git clone --depth=1 https://github.com/linuxserver/templates.git ${TEMPDIR}/unraid/templates 452 | if [[ -f ${TEMPDIR}/unraid/docker-templates/linuxserver.io/img/${CONTAINER_NAME}-logo.png ]]; then 453 | sed -i "s|master/linuxserver.io/img/linuxserver-ls-logo.png|master/linuxserver.io/img/${CONTAINER_NAME}-logo.png|" ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml 454 | elif [[ -f ${TEMPDIR}/unraid/docker-templates/linuxserver.io/img/${CONTAINER_NAME}-icon.png ]]; then 455 | sed -i "s|master/linuxserver.io/img/linuxserver-ls-logo.png|master/linuxserver.io/img/${CONTAINER_NAME}-icon.png|" ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml 456 | fi 457 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml) || ("$(md5sum ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml | awk '{ print $1 }')") ]]; then 458 | echo "Updating Unraid template" 459 | cd ${TEMPDIR}/unraid/templates/ 460 | GH_TEMPLATES_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||') 461 | if grep -wq "^${CONTAINER_NAME}$" ${TEMPDIR}/unraid/templates/unraid/ignore.list && [[ -f ${TEMPDIR}/unraid/templates/unraid/deprecated/${CONTAINER_NAME}.xml ]]; then 462 | echo "Image is on the ignore list, and already in the deprecation folder." 463 | elif grep -wq "^${CONTAINER_NAME}$" ${TEMPDIR}/unraid/templates/unraid/ignore.list; then 464 | echo "Image is on the ignore list, marking Unraid template as deprecated" 465 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml ${TEMPDIR}/unraid/templates/unraid/ 466 | git add -u unraid/${CONTAINER_NAME}.xml 467 | git mv unraid/${CONTAINER_NAME}.xml unraid/deprecated/${CONTAINER_NAME}.xml || : 468 | git commit -m 'Bot Moving Deprecated Unraid Template' || : 469 | else 470 | cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml ${TEMPDIR}/unraid/templates/unraid/ 471 | git add unraid/${CONTAINER_NAME}.xml 472 | git commit -m 'Bot Updating Unraid Template' 473 | fi 474 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH} --rebase 475 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH} || \ 476 | (MAXWAIT="10" && echo "Push to unraid templates failed, trying again in ${MAXWAIT} seconds" && \ 477 | sleep $((RANDOM % MAXWAIT)) && \ 478 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH} --rebase && \ 479 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH}) 480 | else 481 | echo "No updates to Unraid template needed, skipping" 482 | fi 483 | if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]]; then 484 | if [[ $(cat ${TEMPDIR}/docker-${CONTAINER_NAME}/README.md | wc -m) -gt 25000 ]]; then 485 | echo "Readme is longer than 25,000 characters. Syncing the lite version to Docker Hub" 486 | DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/README.lite" 487 | else 488 | echo "Syncing readme to Docker Hub" 489 | DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/README.md" 490 | fi 491 | if curl -s https://hub.docker.com/v2/namespaces/${DOCKERHUB_IMAGE%%/*}/repositories/${DOCKERHUB_IMAGE##*/}/tags | jq -r '.message' | grep -q 404; then 492 | echo "Docker Hub endpoint doesn't exist. Creating endpoint first." 493 | DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token') 494 | curl -s \ 495 | -H "Authorization: JWT ${DH_TOKEN}" \ 496 | -H "Content-Type: application/json" \ 497 | -X POST \ 498 | -d '{"name":"'${DOCKERHUB_IMAGE##*/}'", "namespace":"'${DOCKERHUB_IMAGE%%/*}'"}' \ 499 | https://hub.docker.com/v2/repositories/ || : 500 | fi 501 | DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token') 502 | curl -s \ 503 | -H "Authorization: JWT ${DH_TOKEN}" \ 504 | -H "Content-Type: application/json" \ 505 | -X PATCH \ 506 | -d "{\\"full_description\\":$(jq -Rsa . ${DH_README_SYNC_PATH})}" \ 507 | https://hub.docker.com/v2/repositories/${DOCKERHUB_IMAGE} || : 508 | else 509 | echo "Not the default Github branch. Skipping readme sync to Docker Hub." 510 | fi 511 | rm -Rf ${TEMPDIR}''' 512 | script{ 513 | env.FILES_UPDATED = sh( 514 | script: '''cat /tmp/${COMMIT_SHA}-${BUILD_NUMBER}''', 515 | returnStdout: true).trim() 516 | } 517 | } 518 | } 519 | // Exit the build if the Templated files were just updated 520 | stage('Template-exit') { 521 | when { 522 | branch "master" 523 | environment name: 'CHANGE_ID', value: '' 524 | environment name: 'FILES_UPDATED', value: 'true' 525 | expression { 526 | env.CONTAINER_NAME != null 527 | } 528 | } 529 | steps { 530 | script{ 531 | env.EXIT_STATUS = 'ABORTED' 532 | } 533 | } 534 | } 535 | // If this is a master build check the S6 service file perms 536 | stage("Check S6 Service file Permissions"){ 537 | when { 538 | branch "master" 539 | environment name: 'CHANGE_ID', value: '' 540 | environment name: 'EXIT_STATUS', value: '' 541 | } 542 | steps { 543 | script{ 544 | sh '''#! /bin/bash 545 | WRONG_PERM=$(find ./ -path "./.git" -prune -o \\( -name "run" -o -name "finish" -o -name "check" \\) -not -perm -u=x,g=x,o=x -print) 546 | if [[ -n "${WRONG_PERM}" ]]; then 547 | echo "The following S6 service files are missing the executable bit; canceling the faulty build: ${WRONG_PERM}" 548 | exit 1 549 | else 550 | echo "S6 service file perms look good." 551 | fi ''' 552 | } 553 | } 554 | } 555 | /* ####################### 556 | GitLab Mirroring and Quay.io Repo Visibility 557 | ####################### */ 558 | // Ping into Gitlab to mirror this repo and have a registry endpoint & mark this repo on Quay.io as public 559 | stage("GitLab Mirror and Quay.io Visibility"){ 560 | when { 561 | environment name: 'EXIT_STATUS', value: '' 562 | } 563 | steps{ 564 | sh '''curl -H "Content-Type: application/json" -H "Private-Token: ${GITLAB_TOKEN}" -X POST https://gitlab.com/api/v4/projects \ 565 | -d '{"namespace_id":'${GITLAB_NAMESPACE}',\ 566 | "name":"'${LS_REPO}'", 567 | "mirror":true,\ 568 | "import_url":"https://github.com/linuxserver/'${LS_REPO}'.git",\ 569 | "issues_access_level":"disabled",\ 570 | "merge_requests_access_level":"disabled",\ 571 | "repository_access_level":"enabled",\ 572 | "visibility":"public"}' ''' 573 | sh '''curl -H "Private-Token: ${GITLAB_TOKEN}" -X PUT "https://gitlab.com/api/v4/projects/Linuxserver.io%2F${LS_REPO}" \ 574 | -d "mirror=true&import_url=https://github.com/linuxserver/${LS_REPO}.git" ''' 575 | sh '''curl -H "Content-Type: application/json" -H "Authorization: Bearer ${QUAYIO_API_TOKEN}" -X POST "https://quay.io/api/v1/repository${QUAYIMAGE/quay.io/}/changevisibility" \ 576 | -d '{"visibility":"public"}' ||: ''' 577 | } 578 | } 579 | /* ############### 580 | Build Container 581 | ############### */ 582 | // Build Docker container for push to LS Repo 583 | stage('Build-Single') { 584 | when { 585 | expression { 586 | env.MULTIARCH == 'false' || params.PACKAGE_CHECK == 'true' 587 | } 588 | environment name: 'EXIT_STATUS', value: '' 589 | } 590 | steps { 591 | echo "Running on node: ${NODE_NAME}" 592 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile" 593 | sh "docker buildx build \ 594 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 595 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 596 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-netbox/packages\" \ 597 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-netbox\" \ 598 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-netbox\" \ 599 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 600 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 601 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 602 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 603 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 604 | --label \"org.opencontainers.image.title=Netbox\" \ 605 | --label \"org.opencontainers.image.description=[Netbox](https://github.com/netbox-community/netbox) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. \" \ 606 | --no-cache --pull -t ${IMAGE}:${META_TAG} --platform=linux/amd64 \ 607 | --provenance=true --sbom=true --builder=container --load \ 608 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 609 | sh '''#! /bin/bash 610 | set -e 611 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 612 | for i in "${CACHE[@]}"; do 613 | docker tag ${IMAGE}:${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 614 | done 615 | ''' 616 | withCredentials([ 617 | [ 618 | $class: 'UsernamePasswordMultiBinding', 619 | credentialsId: 'Quay.io-Robot', 620 | usernameVariable: 'QUAYUSER', 621 | passwordVariable: 'QUAYPASS' 622 | ] 623 | ]) { 624 | retry_backoff(5,5) { 625 | sh '''#! /bin/bash 626 | set -e 627 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 628 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 629 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 630 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 631 | 632 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 633 | declare -A pids 634 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 635 | for i in "${CACHE[@]}"; do 636 | docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} & 637 | pids[$!]="$i" 638 | done 639 | for p in "${!pids[@]}"; do 640 | wait "$p" || { [[ "${pids[$p]}" != *"quay.io"* ]] && exit 1; } 641 | done 642 | fi 643 | ''' 644 | } 645 | } 646 | } 647 | } 648 | // Build MultiArch Docker containers for push to LS Repo 649 | stage('Build-Multi') { 650 | when { 651 | allOf { 652 | environment name: 'MULTIARCH', value: 'true' 653 | expression { params.PACKAGE_CHECK == 'false' } 654 | } 655 | environment name: 'EXIT_STATUS', value: '' 656 | } 657 | parallel { 658 | stage('Build X86') { 659 | steps { 660 | echo "Running on node: ${NODE_NAME}" 661 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile" 662 | sh "docker buildx build \ 663 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 664 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 665 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-netbox/packages\" \ 666 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-netbox\" \ 667 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-netbox\" \ 668 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 669 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 670 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 671 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 672 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 673 | --label \"org.opencontainers.image.title=Netbox\" \ 674 | --label \"org.opencontainers.image.description=[Netbox](https://github.com/netbox-community/netbox) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. \" \ 675 | --no-cache --pull -t ${IMAGE}:amd64-${META_TAG} --platform=linux/amd64 \ 676 | --provenance=true --sbom=true --builder=container --load \ 677 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 678 | sh '''#! /bin/bash 679 | set -e 680 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 681 | for i in "${CACHE[@]}"; do 682 | docker tag ${IMAGE}:amd64-${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} 683 | done 684 | ''' 685 | withCredentials([ 686 | [ 687 | $class: 'UsernamePasswordMultiBinding', 688 | credentialsId: 'Quay.io-Robot', 689 | usernameVariable: 'QUAYUSER', 690 | passwordVariable: 'QUAYPASS' 691 | ] 692 | ]) { 693 | retry_backoff(5,5) { 694 | sh '''#! /bin/bash 695 | set -e 696 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 697 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 698 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 699 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 700 | 701 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 702 | declare -A pids 703 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 704 | for i in "${CACHE[@]}"; do 705 | docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} & 706 | pids[$!]="$i" 707 | done 708 | for p in "${!pids[@]}"; do 709 | wait "$p" || { [[ "${pids[$p]}" != *"quay.io"* ]] && exit 1; } 710 | done 711 | fi 712 | ''' 713 | } 714 | } 715 | } 716 | } 717 | stage('Build ARM64') { 718 | agent { 719 | label 'ARM64' 720 | } 721 | steps { 722 | echo "Running on node: ${NODE_NAME}" 723 | sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile.aarch64" 724 | sh "docker buildx build \ 725 | --label \"org.opencontainers.image.created=${GITHUB_DATE}\" \ 726 | --label \"org.opencontainers.image.authors=linuxserver.io\" \ 727 | --label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-netbox/packages\" \ 728 | --label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-netbox\" \ 729 | --label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-netbox\" \ 730 | --label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \ 731 | --label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \ 732 | --label \"org.opencontainers.image.vendor=linuxserver.io\" \ 733 | --label \"org.opencontainers.image.licenses=GPL-3.0-only\" \ 734 | --label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \ 735 | --label \"org.opencontainers.image.title=Netbox\" \ 736 | --label \"org.opencontainers.image.description=[Netbox](https://github.com/netbox-community/netbox) is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. \" \ 737 | --no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} --platform=linux/arm64 \ 738 | --provenance=true --sbom=true --builder=container --load \ 739 | --build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ." 740 | sh '''#! /bin/bash 741 | set -e 742 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 743 | for i in "${CACHE[@]}"; do 744 | docker tag ${IMAGE}:arm64v8-${META_TAG} ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} 745 | done 746 | ''' 747 | withCredentials([ 748 | [ 749 | $class: 'UsernamePasswordMultiBinding', 750 | credentialsId: 'Quay.io-Robot', 751 | usernameVariable: 'QUAYUSER', 752 | passwordVariable: 'QUAYPASS' 753 | ] 754 | ]) { 755 | retry_backoff(5,5) { 756 | sh '''#! /bin/bash 757 | set -e 758 | echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin 759 | echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin 760 | echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin 761 | echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin 762 | if [[ "${PACKAGE_CHECK}" != "true" ]]; then 763 | declare -A pids 764 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 765 | for i in "${CACHE[@]}"; do 766 | docker push ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} & 767 | pids[$!]="$i" 768 | done 769 | for p in "${!pids[@]}"; do 770 | wait "$p" || { [[ "${pids[$p]}" != *"quay.io"* ]] && exit 1; } 771 | done 772 | fi 773 | ''' 774 | } 775 | } 776 | sh '''#! /bin/bash 777 | containers=$(docker ps -aq) 778 | if [[ -n "${containers}" ]]; then 779 | docker stop ${containers} 780 | fi 781 | docker system prune -f --volumes || : 782 | docker image prune -af || : 783 | ''' 784 | } 785 | } 786 | } 787 | } 788 | // Take the image we just built and dump package versions for comparison 789 | stage('Update-packages') { 790 | when { 791 | branch "master" 792 | environment name: 'CHANGE_ID', value: '' 793 | environment name: 'EXIT_STATUS', value: '' 794 | } 795 | steps { 796 | sh '''#! /bin/bash 797 | set -e 798 | TEMPDIR=$(mktemp -d) 799 | if [ "${MULTIARCH}" == "true" ] && [ "${PACKAGE_CHECK}" != "true" ]; then 800 | LOCAL_CONTAINER=${IMAGE}:amd64-${META_TAG} 801 | else 802 | LOCAL_CONTAINER=${IMAGE}:${META_TAG} 803 | fi 804 | touch ${TEMPDIR}/package_versions.txt 805 | docker run --rm \ 806 | -v /var/run/docker.sock:/var/run/docker.sock:ro \ 807 | -v ${TEMPDIR}:/tmp \ 808 | ghcr.io/anchore/syft:${SYFT_IMAGE_TAG} \ 809 | ${LOCAL_CONTAINER} -o table=/tmp/package_versions.txt 810 | NEW_PACKAGE_TAG=$(md5sum ${TEMPDIR}/package_versions.txt | cut -c1-8 ) 811 | echo "Package tag sha from current packages in buit container is ${NEW_PACKAGE_TAG} comparing to old ${PACKAGE_TAG} from github" 812 | if [ "${NEW_PACKAGE_TAG}" != "${PACKAGE_TAG}" ]; then 813 | git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/${LS_REPO} 814 | git --git-dir ${TEMPDIR}/${LS_REPO}/.git checkout -f master 815 | cp ${TEMPDIR}/package_versions.txt ${TEMPDIR}/${LS_REPO}/ 816 | cd ${TEMPDIR}/${LS_REPO}/ 817 | wait 818 | git add package_versions.txt 819 | git commit -m 'Bot Updating Package Versions' 820 | git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 821 | git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master 822 | echo "true" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER} 823 | echo "Package tag updated, stopping build process" 824 | else 825 | echo "false" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER} 826 | echo "Package tag is same as previous continue with build process" 827 | fi 828 | rm -Rf ${TEMPDIR}''' 829 | script{ 830 | env.PACKAGE_UPDATED = sh( 831 | script: '''cat /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}''', 832 | returnStdout: true).trim() 833 | } 834 | } 835 | } 836 | // Exit the build if the package file was just updated 837 | stage('PACKAGE-exit') { 838 | when { 839 | branch "master" 840 | environment name: 'CHANGE_ID', value: '' 841 | environment name: 'PACKAGE_UPDATED', value: 'true' 842 | environment name: 'EXIT_STATUS', value: '' 843 | } 844 | steps { 845 | script{ 846 | env.EXIT_STATUS = 'ABORTED' 847 | } 848 | } 849 | } 850 | // Exit the build if this is just a package check and there are no changes to push 851 | stage('PACKAGECHECK-exit') { 852 | when { 853 | branch "master" 854 | environment name: 'CHANGE_ID', value: '' 855 | environment name: 'PACKAGE_UPDATED', value: 'false' 856 | environment name: 'EXIT_STATUS', value: '' 857 | expression { 858 | params.PACKAGE_CHECK == 'true' 859 | } 860 | } 861 | steps { 862 | script{ 863 | env.EXIT_STATUS = 'ABORTED' 864 | } 865 | } 866 | } 867 | /* ####### 868 | Testing 869 | ####### */ 870 | // Run Container tests 871 | stage('Test') { 872 | when { 873 | environment name: 'CI', value: 'true' 874 | environment name: 'EXIT_STATUS', value: '' 875 | } 876 | steps { 877 | withCredentials([ 878 | string(credentialsId: 'ci-tests-s3-key-id', variable: 'S3_KEY'), 879 | string(credentialsId: 'ci-tests-s3-secret-access-key ', variable: 'S3_SECRET') 880 | ]) { 881 | script{ 882 | env.CI_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/index.html' 883 | env.CI_JSON_URL = 'https://ci-tests.linuxserver.io/' + env.IMAGE + '/' + env.META_TAG + '/report.json' 884 | } 885 | sh '''#! /bin/bash 886 | set -e 887 | if grep -q 'docker-baseimage' <<< "${LS_REPO}"; then 888 | echo "Detected baseimage, setting LSIO_FIRST_PARTY=true" 889 | if [ -n "${CI_DOCKERENV}" ]; then 890 | CI_DOCKERENV="LSIO_FIRST_PARTY=true|${CI_DOCKERENV}" 891 | else 892 | CI_DOCKERENV="LSIO_FIRST_PARTY=true" 893 | fi 894 | fi 895 | docker pull ghcr.io/linuxserver/ci:${CITEST_IMAGETAG} 896 | if [ "${MULTIARCH}" == "true" ]; then 897 | docker pull ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} --platform=arm64 898 | docker tag ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG} 899 | fi 900 | docker run --rm \ 901 | --shm-size=1gb \ 902 | -v /var/run/docker.sock:/var/run/docker.sock \ 903 | -e IMAGE=\"${IMAGE}\" \ 904 | -e DOCKER_LOGS_TIMEOUT=\"${CI_DELAY}\" \ 905 | -e TAGS=\"${CI_TAGS}\" \ 906 | -e META_TAG=\"${META_TAG}\" \ 907 | -e RELEASE_TAG=\"latest\" \ 908 | -e PORT=\"${CI_PORT}\" \ 909 | -e SSL=\"${CI_SSL}\" \ 910 | -e BASE=\"${DIST_IMAGE}\" \ 911 | -e SECRET_KEY=\"${S3_SECRET}\" \ 912 | -e ACCESS_KEY=\"${S3_KEY}\" \ 913 | -e DOCKER_ENV=\"${CI_DOCKERENV}\" \ 914 | -e WEB_SCREENSHOT=\"${CI_WEB}\" \ 915 | -e WEB_AUTH=\"${CI_AUTH}\" \ 916 | -e WEB_PATH=\"${CI_WEBPATH}\" \ 917 | -e NODE_NAME=\"${NODE_NAME}\" \ 918 | -e SYFT_IMAGE_TAG=\"${CI_SYFT_IMAGE_TAG:-${SYFT_IMAGE_TAG}}\" \ 919 | -e COMMIT_SHA=\"${COMMIT_SHA}\" \ 920 | -e BUILD_NUMBER=\"${BUILD_NUMBER}\" \ 921 | -t ghcr.io/linuxserver/ci:${CITEST_IMAGETAG} \ 922 | python3 test_build.py''' 923 | } 924 | } 925 | } 926 | /* ################## 927 | Release Logic 928 | ################## */ 929 | // If this is an amd64 only image only push a single image 930 | stage('Docker-Push-Single') { 931 | when { 932 | environment name: 'MULTIARCH', value: 'false' 933 | environment name: 'EXIT_STATUS', value: '' 934 | } 935 | steps { 936 | retry_backoff(5,5) { 937 | sh '''#! /bin/bash 938 | set -e 939 | for PUSHIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 940 | [[ ${PUSHIMAGE%%/*} =~ \\. ]] && PUSHIMAGEPLUS="${PUSHIMAGE}" || PUSHIMAGEPLUS="docker.io/${PUSHIMAGE}" 941 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 942 | for i in "${CACHE[@]}"; do 943 | if [[ "${PUSHIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then 944 | CACHEIMAGE=${i} 945 | fi 946 | done 947 | docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${META_TAG} -t ${PUSHIMAGE}:latest -t ${PUSHIMAGE}:${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \ 948 | { if [[ "${PUSHIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 949 | if [ -n "${SEMVER}" ]; then 950 | docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \ 951 | { if [[ "${PUSHIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 952 | fi 953 | done 954 | ''' 955 | } 956 | } 957 | } 958 | // If this is a multi arch release push all images and define the manifest 959 | stage('Docker-Push-Multi') { 960 | when { 961 | environment name: 'MULTIARCH', value: 'true' 962 | environment name: 'EXIT_STATUS', value: '' 963 | } 964 | steps { 965 | retry_backoff(5,5) { 966 | sh '''#! /bin/bash 967 | set -e 968 | for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 969 | [[ ${MANIFESTIMAGE%%/*} =~ \\. ]] && MANIFESTIMAGEPLUS="${MANIFESTIMAGE}" || MANIFESTIMAGEPLUS="docker.io/${MANIFESTIMAGE}" 970 | IFS=',' read -ra CACHE <<< "$BUILDCACHE" 971 | for i in "${CACHE[@]}"; do 972 | if [[ "${MANIFESTIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then 973 | CACHEIMAGE=${i} 974 | fi 975 | done 976 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${META_TAG} -t ${MANIFESTIMAGE}:amd64-latest -t ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \ 977 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 978 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${META_TAG} -t ${MANIFESTIMAGE}:arm64v8-latest -t ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} || \ 979 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 980 | if [ -n "${SEMVER}" ]; then 981 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \ 982 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 983 | docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${SEMVER} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} || \ 984 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 985 | fi 986 | done 987 | for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do 988 | docker buildx imagetools create -t ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm64v8-latest || \ 989 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 990 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} || \ 991 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 992 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} || \ 993 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 994 | if [ -n "${SEMVER}" ]; then 995 | docker buildx imagetools create -t ${MANIFESTIMAGE}:${SEMVER} ${MANIFESTIMAGE}:amd64-${SEMVER} ${MANIFESTIMAGE}:arm64v8-${SEMVER} || \ 996 | { if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; } 997 | fi 998 | done 999 | ''' 1000 | } 1001 | } 1002 | } 1003 | // If this is a public release tag it in the LS Github 1004 | stage('Github-Tag-Push-Release') { 1005 | when { 1006 | branch "master" 1007 | expression { 1008 | env.LS_RELEASE != env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER 1009 | } 1010 | environment name: 'CHANGE_ID', value: '' 1011 | environment name: 'EXIT_STATUS', value: '' 1012 | } 1013 | steps { 1014 | sh '''#! /bin/bash 1015 | echo "Auto-generating release notes" 1016 | if [ "$(git tag --points-at HEAD)" != "" ]; then 1017 | echo "Existing tag points to current commit, suggesting no new LS changes" 1018 | AUTO_RELEASE_NOTES="No changes" 1019 | else 1020 | AUTO_RELEASE_NOTES=$(curl -fsL -H "Authorization: token ${GITHUB_TOKEN}" -H "Accept: application/vnd.github+json" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases/generate-notes \ 1021 | -d '{"tag_name":"'${META_TAG}'",\ 1022 | "target_commitish": "master"}' \ 1023 | | jq -r '.body' | sed 's|## What.s Changed||') 1024 | fi 1025 | echo "Pushing New tag for current commit ${META_TAG}" 1026 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/git/tags \ 1027 | -d '{"tag":"'${META_TAG}'",\ 1028 | "object": "'${COMMIT_SHA}'",\ 1029 | "message": "Tagging Release '${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}' to master",\ 1030 | "type": "commit",\ 1031 | "tagger": {"name": "LinuxServer-CI","email": "ci@linuxserver.io","date": "'${GITHUB_DATE}'"}}' 1032 | echo "Pushing New release for Tag" 1033 | curl -H "Authorization: token ${GITHUB_TOKEN}" -s https://api.github.com/repos/${EXT_USER}/${EXT_REPO}/releases/latest | jq -r '. |.body' > releasebody.json 1034 | jq -n \ 1035 | --arg tag_name "$META_TAG" \ 1036 | --arg target_commitish "master" \ 1037 | --arg ci_url "${CI_URL:-N/A}" \ 1038 | --arg ls_notes "$AUTO_RELEASE_NOTES" \ 1039 | --arg remote_notes "$(cat releasebody.json)" \ 1040 | '{ 1041 | "tag_name": $tag_name, 1042 | "target_commitish": $target_commitish, 1043 | "name": $tag_name, 1044 | "body": ("**CI Report:**\\n\\n" + $ci_url + "\\n\\n**LinuxServer Changes:**\\n\\n" + $ls_notes + "\\n\\n**Remote Changes:**\\n\\n" + $remote_notes), 1045 | "draft": false, 1046 | "prerelease": false }' > releasebody.json.done 1047 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done 1048 | ''' 1049 | } 1050 | } 1051 | // Add protection to the release branch 1052 | stage('Github-Release-Branch-Protection') { 1053 | when { 1054 | branch "master" 1055 | environment name: 'CHANGE_ID', value: '' 1056 | environment name: 'EXIT_STATUS', value: '' 1057 | } 1058 | steps { 1059 | echo "Setting up protection for release branch master" 1060 | sh '''#! /bin/bash 1061 | curl -H "Authorization: token ${GITHUB_TOKEN}" -X PUT https://api.github.com/repos/${LS_USER}/${LS_REPO}/branches/master/protection \ 1062 | -d $(jq -c . << EOF 1063 | { 1064 | "required_status_checks": null, 1065 | "enforce_admins": false, 1066 | "required_pull_request_reviews": { 1067 | "dismiss_stale_reviews": false, 1068 | "require_code_owner_reviews": false, 1069 | "require_last_push_approval": false, 1070 | "required_approving_review_count": 1 1071 | }, 1072 | "restrictions": null, 1073 | "required_linear_history": false, 1074 | "allow_force_pushes": false, 1075 | "allow_deletions": false, 1076 | "block_creations": false, 1077 | "required_conversation_resolution": true, 1078 | "lock_branch": false, 1079 | "allow_fork_syncing": false, 1080 | "required_signatures": false 1081 | } 1082 | EOF 1083 | ) ''' 1084 | } 1085 | } 1086 | // If this is a Pull request send the CI link as a comment on it 1087 | stage('Pull Request Comment') { 1088 | when { 1089 | not {environment name: 'CHANGE_ID', value: ''} 1090 | environment name: 'EXIT_STATUS', value: '' 1091 | } 1092 | steps { 1093 | sh '''#! /bin/bash 1094 | # Function to retrieve JSON data from URL 1095 | get_json() { 1096 | local url="$1" 1097 | local response=$(curl -s "$url") 1098 | if [ $? -ne 0 ]; then 1099 | echo "Failed to retrieve JSON data from $url" 1100 | return 1 1101 | fi 1102 | local json=$(echo "$response" | jq .) 1103 | if [ $? -ne 0 ]; then 1104 | echo "Failed to parse JSON data from $url" 1105 | return 1 1106 | fi 1107 | echo "$json" 1108 | } 1109 | 1110 | build_table() { 1111 | local data="$1" 1112 | 1113 | # Get the keys in the JSON data 1114 | local keys=$(echo "$data" | jq -r 'to_entries | map(.key) | .[]') 1115 | 1116 | # Check if keys are empty 1117 | if [ -z "$keys" ]; then 1118 | echo "JSON report data does not contain any keys or the report does not exist." 1119 | return 1 1120 | fi 1121 | 1122 | # Build table header 1123 | local header="| Tag | Passed |\\n| --- | --- |\\n" 1124 | 1125 | # Loop through the JSON data to build the table rows 1126 | local rows="" 1127 | for build in $keys; do 1128 | local status=$(echo "$data" | jq -r ".[\\"$build\\"].test_success") 1129 | if [ "$status" = "true" ]; then 1130 | status="✅" 1131 | else 1132 | status="❌" 1133 | fi 1134 | local row="| "$build" | "$status" |\\n" 1135 | rows="${rows}${row}" 1136 | done 1137 | 1138 | local table="${header}${rows}" 1139 | local escaped_table=$(echo "$table" | sed 's/\"/\\\\"/g') 1140 | echo "$escaped_table" 1141 | } 1142 | 1143 | if [[ "${CI}" = "true" ]]; then 1144 | # Retrieve JSON data from URL 1145 | data=$(get_json "$CI_JSON_URL") 1146 | # Create table from JSON data 1147 | table=$(build_table "$data") 1148 | echo -e "$table" 1149 | 1150 | curl -X POST -H "Authorization: token $GITHUB_TOKEN" \ 1151 | -H "Accept: application/vnd.github.v3+json" \ 1152 | "https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \ 1153 | -d "{\\"body\\": \\"I am a bot, here are the test results for this PR: \\n${CI_URL}\\n${SHELLCHECK_URL}\\n${table}\\"}" 1154 | else 1155 | curl -X POST -H "Authorization: token $GITHUB_TOKEN" \ 1156 | -H "Accept: application/vnd.github.v3+json" \ 1157 | "https://api.github.com/repos/$LS_USER/$LS_REPO/issues/$PULL_REQUEST/comments" \ 1158 | -d "{\\"body\\": \\"I am a bot, here is the pushed image/manifest for this PR: \\n\\n\\`${GITHUBIMAGE}:${META_TAG}\\`\\"}" 1159 | fi 1160 | ''' 1161 | 1162 | } 1163 | } 1164 | } 1165 | /* ###################### 1166 | Send status to Discord 1167 | ###################### */ 1168 | post { 1169 | always { 1170 | sh '''#!/bin/bash 1171 | rm -rf /config/.ssh/id_sign 1172 | rm -rf /config/.ssh/id_sign.pub 1173 | git config --global --unset gpg.format 1174 | git config --global --unset user.signingkey 1175 | git config --global --unset commit.gpgsign 1176 | ''' 1177 | script{ 1178 | env.JOB_DATE = sh( 1179 | script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''', 1180 | returnStdout: true).trim() 1181 | if (env.EXIT_STATUS == "ABORTED"){ 1182 | sh 'echo "build aborted"' 1183 | }else{ 1184 | if (currentBuild.currentResult == "SUCCESS"){ 1185 | if (env.GITHUBIMAGE =~ /lspipepr/){ 1186 | env.JOB_WEBHOOK_STATUS='Success' 1187 | env.JOB_WEBHOOK_COLOUR=3957028 1188 | env.JOB_WEBHOOK_FOOTER='PR Build' 1189 | }else if (env.GITHUBIMAGE =~ /lsiodev/){ 1190 | env.JOB_WEBHOOK_STATUS='Success' 1191 | env.JOB_WEBHOOK_COLOUR=3957028 1192 | env.JOB_WEBHOOK_FOOTER='Dev Build' 1193 | }else{ 1194 | env.JOB_WEBHOOK_STATUS='Success' 1195 | env.JOB_WEBHOOK_COLOUR=1681177 1196 | env.JOB_WEBHOOK_FOOTER='Live Build' 1197 | } 1198 | }else{ 1199 | if (env.GITHUBIMAGE =~ /lspipepr/){ 1200 | env.JOB_WEBHOOK_STATUS='Failure' 1201 | env.JOB_WEBHOOK_COLOUR=12669523 1202 | env.JOB_WEBHOOK_FOOTER='PR Build' 1203 | }else if (env.GITHUBIMAGE =~ /lsiodev/){ 1204 | env.JOB_WEBHOOK_STATUS='Failure' 1205 | env.JOB_WEBHOOK_COLOUR=12669523 1206 | env.JOB_WEBHOOK_FOOTER='Dev Build' 1207 | }else{ 1208 | env.JOB_WEBHOOK_STATUS='Failure' 1209 | env.JOB_WEBHOOK_COLOUR=16711680 1210 | env.JOB_WEBHOOK_FOOTER='Live Build' 1211 | } 1212 | } 1213 | sh ''' curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jenkins-avatar.png","embeds": [{"'color'": '${JOB_WEBHOOK_COLOUR}',\ 1214 | "footer": {"text" : "'"${JOB_WEBHOOK_FOOTER}"'"},\ 1215 | "timestamp": "'${JOB_DATE}'",\ 1216 | "description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** '${JOB_WEBHOOK_STATUS}'\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\ 1217 | "username": "Jenkins"}' ${BUILDS_DISCORD} ''' 1218 | } 1219 | } 1220 | } 1221 | cleanup { 1222 | sh '''#! /bin/bash 1223 | echo "Pruning builder!!" 1224 | docker builder prune -f --builder container || : 1225 | containers=$(docker ps -q) 1226 | if [[ -n "${containers}" ]]; then 1227 | BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit') 1228 | for container in ${containers}; do 1229 | if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then 1230 | echo "skipping buildx container in docker stop" 1231 | else 1232 | echo "Stopping container ${container}" 1233 | docker stop ${container} 1234 | fi 1235 | done 1236 | fi 1237 | docker system prune -f --volumes || : 1238 | docker image prune -af || : 1239 | ''' 1240 | cleanWs() 1241 | } 1242 | } 1243 | } 1244 | 1245 | def retry_backoff(int max_attempts, int power_base, Closure c) { 1246 | int n = 0 1247 | while (n < max_attempts) { 1248 | try { 1249 | c() 1250 | return 1251 | } catch (err) { 1252 | if ((n + 1) >= max_attempts) { 1253 | throw err 1254 | } 1255 | sleep(power_base ** n) 1256 | n++ 1257 | } 1258 | } 1259 | return 1260 | } 1261 | --------------------------------------------------------------------------------