All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. All dates in this file are given in the UTC time zone.
- A warning has been added when the user access the landing page using any hostname other than
pkscope-{machine-name}.local, that such a hostname will not work for accessing the PlanktoScope via a Wi-Fi router or Ethernet router, and insteadpkscope-{machine-name}.localmust be used in such situations.
- The deprecation warning for the
planktoscope.localhostname has been removed, as that hostname is being undeprecated for v2024.0.0 (starting with v2024.0.0-beta.1).
- The links to Portainer have been removed, as part of the deprecation of Portainer in the default configuration of v2024.0.0 of the PlanktoScope OS.
- The links to the offline copies of the operation protocols are no longer broken.
- The stylesheets were not generated correctly in 0.2.0; they should now be generated correctly again.
- (Breaking change) Instead of generating a machine name from a serial number which is either specified as the
MACHINENAME_SNenvironment variable or loaded from a file specified by theMACHINENAME_SNFILEenvironment variable, now the device portal just tries to load the machine name from theMACHINENAME_NAMEenvironment variable or else from a file specified by theMACHINENAME_NAMEFILEenvironment variable (which defaults to/run/machine-name), and it falls back to a name of "unknown" if no machine name is found.
- Fixed malformed HTML structure on the landing page.
- Added a link to the Grafana dashboard.
- Added an API entry for the node-exporter host metrics.
- Added an infrastructure entry for the Prometheus server.
- Added a link to the Dozzle log viewer.
- All links now open in new tabs (see PlanktoScope#231).
- The landing page now shows a deprecation notice to the user if it is accessed using the
planktoscope.localhostname. - The URL for the online PlanktoScope project documentation has been changed from the old site (https://planktoscope.readthedocs.io) to the new site (https://docs.planktoscope.community).
- Shortened machine names and updated information about machine-specific domain names and URLs to use the new
pkscopeabbreviation instead ofplanktoscope(see PlanktoScope#214).
- Fixed mistakes in machine-specific URLs.
- Added more information to the "Wrong PlanktoScope?" section to help users troubleshoot situations where they're connected to the wrong PlanktoScope.
- Fixed the ability to scroll the landing page with arrow keys upon initial load (rather than having to click on the landing page first).
- Added link to a file browser for the device-backend's logs
- Added links to offline copies of the PlanktoScope quantitative protocols from protocols.io.
- Moved links for Cockpit, the system file manager, Portainer, and the Node-RED dashboard editor into the "For advanced users" section of the home page.
- Added a link to the offline PlanktoScope documentation, served from the PlanktoScope itself.
- Fixed a few incorrect URLs to other services from the landing page.
- When trying to determine the machine's serial number from a file (e.g. from the Raspberry Pi's firmware device tree), only the 32 least-significant bits (i.e. the 8 rightmost hex characters) are used. This is needed because the Raspberry Pi 4's serial number is prefixed with
10000000.
- When trying to determine the machine's serial number from a file (e.g. from the Raspberry Pi's firmware device tree), any trailing null terminators in the file are ignored.
- The machine name is now lazily loaded upon the first time the landing page is loaded and, unless an error occurs (e.g. from trying to determine the machine's serial number), cached for future use.
- (Breaking change) The optional
SERIAL_NUMBERenvironment variable has been renamed toMACHINENAME_SN, and the optionalSERIAL_NUMBER_FILEenvironment variable has been renamed toMACHINENAME_SNFILE.
- A minimalist static web page with a list of useful links.