UPGRADING

   1 ifdef::txt[]
   2 Upgrading notes
   3 ===============
   4 endif::txt[]
   5
   6 This file lists changes that affect users who installed older versions
   7 of this software.  When upgrading from an older version, be sure to
   8 check this file to see if you need to make changes to your system.
   9
  10 Changes from 2.6.5 to 2.7.1
  11 ---------------------------
  12
  13 - The apcsmart driver has been replaced by a new implementation. There is a new
  14   parameter, 'ttymode', which may help if you have a non-standard serial port,
  15   or Windows.  In case of issues with this new version, users can revert to
  16   apcsmart-old.
  17
  18 - The nutdrv_qx driver will eventually supersede blazer_ser and blazer_usb.
  19   Options are not exactly the same, but are documented in the nutdrv_qx man
  20   page.
  21
  22 - Mozilla NSS support has been added. The OpenSSL configuration options should
  23   be unchanged, but please refer to the linkman:upsd.conf[5] documentation in
  24   case we missed something.
  25
  26 - The jNut source is now here: https://github.com/networkupstools/jNut
  27
  28 Changes from 2.6.4 to 2.6.5
  29 ---------------------------
  30
  31 - users are encouraged to update to NUT 2.6.5, to fix a regression in
  32 upssched.
  33 - mge-shut driver has been replaced by a new implementation (newmge-shut).
  34 In case of issue with this new version, users can revert to oldmge-shut.
  35
  36 Changes from 2.6.3 to 2.6.4
  37 ---------------------------
  38
  39 - users are encouraged to update to NUT 2.6.4, to fix upsd vulnerability
  40 (CVE-2012-2944: upsd can be remotely crashed).
  41 - users of the bestups driver are encouraged to switch to blazer_ser,
  42 since bestups will soon be deprecated.
  43
  44 Changes from 2.6.2 to 2.6.3
  45 ---------------------------
  46
  47 - nothing that affects upgraded systems.
  48
  49 Changes from 2.6.1 to 2.6.2
  50 ---------------------------
  51
  52 - apcsmart driver has been replaced by a new implementation. In case of issue
  53 with this new version, users can revert to apcsmart-old.
  54
  55 Changes from 2.6.0 to 2.6.1
  56 ---------------------------
  57
  58 - nothing that affects upgraded systems.
  59
  60 Changes from 2.4.3 to 2.6.0
  61 ---------------------------
  62
  63 - users of the megatec and megatec_usb drivers must respectively switch to
  64 blazer_ser and blazer_usb.
  65 - users of the liebertgxt2 driver are advised that the driver name has changed
  66 to liebert-esp2.
  67
  68 Changes from 2.4.2 to 2.4.3
  69 ---------------------------
  70
  71 - nothing that affects upgraded systems.
  72
  73 Changes from 2.4.1 to 2.4.2
  74 ---------------------------
  75
  76 - The default subdriver for the blazer_usb driver USB id 06da:0003 has changed.
  77 If you use such a device and it is no longer working with this driver, override
  78 the 'subdriver' default in 'ups.conf' (see man 8 blazer).
  79 - NUT ACL and the allowfrom mechanism has been replaced in 2.4.0 by the LISTEN
  80 directive and tcp-wrappers respectively. This information was missing below, so
  81 a double note has been added.
  82
  83 Changes from 2.4.0 to 2.4.1
  84 ---------------------------
  85
  86 - nothing that affects upgraded systems.
  87
  88 Changes from 2.2.2 to 2.4.0
  89 ---------------------------
  90
  91 - The nut.conf file has been introduced to standardize startup configuration
  92 across the various systems.
  93 - The cpsups and nitram drivers have been replaced by the powerpanel driver,
  94 and removed from the tree. The cyberpower driver may suffer the same in the
  95 future.
  96 - The al175 and energizerups drivers have been removed from the tree, since
  97 these were tagged broken for a long time.
  98 - Developers of external client application using libupsclient must rename
  99 their "UPSCONN" client structure to "UPSCONN_t".
 100 - The upsd server will now disconnect clients that remain silent for more than
 101 60 seconds.
 102 - The files under scripts/python/client are distributed under GPL 3+, whereas
 103 the rest of the files are distributed under GPL 2+. Refer to COPYING for more
 104 information.
 105 - The generated udev rules file has been renamed with dash only, no underscore
 106 anymore (ie 52-nut-usbups.rules instead of 52_nut-usbups.rules)
 107
 108 Changes from 2.2.1 to 2.2.2
 109 ---------------------------
 110
 111 - The configure option "--with-lib" has been replaced by "--with-dev".
 112 This enable the additional build and distribution of the static
 113 version of libupsclient, along with the pkg-config helper and manual
 114 pages. The default configure option is to distribute only the shared
 115 version of libupsclient. This can be overriden by using the
 116 "--disable-shared" configure option (distribute static only binaries).
 117 - The UPS poweroff handling of the usbhid-ups driver has been reworked.
 118 Though regression is not expected, users of this driver are
 119 encouraged to test this feature by calling "upsmon -c fsd" and
 120 report any issue on the NUT mailing lists.
 121
 122 Changes from 2.2.0 to 2.2.1
 123 ---------------------------
 124
 125 - nothing that affects upgraded systems.
 126 (The below message is repetead due to previous omission)
 127 - Developers of external client application using libupsclient are
 128 encouraged to rename their "UPSCONN" client structure to "UPSCONN_t"
 129 since the former will disappear by the release of NUT 2.4.
 130
 131 Changes from 2.0.5 to 2.2.0
 132 ---------------------------
 133
 134 - users of the newhidups driver are advised that the driver name has changed
 135 to usbhid-ups.
 136 - users of the hidups driver must switch to usbhid-ups.
 137 - users of the following drivers (powermust, blazer, fentonups, mustek,
 138 esupssmart, ippon, sms) must switch to megatec, which replaces
 139 all these drivers.  Please refer to doc/megatec.txt for details.
 140 - users of the mge-shut driver are encouraged to test newmge-shut, which
 141 is an alternate driver scheduled to replace mge-shut,
 142 - users of the cpsups driver are encouraged to switch to powerpanel which
 143 is  scheduled to replace cpsups,
 144 - packagers will have to rework the whole nut packaging due to the
 145 major changes in the build system (completely modified, and now using
 146 automake). Refer to packaging/debian/ for an example of migration.
 147 - specifying '-a <id>' is now mandatory when starting a driver manually,
 148 ie not using upsdrvctl.
 149 - Developers of external client application using libupsclient are
 150 encouraged to rename the "UPSCONN" client structure to "UPSCONN_t"
 151 since the former will disapear by the release of NUT 2.4.
 152
 153 Changes from 2.0.4 to 2.0.5
 154 ---------------------------
 155
 156 - users of the newhidups driver: the driver is now more strict about
 157 refusing to connect to unknown devices. If your device was
 158 previously supported, but fails to be recognized now, add
 159 'productid=XXXX' to ups.conf. Please report the device to the NUT
 160 developer's mailing list.
 161
 162 Changes from 2.0.3 to 2.0.4
 163 ---------------------------
 164
 165 - nothing that affects upgraded systems.
 166 - users of the following drivers (powermust, blazer, fentonups, mustek,
 167 esupssmart, ippon, sms, masterguard) are encouraged to switch to megatec,
 168 which should replace all these drivers by nut 2.2. For more information,
 169 please refer to doc/megatec.txt
 170
 171 Changes from 2.0.2 to 2.0.3
 172 ---------------------------
 173
 174 - nothing that affects upgraded systems.
 175 - hidups users are encouraged to switch to newhidups, as hidups will be
 176 removed by nut 2.2.
 177
 178 Changes from 2.0.1 to 2.0.2
 179 ---------------------------
 180
 181 - The newhidups driver, which is the long run USB support approach,
 182 needs hotplug files installed to setup the right permissions on
 183 device file to operate. Check newhidups manual page for more information.
 184
 185 Changes from 2.0.0 to 2.0.1
 186 ---------------------------
 187
 188 - The cyberpower1100 driver is now called cpsups since it supports
 189 more than just one model.  If you use this driver, be sure to remove
 190 the old binary and update your ups.conf 'driver=' setting with the
 191 new name.
 192
 193 - The upsstats.html template page has been changed slightly to reflect
 194 better HTML compliance, so you may want to update your installed copy
 195 accordingly.  If you've customized your file, don't just copy the new
 196 one over it, or your changes will be lost!
 197
 198 Changes from 1.4.0 to 2.0.0
 199 ---------------------------
 200
 201 - The sample config files are no longer installed by default.  If you
 202 want to install them, use 'make install-conf' for the main programs,
 203 and 'make install-cgi-conf' for the CGI programs.
 204
 205 - ACCESS is no longer supported in upsd.conf.  Use ACCEPT and REJECT.
 206 Old way:
 207
 208         ACCESS grant all adminbox
 209         ACCESS grant all webserver
 210         ACCESS deny all all
 211
 212 New way:
 213
 214         ACCEPT adminbox
 215         ACCEPT webserver
 216         REJECT all
 217
 218 Note that ACCEPT and REJECT can take multiple arguments, so this
 219 will also work:
 220
 221         ACCEPT adminbox webserver
 222         REJECT all
 223
 224 - The drivers no longer support sddelay in ups.conf or -d on the
 225 command line.  If you need a delay after calling 'upsdrvctl
 226 shutdown', add a call to sleep in your shutdown script.
 227
 228 - The templates used by upsstats have changed considerably to reflect
 229 the new variable names.  If you use upsstats, you will need to
 230 install new copies or edit your existing files to use the new names.
 231
 232 - Nobody needed UDP mode, so it has been removed.  The only users
 233 seemed to be a few people like me with ancient asapm-ups binaries.
 234 If you really want to run asapm-ups again, bug me for the new patch
 235 which makes it work with upsclient.
 236
 237 - 'make install-misc' is now 'make install-lib'.  The misc directory
 238 has been gone for a long time, and the target was ambiguous.
 239
 240 - The newapc driver has been renamed to apcsmart.  If you previously
 241 used newapc, make sure you delete the old binary and fix your
 242 ups.conf.  Otherwise, you may run the old driver from 1.4.
 243
 244
 245 *** File trimmed here on changes from 1.2.2 to 1.4.0 ***
 246
 247 For information before this point, start with version 2.4.1 and work back.