oxidized 0.32.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ef1ef47a42a57f4d0b01e6a0201a604c9ff722c6b1f0452fa97d2352f0c55b
-  data.tar.gz: 15717e0e5f7344a0449054d66c412bf77a8710e59e3db003195dd3bd2eb21ee3
+  metadata.gz: 140d9918c8f356fb866500593ccfdbc0b0ade3c031e44153e7be7c6277869a3e
+  data.tar.gz: 4d56807c0167af119671e7535ec89df076c0a91cc6f965b2ed966957c4a7c860
 SHA512:
-  metadata.gz: 401435f585a12c13a81fd3c7a30f7190a83cf9d0a39fb417b9c80342a8dc78a0d570dac53f060fb54aed039989f579a113d4040e21405c81c25760d6a9720a4a
-  data.tar.gz: ed46c959fccbbbabdd60aecdb2a517b2262f956cb184eee34bb85558a88805c25e743d45d45d3d7a90847f8132d7a4f891c00ff95c7cb32c873a4108029102bf
+  metadata.gz: 8c3b76b96bd7718bccfe34a74823528e842af98cc930da843e60267c5d874cedfd7c91fe7fd821079ccb97b680054a7f31d260813479054e21c237651735b211
+  data.tar.gz: 2a2c9e98d51c5a0db06636c2c769aa4342badc6a3ed665ade1fafa84552732c2aa4fab82df7824a3488c16850185891b8de6a09a01bd6becdfddc95770d320c5

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Create a report to help us improve oxidized
+title: ''
+labels: bug
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Configure '...'
+2. Use model '....'
+3. Run '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Configuration**
+```
+If applicable, publish your configuration.
+```
+
+**Logs**
+```
+If applicable, add logs to help explain your problem.
+```
+
+**Running environment (please complete the following information):**
+<!-- complete the following information and add further details if needed -->
+- OS: [e.g. Debian Bookworm, official container version xxx, ...]
+- oxidized version: [e.g. 0.32.2]
+- oxidized-web version: [e.g. 0.15.1, if applicable]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context  about the feature request here.

data/.github/ISSUE_TEMPLATE/support-request.md

@@ -0,0 +1,36 @@
+---
+name: Support request
+about: Ask for help
+title: ''
+labels: question
+assignees: ''
+
+---
+<!-- Check the box [X] -->
+- [ ] I have read and understood [docs/Issues.md](https://github.com/ytti/oxidized/blob/master/docs/Issues.md).
+
+**Describe the problem**
+A clear and concise description of what your problem is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Configuration**
+```
+If applicable, publish your configuration.
+```
+
+**Logs**
+```
+If applicable, add logs to help explain your problem.
+```
+
+**Running environment (please complete the following information):**
+<!-- complete the following information and add further details if needed -->
+- OS: [e.g. Debian Bookworm, official container version xxx, ...]
+- oxidized version: [e.g. 0.32.2]
+- oxidized-web version: [e.g. 0.15.1, if applicable]
+
+**Additional context**
+Add any other context about the problem here.
+

data/.github/workflows/publishdocker.yml

@@ -2,24 +2,43 @@ name: Publish Docker
 on:
   push:
     branches: [ "master" ]
+    tags: [ "[0-9]+.[0-9]+.[0-9]+" ]
+
 jobs:
   build:
     if: github.repository_owner == 'ytti'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-      with:
-        fetch-depth: 0
-    - name: Get Release Version
-      id: get_version
-      run: echo "release-version=$(git describe --tags)" >> $GITHUB_OUTPUT
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
-    - name: Publish to Registry
-      uses: elgohr/Publish-Docker-Github-Action@v5
-      with:
-        name: oxidized/oxidized
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-        tags: "latest,${{ steps.get_version.outputs.release-version }}"
-        platforms: linux/amd64,linux/arm64
+
+      - name: Define tags
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            oxidized/oxidized
+          tags: |
+            type=semver,pattern={{version}}
+            type=sha,prefix=master-
+          flavor: |
+            latest=true
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          build-args: |
+            BUILDKIT_CONTEXT_KEEP_GIT_DIR=true

data/.gitignore

@@ -52,3 +52,4 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+/.rake_tasks~

data/.rubocop.yml

@@ -3,8 +3,6 @@ inherit_from: .rubocop_todo.yml
 plugins:
   - rubocop-rake
   - rubocop-minitest
-
-require:
   - rubocop-sequel
 
 AllCops:

data/.rubocop_todo.yml

@@ -1,57 +1,31 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-02-17 10:13:53 UTC using RuboCop version 1.72.1.
+# on 2025-03-26 12:52:00 UTC using RuboCop version 1.74.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 30
+# Offense count: 33
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
 
-# Offense count: 17
+# Offense count: 19
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 14
+# Offense count: 16
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 12
 
-# Offense count: 1
-Naming/ConstantName:
-  Exclude:
-    - 'extra/rest_client.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - 'lib/refinements.rb'
-
 # Offense count: 2
 Rake/DuplicateTask:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
-Security/Eval:
-  Exclude:
-    - 'Rakefile'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/oxidized/config/vars.rb'
-
 # Offense count: 2
 Style/ClassVars:
   Exclude:
@@ -77,7 +51,7 @@ Style/OpenStructUse:
 Style/SlicingWithRange:
   Enabled: false
 
-# Offense count: 94
+# Offense count: 99
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Mode.
 Style/StringConcatenation:

data/CHANGELOG.md

@@ -4,8 +4,60 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## [0.32.0 – 2025-02-20]
-This minor release fixes a javascript issue in oxidized-web, which is included
+## [0.33.0 - 2025-03-26]
+This release changes the way to configure oxidized-web. The old `rest`
+configuration is still supported but deprecated. The new configuration works
+with oxidized-web 0.16.0 or later.
+See [docs/Configuration.md](/docs/Configuration.md#oxidized-web-RESTful-API-and-web-interface).
+
+The docker container includes
+[security fixes to ruby-rake](https://ubuntu.com/security/notices/USN-7366-1),
+so be sure to update to the latest version.
+
+### Added
+- unifiap: new model for Unifi APs, switches, and AirOS APs (@clifcox)
+- github: Issue templates for bugs, feature requests and support requests (@robertcheramy)
+- model for Ingate Operating System (@thanegill)
+- model for Easton Gigabit Network Card (@thanegill)
+
+### Changed
+- fortios: support for FortiADC (@electrocret)
+- output/git: cache commit log to improve performance of oxidized-web. Fixes #3121 (@robertcheramy)
+- input/http: digest auth handles special characters in passwords by itself (no need to url encode them manually) (@einglasvollkakao)
+- changed the configuration for oxidized-web from rest: to extensions.oxidized-web (@robertcheramy)
+- netgear: add pager-handler workaround, fixes: #2394 and #3341 (@candlerb, @syn-bit)
+- Output#version (git/gitcrypt) returns a Time object in its hash for more flexibility in oxidized-web (@robertcheramy)
+- ios: hide secret key of aaa radius (@martinberg, @robertcheramy)
+- container: update to phusion/baseimage:noble-1.0.1 (@robertcheramy)
+
+### Fixed
+- powerconnect: Mask the changing temperature issue for non-stacked switches. Fixes #2088 (@clifcox)
+- Fix frozen string literals (@robertcheramy)
+- powerconnect: Cleanup login/logout logic. Fixes #3437 (@clifcox)
+- aos7: remove extra lines occuring when `show hardware-info` runs slow (@rouven0)
+- srosmd: add ignore regex for 64-bit system uptime (@emiliaaah)
+- removed some rubocop warnings (@robertcheramy)
+
+## [0.32.2 – 2025-02-27]
+This patch release mainly fixes the docker building process, wich resulted in
+0.32.1 not beeing built.
+
+### Changed
+- docker image: updated github CI to explicitly build tag versions (@robertcheramy)
+- docker image: update rake build_container to match the tags of GitHub CI (@robertcheramy)
+
+### Fixed
+- powerconnect: restore last line of command output, and remove spurious CR characters. Fixes #2692 (@clifcox)
+- powerconnect: Remove undesirable inserted blank lines during pagination. Fixes #3413 (@clifcox)
+- docker image: remove ubuntu user introduced in noble. Fixes #3336 (@robertcheramy)
+- docker image: correct rights under /home/oxidized. Fixes #3336 (@robertcheramy)
+- docker image: revert the use of GEM_HOME. Fixes #3331 (@robertcheramy)
+- docker image: improve the documentation. Fixes #3336 (@robertcheramy)
+- docker image: remove examples/podman-compose as this is better documented in docs/Docker.md (@robertcheramy)
+
+
+## [0.32.1 – 2025-02-20]
+This patch release fixes a javascript issue in oxidized-web, which is included
 in the Docker container of oxidized.
 
 ### Fixed

data/CONTRIBUTING.md

@@ -1,6 +1,15 @@
 # Oxidized - Contributing Guide
 You can contribute to [Oxidized](https://github.com/ytti/oxidized/) in many ways, and first of all we'd like to thank you for taking your time to improve this great project!
 
+> ## Legal Notice
+> When submitting content to this project, you must agree that you have authored 100%
+> of the content, that you have the necessary rights to the content and that the
+> content you contribute may be provided under the project license.
+>
+> If you are employed, you probably need the permission from your employer to
+> contribute to open source projects.
+
+
 ## Contribute as a user
 A great place for users to get involved is the [GitHub issues](https://github.com/ytti/oxidized/issues).
 Through the issues, you can interact with maintainers and other users. You can open an issue
@@ -9,13 +18,6 @@ if you need help, but you can also help other users by reviewing their issues an
 Before writing an issue, please read our documentation on
 [how to write good issues](/docs/Issues.md).
 
-> ## Legal Notice
-> When submitting content to this project, you must agree that you have authored 100%
-> of the content, that you have the necessary rights to the content and that the
-> content you contribute may be provided under the project license.
->
-> If you are employed, you probably need the permission from your employer to
-> contribute to open source projects.
 
 ## Contribute some content
 Content contributions are always welcome. You do not need to be a maintainer for this.
@@ -25,6 +27,7 @@ enhancements :-)
 Contributions can be submitted through pull requests in github. For a full explanation how to
 contribute some content, see [How to contribute content](#how-to-contribute-content).
 
+
 ## Help Needed
 
 As things stand right now, `oxidized` is maintained by a few people. A great

data/Dockerfile

@@ -1,61 +1,27 @@
-###################
-# Stage 1: Prebuild to save space in the final image.
-
-FROM docker.io/phusion/baseimage:noble-1.0.0 AS prebuilder
-
-# install necessary packages for building gems
-RUN apt-get update && apt-get install -y \
-    build-essential \
-    git \
-    ruby-dev \
-    && rm -rf /var/lib/apt/lists/*
-
-# create bundle directory
-RUN mkdir -p /usr/local/bundle
-ENV GEM_HOME=/usr/local/bundle
-
-###################
-# Install the x25519 gem
-RUN gem install x25519 --no-document
-
-
-###################
-# build oxidized
-COPY . /tmp/oxidized/
-WORKDIR /tmp/oxidized
-
-# docker automated build gets shallow copy, but non-shallow copy cannot be unshallowed
-RUN git fetch --unshallow || true
-
-# Remove any older gems of oxidized if they exist
-RUN rm pkg/* || true
-
-# Ensure rugged is built with ssh support
-RUN rake build
-
-
-###################
-# Stage2: build an oxidized container from phusion/baseimage-docker and install x25519 from stage1
-FROM docker.io/phusion/baseimage:noble-1.0.0
+FROM docker.io/phusion/baseimage:noble-1.0.1
 
 ENV DEBIAN_FRONTEND=noninteractive
 
 ##### Place "static" commands at the beginning to optimize image size and build speed
+# remove default ubuntu user
+RUN userdel -r ubuntu
+
 # add non-privileged user
 ARG UID=30000
 ARG GID=$UID
 RUN groupadd -g "${GID}" -r oxidized && useradd -u "${UID}" -r -m -d /home/oxidized -g oxidized oxidized
 
-# link config for msmtp for easier use.
-RUN ln -s /home/oxidized/.config/oxidized/.msmtprc /home/oxidized/
-
-# create parent directory & touch required file
-RUN mkdir -p /home/oxidized/.config/oxidized/
-RUN touch /home/oxidized/.config/oxidized/.msmtprc
 
-# setup the access to the file
-RUN chmod 600 /home/oxidized/.msmtprc
-RUN chown oxidized:oxidized /home/oxidized/.msmtprc
+##### MSMTP - Sending emails
+# link config for msmtp for easier use.
+# /home/oxidized/.msmtprc is a symbolic link to /home/oxidized/.config/oxidized/.msmtprc
+# Create the files as the user oxidized
+RUN mkdir -p /home/oxidized/.config/oxidized/ && \
+    chmod -R ug=rwX,o= /home/oxidized/.config/ && \
+    touch /home/oxidized/.config/oxidized/.msmtprc && \
+    chmod -R u=rw,go= /home/oxidized/.config/oxidized/.msmtprc && \
+    ln -s /home/oxidized/.config/oxidized/.msmtprc /home/oxidized/ && \
+    chown -R oxidized:oxidized /home/oxidized/.config /home/oxidized/.msmtprc
 
 # add runit services
 COPY extra/oxidized.runit /etc/service/oxidized/run
@@ -63,10 +29,10 @@ COPY extra/auto-reload-config.runit /etc/service/auto-reload-config/run
 COPY extra/update-ca-certificates.runit /etc/service/update-ca-certificates/run
 
 # set up dependencies for the build process
-RUN apt-get -yq update \
-    && apt-get -yq upgrade \
-    && apt-get -yq --no-install-recommends install ruby \
-    # Build process of oxidized from git (beloww)
+RUN apt-get -qy update \
+    && apt-get -qy upgrade \
+    && apt-get -qy --no-install-recommends install ruby \
+    # Build process of oxidized from git (below)
     git \
     # Allow git send-email from docker image
     git-email libmailtools-perl \
@@ -90,13 +56,6 @@ RUN apt-get -yq update \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-# copy the compiled gem from the builder stage
-COPY --from=prebuilder /usr/local/bundle /usr/local/bundle
-
-# Set environment variables for bundler
-ENV GEM_HOME="/usr/local/bundle"
-ENV PATH="$GEM_HOME/bin:$PATH"
-
 # gems not available in ubuntu noble
 RUN gem install --no-document \
     # dependencies for hooks
@@ -106,11 +65,25 @@ RUN gem install --no-document \
     # Net scp is needed in Version >= 4.1.0, which is not available in ubuntu
     net-scp
 
-# install oxidized from prebuilder
-# The Dockerfile ist version-independent, so use oxidized-*.gem to cach the gem
-RUN mkdir -p /tmp/oxidized
-COPY --from=prebuilder /tmp/oxidized/pkg/oxidized-*.gem /tmp/oxidized/
-RUN gem install /tmp/oxidized/oxidized-*.gem
+# Prepare the build of oxidized, copy our workig directory in the container
+COPY . /tmp/oxidized/
+WORKDIR /tmp/oxidized
+
+# Install gems which needs a build environment
+RUN apt-get -qy update && \
+    apt-get -qy install --no-install-recommends \
+                        build-essential git ruby-dev && \
+    ##### X25519 (a.k.a. Curve25519) Elliptic Curve Diffie-Hellman
+    gem install x25519 && \
+    ##### build & install oxidized from the working repository
+    # docker automated build gets shallow copy, but non-shallow copy cannot be unshallowed
+    git fetch --unshallow || true && \
+    rake install && \
+    # remove the packages we do not need.
+    apt-get -qy remove build-essential git ruby-dev && \
+    apt-get -qy autoremove && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
 
 # install oxidized-web
 RUN gem install oxidized-web --no-document

data/README.md

@@ -1,9 +1,6 @@
 # Oxidized
 
 [![Build Status](https://github.com/ytti/oxidized/actions/workflows/ruby.yml/badge.svg)](https://github.com/ytti/oxidized/actions/workflows/ruby.yml)
-[![codecov.io](https://codecov.io/gh/ytti/oxidized/coverage.svg?branch=master)](https://codecov.io/gh/ytti/oxidized?branch=master)
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5a90cb22db6a4d5ea23ad0dfb53fe03a)](https://www.codacy.com/app/ytti/oxidized?utm_source=github.com&utm_medium=referral&utm_content=ytti/oxidized&utm_campaign=Badge_Grade)
-[![Code Climate](https://codeclimate.com/github/ytti/oxidized/badges/gpa.svg)](https://codeclimate.com/github/ytti/oxidized)
 [![Gem Version](https://badge.fury.io/rb/oxidized.svg)](http://badge.fury.io/rb/oxidized)
 [![Join the chat at https://gitter.im/oxidized/Lobby](https://badges.gitter.im/oxidized/Lobby.svg)](https://gitter.im/oxidized/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -14,7 +11,7 @@ It is light and extensible and supports over 130 operating system types.
 Feature highlights:
 
 * Automatically adds/removes threads to meet configured retrieval interval
-* Restful API to a move node immediately to head-of-queue (GET/POST /node/next/[NODE])
+* Restful API to a move node immediately to head-of-queue (GET/PUT /node/next/[NODE])
 * Syslog udp+file example to catch config change events (IOS/JunOS) and trigger a config fetch
   * Will signal which IOS/JunOS user made the change, can then be used by output modules (via POST)
   * The `git` output module uses this info - 'git blame' will show who changed each line
@@ -37,8 +34,7 @@ Check out the [Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU?t=3h
     * [CentOS, Oracle Linux, Red Hat Linux](#centos-oracle-linux-red-hat-linux)
     * [FreeBSD](#freebsd)
     * [Build from Git](#build-from-git)
-    * [Docker](#running-with-docker)
-    * [Podman-Compose](#running-with-podman-compose)
+    * [Docker & Podman](docs/Docker.md)
     * [Installing Ruby 2.3 using RVM](#installing-ruby-23-using-rvm)
 3. [Initial Configuration](#configuration)
 4. [Configuration](docs/Configuration.md)
@@ -155,95 +151,8 @@ gem install bundler
 rake install
 ```
 
-### Running with Docker
-
-Currently, Docker Hub automatically builds the master branch for linux/amd64 and linux/arm64 platforms as [oxidized/oxidized](https://hub.docker.com/r/oxidized/oxidized/), you can make use of this container or build your own.
-
-To build your own, clone git repo:
-
-```shell
-git clone https://github.com/ytti/oxidized
-```
-
-Then, build the container locally (requires docker 17.05.0-ce or higher):
-
-```shell
-docker build -q -t oxidized/oxidized:latest oxidized/
-```
-
-Once you've built the container (or chosen to make use of the automatically built container in Docker Hub, which will be downloaded for you by docker on the first `run` command had you not built it), proceed as follows:
-
-Create a configuration directory in the host system:
-
-```shell
-mkdir /etc/oxidized
-```
-
-Run the container for the first time to initialize the config:
-
-_Note: this step in only required for creating the Oxidized configuration file and can be skipped if you already have one._
-
-```shell
-docker run --rm -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp --user oxidized -t oxidized/oxidized:latest oxidized
-```
-
-If the RESTful API and Web Interface are enabled, on the docker host running the container
-edit `/etc/oxidized/config` and modify `rest: 127.0.0.1:8888` to `rest: 0.0.0.0:8888`. This will bind port 8888 to all interfaces, and expose the port so that it could be accessed externally. [(Issue #445)](https://github.com/ytti/oxidized/issues/445)
-
-Alternatively, you can use docker-compose to launch the oxidized container:
-
-```yaml
-# docker-compose.yml
-# docker-compose file example for oxidized that will start along with docker daemon
----
-version: "3"
-services:
-  oxidized:
-    restart: always
-    image: oxidized/oxidized:latest
-    ports:
-      - 8888:8888/tcp
-    environment:
-      CONFIG_RELOAD_INTERVAL: 600
-    volumes:
-       - config:/home/oxidized/.config/oxidized/
-volumes:
-  config:
-```
-
-Create the `/etc/oxidized/router.db` (see [CSV Source](docs/Sources.md#source-csv) for further info):
-
-```shell
-vim /etc/oxidized/router.db
-```
-
-Run container again to start oxidized with your configuration:
-
-```shell
-docker run -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest
-oxidized[1]: Oxidized starting, running as pid 1
-oxidized[1]: Loaded 1 nodes
-Puma 2.13.4 starting...
-* Min threads: 0, max threads: 16
-* Environment: development
-* Listening on tcp://0.0.0.0:8888
-```
-
-If you want to have the config automatically reloaded (e.g. when using a http source that changes):
-
-```shell
-docker run -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp -e CONFIG_RELOAD_INTERVAL=3600 -t oxidized/oxidized:latest
-```
-
-If you need to use an internal CA (e.g. to connect to an private github instance):
-
-```shell
-docker run -v /etc/oxidized:/home/oxidized/.config/oxidized -v /path/to/MY-CA.crt:/usr/local/share/ca-certificates/MY-CA.crt -p 8888:8888/tcp -e UPDATE_CA_CERTIFICATES=true -t oxidized/oxidized:latest
-```
-
-### Running with podman-compose
-Under [examples/podman-compose](examples/podman-compose), you will find a complete
-example of how to integrate the container into a docker-compose.yml file.
+### Running with Docker or Podman
+See [docs/Docker.md](docs/Docker.md)
 
 ### Installing Ruby 2.3 using RVM
 

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require_relative 'lib/oxidized/version'
 
-gemspec = eval(File.read(Dir['*.gemspec'].first))
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
 gemfile = [gemspec.name, gemspec.version].join('-') + '.gem'
 
 # Integrate Rubocop if available
@@ -41,11 +41,6 @@ task :version_set do
   Bundler::GemHelper.instance.gemspec.version = Oxidized::VERSION
 end
 
-# desc 'Install gem'
-# task install: :build do
-#    system "sudo -Es sh -c \'umask 022; gem install gems/#{gemfile}\'"
-# end
-
 desc 'Remove gems'
 task :clean do
   FileUtils.rm_rf 'pkg'
@@ -95,15 +90,19 @@ end
 
 desc 'Build the container image with docker or podman'
 task :build_container do
+  branch_name = %x(git rev-parse --abbrev-ref HEAD).chop
+  sha_hash = %x(git rev-parse --short HEAD).chop
+  image_tag = "#{branch_name}-#{sha_hash}"
+
   # Prefer podman if available as it runs rootless
   if command_available?('podman')
-    sh 'podman build -t oxidized:`git describe --tags` -t oxidized:latest .'
+    sh "podman build -t oxidized:#{image_tag} -t oxidized:latest ."
   elsif command_available?('docker')
     if docker_needs_root?
       puts 'docker needs root to build the image. Using sudo...'
-      sh 'sudo docker build -t oxidized:`git describe --tags` -t oxidized:latest .'
+      sh "sudo docker build -t oxidized:#{image_tag} -t oxidized:latest ."
     else
-      sh 'docker build -t oxidized:`git describe --tags` -t oxidized:latest .'
+      sh "docker build -t oxidized:#{image_tag} -t oxidized:latest ."
     end
   else
     puts 'You need Podman or Docker to build the container image.'