oxidized-web 0.15.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef98fc626264e84687d7bdbfdb2a0a34aa5744086f34cdf3b84ddd823995246f
-  data.tar.gz: 7d43d90aa5027a130fba180db8c976200a19875978fb09bb9572d65a37ceb104
+  metadata.gz: 3a14e46c410d51b9da6a86d6d67fc35bdaed177adfbb006b1e2df4ec12c958bc
+  data.tar.gz: 7dc9144e706052817ca761a4e80151d40ee73fd7467c31894d2d5fa21c4767b0
 SHA512:
-  metadata.gz: 9fdc33d367f0beb19545a31d73a830ecfb786d152cfdb8b6b28f0335c04b3fa40d524c47c49107cabe48785c788bcf38686e822038eb2e2cf37cf54b1b7267a8
-  data.tar.gz: 863d0e8381d5c55053922e581bf788fd93da4e45f90435e47b2afea678515f2d0e064b2471e81ce607b897c8deb6f0dbeb0fad57d67c088d4e323be2530f9bdd
+  metadata.gz: c5b12efffe62f84156e27d30405a2934a9340373bd4b6b5ad9e3df41d65258bc9ab65221c5f153b813b41b17835a673b576c746da3f497332a870aaadec3a26e
+  data.tar.gz: 8fb63afdf4b7dc9dbca3e052b75efc2377506171764456353e1478be36ac82629be3f87445918a2471f13f143280b5cd021d8fa34b6ea834deccd74b95b891b5

data/.gitignore

@@ -10,6 +10,7 @@
 /test/version_tmp/
 /tmp/
 .idea/
+/.rake_tasks~
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -52,3 +53,6 @@ Gemfile.lock
 
 # npm files
 /node_modules/
+
+# Editors
+.vscode

data/.rubocop.yml

@@ -1,4 +1,3 @@
-inherit_from: .rubocop_todo.yml
 plugins:
   - rubocop-rails
   - rubocop-rake
@@ -14,12 +13,31 @@ AllCops:
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
 
+Metrics/AbcSize:
+  Enabled: false
+
 Metrics/ClassLength:
-  Max: 300
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
 
 Metrics/BlockLength:
   Max: 150
 
+# Not using Rails, so no timezones
+Rails/TimeZone:
+  Enabled: false
+
+Rails/RakeEnvironment:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -70,3 +88,5 @@ Style/HashSyntax:
 Style/RescueModifier:
   Enabled: false
 
+Style/NumericLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -3,8 +3,37 @@
 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.17.0 – 2025-07-18]
+
+### Added
+- Documentation of the configuration (@robertcheramy)
+
+### Changed
+- Update weblibs to the latest versions (@robertcheramy)
+- Depend on oxidized 0.34.0 (configuration of oxidized web as an extension) (@robertcheramy)
+- Use JSON to format the node metadata in /node/show (@robertcheramy)
+
+### Fixed
+- Run puma directly, so that it does not rename the oxidized process. Fixes: 349 (@robertcheramy)
+- Display local time correctly and use epoch as timestamps in the URLs. Fixes: #258 and #356 (@robertcheramy)
+- Hide node vars when listed in the configuration entry hide_node_vars. Fixes: #344 (@robertcheramy)
+- /node/next/: Prefer JSON.parse over JSON.load (@robertcheramy)
+
+## [0.16.0 - 2025-03-25]
+This release introduces the possibility for an extended configuration of
+oxidized-web in the oxidized configuration file. Oxidized versions after 0.32.2
+will only work with oxidized-web version 0.16.0 or later.
+
+### Changed
+- Allow connection to any virtual hosts + prepare extended configuration to specify which vhosts to accept. Fixes #298 (@robertcheramy)
+
+### Fixed
+- the table preferences (pagelength, column visibility, search) are stored in the local browser cache. Fixes #315 #314 #265 #211 (@robertcheramy)
+- Update "refresh" and "Update node list" to more meaningful texts (@robertcheramy)
+
 ## [0.15.1 – 2025-02-20]
-This minor release fixes javascript errors.
+This patch release fixes javascript errors.
 
 ### Fixed
 - Fix javascript not working (@robertcheramy)

data/README.md

@@ -3,15 +3,25 @@
 [![Build Status](https://github.com/ytti/oxidized-web/actions/workflows/ruby.yml/badge.svg)](https://github.com/ytti/oxidized-web/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/oxidized-web.svg)](http://badge.fury.io/rb/oxidized-web)
 
-Web userinterface and RESTful API for Oxidized.
+Web user interface and RESTful API for Oxidized.
 
-This is not useful independently, see https://github.com/ytti/oxidized for install instructions.
+## Installation
+This is not useful independently, see https://github.com/ytti/oxidized for
+install instructions.
 
+Note: because of its dependencies, installing the `oxidized-web` gem will
+install `oxidized` automatically.
+
+## Configuration
+`oxidized-web` is configured through the configuration of `oxidized`,
+in the `extension` section. For details, see
+[docs/configuration.md](docs/configuration.md).
+
+## Development
 If you wonder how to run oxidized-web from git for development, have a look at
 [docs/development.md](docs/development.md).
 
 ## License and Copyright
-
 Copyright 2013-2015 Saku Ytti <saku@ytti.fi>
           2013-2015 Samer Abdel-Hafez <sam@arahant.net>
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-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
@@ -9,7 +9,6 @@ begin
   require 'rubocop/rake_task'
 
   RuboCop::RakeTask.new
-  task(:default).prerequisites << task(:rubocop)
 rescue LoadError
   task :rubocop do
     puts 'Install rubocop to run its rake tasks'
@@ -32,7 +31,9 @@ task :test do
   end
 end
 
+desc 'build the gem'
 task build: :chmod
+
 ## desc 'Install gem'
 ## task :install => :build do
 ##   system "sudo -Es sh -c \'umask 022; gem install gems/#{file}\'"
@@ -53,7 +54,7 @@ task push: :tag do
   system "gem push pkg/#{gemfile}"
 end
 
-desc 'Normalise file permissions'
+desc 'Normalize file permissions'
 task :chmod do
   xbit = %w[]
   dirs = []
@@ -99,6 +100,10 @@ task :weblibs do
   weblibs << 'node_modules/datatables.net-buttons/js/dataTables.buttons.js'
   weblibs << 'node_modules/datatables.net-buttons/js/buttons.colVis.js'
 
+  # dayjs
+  weblibs << 'node_modules/dayjs/dayjs.min.js'
+  weblibs << 'node_modules/dayjs-plugin-utc/dist/dayjs-plugin-utc.min.js'
+
   weblibs.each do |w|
     cp(w, 'lib/oxidized/web/public/weblibs')
   end
@@ -108,4 +113,4 @@ task :weblibs do
   end
 end
 
-task default: :test
+task default: %i[rubocop test]

data/docs/configuration.md

@@ -0,0 +1,90 @@
+# Basic configuration
+The RESTful API and web interface are enabled by installing the `oxidized-web`
+gem and configuring the `extensions.oxidized-web:` section in the configuration
+file:
+```yaml
+extensions:
+  oxidized-web:
+    load: true
+    # enter your configuration here
+```
+
+You can set the following parameter:
+- `load`: `true`/`false`: Enables or disables the `oxidized-web` extension
+  (default: `false`)
+- `listen`: Specifies the interface to bind to (default: `127.0.0.1`). Valid
+  options:
+  - `127.0.0.1`: Allows IPv4 connections from localhost only
+  - `'[::1]'`: Allows IPv6 connections from localhost only
+  - `<IPv4-Address>` or `'[<IPv6-Address>]'`: Binds to a specific interface
+  - `0.0.0.0`: Binds to any IPv4 interface
+  - `'[::]'`:  Binds to any IPv4 and IPv6 interface
+- `port`: Specifies the TCP port to listen to (default: `8888`)
+- `url_prefix`: Defines a URL prefix (default: no prefix)
+- `vhosts`: A list of virtual hosts to listen to. If not specified, it will
+  respond to any virtual host.
+
+## Examples
+
+```yaml
+# Listen on http://[::1]:8888/
+extensions:
+  oxidized-web:
+    load: true
+    listen: '[::1]'
+    port: 8888
+```
+
+```yaml
+# Listen on http://127.0.0.1:8888/
+extensions:
+  oxidized-web:
+    load: true
+    listen: 127.0.0.1
+    port: 8888
+```
+
+```yaml
+# Listen on http://[2001:db8:0:face:b001:0:dead:beaf]:8888/oxidized/
+extensions:
+  oxidized-web:
+    load: true
+    listen: '[2001:db8:0:face:b001:0:dead:beaf]'
+    port: 8888
+    url_prefix: oxidized
+```
+
+```yaml
+# Listen on http://10.0.0.1:8000/oxidized/
+extensions:
+  oxidized-web:
+    load: true
+    listen: 10.0.0.1
+    port: 8000
+    url_prefix: oxidized
+```
+
+```yaml
+# Listen on any interface to http://oxidized.rocks:8888 and
+# http://oxidized:8888
+extensions:
+  oxidized-web:
+    load: true
+    listen: '[::]'
+    url_prefix: oxidized
+    vhosts:
+     - oxidized.rocks
+     - oxidized
+```
+
+# Hide node vars
+Some node vars (enable, password) can contain sensible data. You can list the
+vars to be hidden under `hide_node_vars`:
+```yaml
+extensions:
+  oxidized-web:
+    load: true
+    hide_node_vars:
+     - enable
+     - password
+```

data/docs/development.md

@@ -21,7 +21,7 @@ bundle exec oxidized
 Changes to haml templates are reloaded on the fly. For changes to the ruby
 scripts, you have to stop an restart `bundle exec oxidized`.
 
-## Paralell development between oxidized and oxidized-web
+## Parallel development between oxidized and oxidized-web
 You may need to make some changes in oxidized **and** oxidized-web. For this,
 git clone oxidized and oxidized-web in a common root directory.
 
@@ -39,12 +39,12 @@ bundle install
 bundle exec bin/oxidized
 ```
 
-Be careful when commiting your work in oxidized *NOT* to include the changes to
+Be careful when committing your work in oxidized *NOT* to include the changes to
 Gemfile, as this is a local change for development. I (@robertcheramy) didn't
 find a better way to do this, better ideas are welcome :-)
 
 If your changes to oxidized **AND** oxidzed-web are dependent from another, make
-sure you document this in the respectives CHANGELOG.md, so that everyone is
+sure you document this in the respective CHANGELOG.md, so that everyone is
 informed at the next release.
 
 Note: you can also add the dependency to oxidized in oxidized-web, in the same
@@ -85,6 +85,12 @@ forget to document your changes in CHANGELOG.md.
 
 # How to release a new version of Oxidized-web?
 
+## Version numbering
+Oxidized-web versions are numbered like major.minor.patch
+- currently, the major version is 0.
+- minor is incremented when releasing new features.
+- patch is incremented when releasing fixes only.
+
 ## Review changes
 Run `git diff 0.xx.yy..master` (where `0.xx.yy` is to be changed to the last
 release) and review all the changes that have been done. Have a specific look
@@ -100,72 +106,72 @@ bundle update
 bundle outaded
 ```
 
-Retest after updating!
+Test again after updating!
 
 ## Update the weblibs to the latest versions
 ```
 npm outdated
 ```
 
-Retest after updating!
-
-## Update rubocup .rubocop_todo.yml
-Run `bundle exec rubocop --auto-gen-config`,
-and make sure `bundle exec rake` passes after it.
-
-If you change some code => Restart the release process at the beginning ;-)
+Test again after updating!
 
 ## Make sure the file permissions are correct
 Run `bundle exec rake chmod`
 
-## Test, test test!
-Run `bundle exec rake` on the git repository to check the code against rubocop and rund the
-defined tests in `/spec`.
+## Create a release branch
+Name the release branch `release/0.xx.yy`
 
-Run Oxidized-web from git against the latest Oxidized version `bundle exec oxdized`
+Update CHANGELOG.md:
+- review it
+- add release notes
+- set the new version (replace `[Unreleased]` with `[0.xx.yy – 202Y-MM-DD]`)
+
+Change the version in `lib/oxidized/web/version.rb`
 
-Run Oxidized-web from git against the latest git of Oxidized (see above).
+Upload the branch to github, make a Pull Request for it.
 
-Do not integrate late PRs into master if they do not fix issues for the release. The must wait for the next release.
+## Test!
+Run `bundle exec rake` on the git repository to check the code against rubocop
+and run the defined tests in `/spec`.
+
+Run Oxidized-web from git against the latest Oxidized version `bundle exec oxdized`
 
 When testing the web application, open the javascript console in the browser to
 see any errors.
 
-## Version numbering
-Oxidized-web versions are nummered like 0.major.minor
-- major is incremented when releasing new features. minor is then set to 0
-- minor is incremented when releasing fixes only, just after a major version.
-
 ## Release
-1. Checkout the master branch of oxidized-web. Make sure you are up to date with origin.
-2. Change the version in lib/oxidized/web/version.rb
-3. Change CHANGELOG.md to replace [Unreleased] with [0.xx.yy – 202Y-MM-DD]
-4. Run `git diff` to check your changes
-5. Commit the changes to the local git repository with a commit message “chore(release): release version 0.xx.yy”
-6. Tag the commit with `git tag -a 0.xx.yy -m "Release 0.xx.yy"`
-7. Build the gem with ‘rake build’
-8. Install an test the gem locally:
-```
+1. Merge the Pull Request into master with the commit message
+   `chore(release): release version 0.3x.y`
+2. `git pull` master
+3. Tag the commit with `git tag -a 0.xx.yy -m "Release 0.xx.yy"`
+4. Build the gem with ‘rake build’
+5. Run `git diff` to check if there have been more changes (there shouldn't)
+6. Install an test the gem locally
+```shell
 gem install --user-install pkg/oxidized-web-0.xx.yy.gem
 ~/.local/share/gem/ruby/3.1.0/bin/oxidized
 ```
+
 ## Release in github
-1. Push the commit and the tag to github:
+Push the tag to github:
 ```
-git push
 git push origin 0.xx.yy
 ```
 
-2. Make a release from the tag in github
-- Thank the contributors
-- Only describe major changes, and refer to CHANGELOG.md
+Make a release from the tag in github.
+- Take the release notes frm CHANGELOG.md
 - List new contributors (generated automatically)
+- Keep the Full Changelog (generated automatically)
 
 ## Release in rubygems
 Push the gem with ‘rake push’
 
 You need an account at rubygems which is allowed to push oxidized
 
+## Release in docker.io
+In order to release in docker.io, oxidized be released to a new version,
+as the container is build there.
+
 ## Update CHANGELOG.md for next release
 Add
 ```
@@ -180,6 +186,3 @@ Add
 ```
 And push to github
 
-## Congratulate yourself
-Great job! Treat yourself to your favorite drink, you deserve it!
-

data/lib/oxidized/web/public/scripts/oxidized.js

@@ -2,22 +2,22 @@ var convertTime = function() {
   /* Convert UTC times to local browser times
   *  Requires that the times on the server are UTC
   *  Requires a class name of `time` to be set on element desired to be changed
-  *  Requires that element have a text in the format of `YYYY-mm-dd HH:MM:SS`
-  *  See ytti/oxidized-web #16
+  *  Requires that element has an attribute `epoch` containing the seconds since
+  *  1.1.1970 UTC.
   */
   $('.time').each(function() {
     var content = $(this).text();
-    if(content === 'never' || content === 'unknown' || content === '') { return; }
-    var utcTime = content.split(' ');
-    var date = new Date(utcTime[0] + 'T' + utcTime[1] + 'Z');
-    var year = date.getFullYear();
-    var month = ("0"+(date.getMonth()+1)).slice(-2);
-    var day = ("0" + date.getDate()).slice(-2);
-    var hour = ("0" + date.getHours()).slice(-2);
-    var minute = ("0" + date.getMinutes()).slice(-2);
-    var second = ("0" + date.getSeconds()).slice(-2);
-    var timeZone = date.toString().match(/[A-Z]{3,4}[+-][0-9]{4}/)[0];
-    $(this).text(year + '-' + month + '-' + day + ' ' + hour + ':' + minute + ':' + second + ' ' + timeZone);
+    if(content === 'never' || content === 'unknown' || content === '') {
+      return;
+    }
+    var epoch = $(this).attr('epoch');
+    if(epoch === undefined) {
+      return;
+    }
+    var utcTime = Number(epoch);
+    var dj = dayjs.unix(utcTime).local();
+
+    $(this).text(dj.format('YYYY-MM-DD HH:mm:ss [(UTC]Z[)]'));
   });
 };
 

data/lib/oxidized/web/public/weblibs/bootstrap-icons.css

@@ -1,5 +1,5 @@
 /*!
- * Bootstrap Icons v1.11.3 (https://icons.getbootstrap.com/)
+ * Bootstrap Icons v1.13.1 (https://icons.getbootstrap.com/)
  * Copyright 2019-2024 The Bootstrap Authors
  * Licensed under MIT (https://github.com/twbs/icons/blob/main/LICENSE)
  */
@@ -7,8 +7,8 @@
 @font-face {
   font-display: block;
   font-family: "bootstrap-icons";
-  src: url("./fonts/bootstrap-icons.woff2?dd67030699838ea613ee6dbda90effa6") format("woff2"),
-url("./fonts/bootstrap-icons.woff?dd67030699838ea613ee6dbda90effa6") format("woff");
+  src: url("./fonts/bootstrap-icons.woff2?e34853135f9e39acf64315236852cd5a") format("woff2"),
+url("./fonts/bootstrap-icons.woff?e34853135f9e39acf64315236852cd5a") format("woff");
 }
 
 .bi::before,
@@ -2076,3 +2076,31 @@ url("./fonts/bootstrap-icons.woff?dd67030699838ea613ee6dbda90effa6") format("wof
 .bi-suitcase2-fill::before { content: "\f901"; }
 .bi-suitcase2::before { content: "\f902"; }
 .bi-vignette::before { content: "\f903"; }
+.bi-bluesky::before { content: "\f7f9"; }
+.bi-tux::before { content: "\f904"; }
+.bi-beaker-fill::before { content: "\f905"; }
+.bi-beaker::before { content: "\f906"; }
+.bi-flask-fill::before { content: "\f907"; }
+.bi-flask-florence-fill::before { content: "\f908"; }
+.bi-flask-florence::before { content: "\f909"; }
+.bi-flask::before { content: "\f90a"; }
+.bi-leaf-fill::before { content: "\f90b"; }
+.bi-leaf::before { content: "\f90c"; }
+.bi-measuring-cup-fill::before { content: "\f90d"; }
+.bi-measuring-cup::before { content: "\f90e"; }
+.bi-unlock2-fill::before { content: "\f90f"; }
+.bi-unlock2::before { content: "\f910"; }
+.bi-battery-low::before { content: "\f911"; }
+.bi-anthropic::before { content: "\f912"; }
+.bi-apple-music::before { content: "\f913"; }
+.bi-claude::before { content: "\f914"; }
+.bi-openai::before { content: "\f915"; }
+.bi-perplexity::before { content: "\f916"; }
+.bi-css::before { content: "\f917"; }
+.bi-javascript::before { content: "\f918"; }
+.bi-typescript::before { content: "\f919"; }
+.bi-fork-knife::before { content: "\f91a"; }
+.bi-globe-americas-fill::before { content: "\f91b"; }
+.bi-globe-asia-australia-fill::before { content: "\f91c"; }
+.bi-globe-central-south-asia-fill::before { content: "\f91d"; }
+.bi-globe-europe-africa-fill::before { content: "\f91e"; }