networkupstools / nut-website Goto Github PK
View Code? Open in Web Editor NEWNetwork UPS Tools website and protocol library
Network UPS Tools website and protocol library
networkupstools/nut#808
check if in git
Hello,
Not so much of an issue, but more of an inquiry. I have a HP Micro Mini setup running home assistant and I connected my CyberPower UPS to it via the USB cable. I added the NUT addon and integration. All works well. Very happy with it. I do have two other UPS's in my home that have a RMCARD205 in them. I am not sure if this is even possible without the use of a small Raspberry Pi, but can I somehow have two instances of nut and one of which would connect via Ethernet. The HP Micro Mini and both RMCARD205's are on the same vlan. Any help and suggestions would be appreciated.
To point at the official and staging websites
It appears that we have not included /protocols/snmp in this git repository. This mostly seems to be copies of MIB files.
e.g. https://networkupstools.org/docs/man/riello_ser.html is from almost a year ago now, and there were changes last week in NUT code for it; I saw reports that some man pages were missing altogether - e.g. in the historic site rendition: https://networkupstools.org/historic/v2.8.2/docs/man/index.html#User_man (it was there for previous historic release snapshot: https://networkupstools.org/historic/v2.8.1/docs/man/index.html#Developer_man and before that).
news page does refresh though, release notes are also at post-2.8.2 level https://networkupstools.org/docs/release-notes.chunked/index.html reflecting the master-branch changes at e.g. https://networkupstools.org/docs/release-notes.chunked/NUT_Release_Notes.html#_planned_release_notes_for_nut_2_8_3_what_8217_s_new_since_2_8_2
I'd like to suggest a few changes be made to the Projects page to bring it up to date as best as I can find.
Setting up an environment to make and test changes myself seemed a little daunting so I'm not sure I can get to this straight away, but hopefully this is helpful as a starting point.
Investigate what https://antora.org/ can do for us, is it worth spending time on (adds modern design etc.)?
As an alternative to #30
I had a community chat yesterday with a guy who wanted to configure an UPS for their systems, and pointed them to NUT. Happens they did not know of it (last UPS set up with apcupsd 10 years ago, never looked into this area since). A near-instant feedback was that the NUT website (front page) is pretty hard to navigate for the real newcomers - like to understand what the project does at all, how it's layered etc.
I passed them the direct links in the chat, but they were 2-3 clicks away and that's if you know where to click :)
So just FYI - readability and usability is a real-life issue ;)
Maybe a good start would be a top-link to page marked as "Newcomer Intro" or some such, with a mix of overviews from user and devel guides and the feature page (but less white space and huge headers than the latter).
These versions of documents seem to be rendered and cross-referenced with anchors more consistently than chunked-HTML (and single-PDF) docs, as explored in networkupstools/nut#1957 as well as having a single file-name is more future-proof for persistent links. Publishing them on NUT website could facilitate linking from documents, mails, wikis, etc.
networkupstools.org presents an invalid GitHub SSL certificate:
$ openssl s_client -connect networkupstools.org:443
CONNECTED(00000003)
depth=2 C = US, O = DigiCert Inc, OU = www.digicert.com, CN = DigiCert High Assurance EV Root CA
verify return:1
depth=1 C = US, O = DigiCert Inc, OU = www.digicert.com, CN = DigiCert SHA2 High Assurance Server CA
verify return:1
depth=0 C = US, ST = California, L = San Francisco, O = "GitHub, Inc.", CN = *.github.com
verify return:1
---
Certificate chain
0 s:/C=US/ST=California/L=San Francisco/O=GitHub, Inc./CN=*.github.com
i:/C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert SHA2 High Assurance Server CA
1 s:/C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert SHA2 High Assurance Server CA
i:/C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert High Assurance EV Root CA
This is especially problematic when trying to download NUT, e.g. when packaging it:
$ wget 'http://www.networkupstools.org/source/2.7/nut-2.7.4.tar.gz'
--2017-04-23 11:13:45-- http://www.networkupstools.org/source/2.7/nut-2.7.4.tar.gz
Resolving www.networkupstools.org... 151.101.12.133
Connecting to www.networkupstools.org|151.101.12.133|:80... connected.
HTTP request sent, awaiting response... 301 Moved Permanently
Location: https://networkupstools.org/source/2.7/nut-2.7.4.tar.gz [following]
--2017-04-23 11:13:45-- https://networkupstools.org/source/2.7/nut-2.7.4.tar.gz
Loaded CA certificate '/etc/ssl/certs/ca-certificates.crt'
Resolving networkupstools.org... 192.30.252.154, 192.30.252.153
Connecting to networkupstools.org|192.30.252.154|:443... connected.
GnuTLS: A TLS warning alert has been received.
GnuTLS: received alert [112]: The server name sent was not recognized
The certificate's owner does not match hostname ‘networkupstools.org’
networkupstools/nut#186
check if in git
A https://networkupstools.org/docs/man/hwmon_ina219.html rendered page did appear for the new driver added in networkupstools/nut#2430
However it is not listed in the https://networkupstools.org/docs/man/index.html listing.
TODO:
@zykh: When Buildbot tries to build the website, it runs a "git clean -fdx" in the nut-website checkout ("~buildbot/slaves/buildslave-cayman/Debian-website/build/") to clean everything that isn't version tracked, and runs the same command in the nut submodule directory.
When running ./autogen.sh, it throws the error shown here:
http://buildbot.networkupstools.org/public/nut/builders/Debian-website -> latest build (currently 17) -> configure/stdio
Readying NUT Website
----------------------------------------------------------------------
Calling autoreconf...
configure.ac:19: error: possibly undefined macro: AC_MSG_RESULT
If this token and others are legitimate, please use m4_pattern_allow.
See the Autoconf documentation.
configure.ac:22: error: possibly undefined macro: AC_MSG_ERROR
autoreconf: /usr/bin/autoconf failed with exit status: 1
If I re-run ./autogen.sh manually, it completes, but then configure complains:
$ ./configure
Network UPS Tools - Website (NUT version 2.7.1)
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
./configure: line 2213: NUT_CHECK_ASCIIDOC: command not found
checking if asciidoc version can build website (minimum required 8.6.3)... ./configure: line 2217: syntax error near unexpected token `${ASCIIDOC_VERSION},'
./configure: line 2217: `AX_COMPARE_VERSION(${ASCIIDOC_VERSION}, ge, 8.6.3,'
Same version of autoconf as on OS X (which works the first time that ./autogen.sh is run), but automake is a little older:
$ autoconf --version
autoconf (GNU Autoconf) 2.69
$ automake --version
automake (GNU automake) 1.11.6
Reminder from @aquette : improvement over the 1rst gen website generator (as currently used with networkupstools.org)
For asciidoc + bootstrap, it mainly relies on the J's/ subdir plus this asciidoc conf for bootstrap:
https://github.com/42ity/42ity-org-website/blob/master/bootstrap.conf
And a bit of salt in the Makefile too.
As per http://laurent-laville.org/asciidoc/bootstrap/, the version in 42ity is the latest (2015 😕). So no need to update the integration
UPDATE: Some more links for reference:
Related to issues #34 and networkupstools/nut#1949
Maybe magic text in annotated tag or having been signed can be a clue.
Also note
Lines 89 to 90 in 6436163
I get the following error in OS X:
sort: stray character in field spec: invalid field specification `4.1,4.5rV'
The man page on FreeBSD also indicates that sort does not support dots in the field specification.
This is a pretty low-priority bug, but eventually I would like to add an autoconf test to see if "gsort" is installed.
This requires specifying a codebase to Buildbot, and filtering the commits in both schedulers.
Also, it may be preferable to have a separate builder to handle man pages and documentation outside of the website update cycle (or we should add a step to automatically update the nut submodule).
As in many other places, the UPS mention is extraneous and not true, since we also have PDU and ATS at least.
So rename the ups-protocols page and mentions to simply "protocols".
This is spread across several repositories:
For now "fixed" manually. Possibly stems from alphabetic sort etc. instead of git history? Or just not regenerated even after posting the historic-release and master versions of the site?
Need more investigation; should have used tag-based PACKAGE_VERSION or similar...
We have a link (http://www.networkupstools.org/lists/) on the Alioth Mailman info pages (e.g. http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/nut-upsuser) which is dead, and the Alioth setup isn't allowing edits at the moment. The list link should probably redirect to http://networkupstools.org/support.html instead.
In the list of projects, there is a reference to Winnutclient on the sourceforge site.
However, this project has not been maintained since 2015 and I personally took over the development from Github : WinNUT-Client
The project has evolved considerably and I am quite active in its development.
I would be grateful if you could update the corresponding projects page.
I have a FOSS project whose web site is generated by
asciidoc
and some custom scripts as an horde (thousands) of static files locally in the source files' repo, copied into another workspace and uploaded to github.io style repository, and eventually is rendered as an HTTP server for browsers around the world to see.Users occasionally report that some of the links between site pages end up broken (lead nowhere).
The website build platform is generally POSIX-ish, although most often the agent doing the regular work is a Debian/Linux one. Maybe the platform differences cause the "page outages"; maybe this bug is platform-independent.
I had a thought about crafting a check for the two local directories as well as the resulting site to crawl all relative links (and/or absolute ones starting with its domain name(s)), and report any broken pages so I could focus on finding why they fail and/or avoiding publication of "bad" iterations - same as with compilers, debuggers and warnings elsewhere.
The general train of thought is about using some
wget
spider mode, though any other command-line tool (curl
,lynx
...), python script, shell withsed
, etc. would do as well. Surely this particular wheel has been invented too many times for me to even think about making my own? A quick and cursory googling session while on commute did not come up with any good fit however.So, suggestions are welcome :)
Posted as a question at https://unix.stackexchange.com/questions/775994/how-to-check-consistency-of-a-generated-web-site-using-recursive-html-parsing
NUT repository has a number of tags for intermediate milestones during development, which are not releases (candidates, major side project merges).
However the website links from https://networkupstools.org/download.html#_stable_tree_2_8 seem to report just the newest (possibly annotated) git tag => inspired link. For example, at the moment it suggests http://www.networkupstools.org/source/2.8/nut-2.8.0-Windows.tar.gz which is not even published among sources (separate repo) which may in fact be a criterion for choosing what maintainers think is a release - just pick the newest of those.
(is this on a branch somewhere?)
Recent generations of https://networkupstools.org/stable-hcl.html list the manufacturer/model/driver column contents as b'some string'
markup, which may be Python for "binary". Probably have to append .encode('utf-8')
(or similar) somewhere to rectify.
Results of #12 and #13 / #14 are not seen in the codebase... like someone force-pushed to master and erased recent commits?
The code is still available in https://github.com/networkupstools/nut-website/tree/pull_404 branch BTW (up-to-date with my devel fork version). There are some merge conflicts reported ATM, to look at when we have time :-)
Reminder from @aquette
For example, now that we have had a long time passed after the last (2.7.4) official release, there is a large gap between content that can be relevant to users of distro-provided NUT packages vs. current information matching the evolving codebase on github. Hopefully future gaps will be smaller, but still inevitable.
I have experimented with this a bit, and concluded that GitHub Pages integration only allows one web-site per organization. There can be additional repositories with Pages enabled, whose repo name is a "sub-URI" in that one website.
We can use sub-domain names with web-redirection from Gandi DNS+ hosting to point from "simple" (and non-SSL) Web server names like http://master.networkupstools.org/ to the URI we want, but then the users would browse unwieldy https://networkupstools.org/networkupstools-master.github.io/ (where "networkupstools-master.github.io" comes from https://github.com/networkupstools/networkupstools-master.github.io/ repo).
A possibly better solution would be to use just one git repository for the resulting generated website, but define a sub-directory structure for data populated from release-tagged NUT/NUT-DDL(/...?) sources. This way the main site evolves as it did, generating stuff from master branches, and the frozen-in-time sub spaces are generated once. There is probably some content that might cause their regeneration (changes to page layout? bottom-banners especially if dictated by sponsors/partners? left menu?..) but that would be rare - at least, original version-dependent content should remain.
This approach may however need re-engineering of some generated links (e.g. there is no point storing historic archives many times), though there may be some mess around NUT DDL (especially for "new" datapoints about discovered device support with older NUT releases)...
Spellcheck jobs on Travis CI keep complaining about words in nut-website
text files that are covered in nut/doc/nut.dict
that is supposedly used. Similar runs on local workstation work without errors.
It is possible that the spellcheck related Makefile
hardcodes a bit too much, so I began experimenting with a more flexible mechanism that could be more easily and reliably hijacked by consumers from other Makefiles (man pages subdir did so etc. already, website now also a focus point).
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.