1Things to watch out for when upgrading.
2
32.5.0
4-----
5The Windows installer sets Administrator and SYSTEM full access permissions
6only on:
7C:/Program Files/Burp/bin/burp.conf
8C:/Program Files/Burp/bin/ssl_cert_ca.pem
9C:/Program Files/Burp/bin/ssl_cert-client.key
10C:/Program Files/Burp/bin/ssl_cert-client.pem
11That is, it runs:
12  icacls.exe "<path>" /inheritance:r /grant:r Administrators:F SYSTEM:F
13If you have these files on non-default locations, and you are concerned about
14restricting permissions, you may want to run the command by hand on them.
15The Windows client will automatically apply the same permissions to new ssl
16cert files on certificate exchange.
17
182.3.12
19------
20On Windows, the '-x' option has been split into two different options - '-x'
21and '-X'.
22'-x': Restore without using the Windows VSS api, and attempt to strip out any
23      VSS data. This now works the same as the non-Windows client, and is a new
24      option for Windows.
25'-X': Restore without using the Windows VSS api, and do not attempt to strip
26      out any VSS data. This option only exists on Windows, and was the
27      behaviour that you previously got with '-x'. Use this if your backup
28      contains no VSS data.
29
302.3.4
31-----
32Clients will now error out if using protocol 2 and 'encryption_password' is
33set, because that option is not supported in protocol 2.
34
352.3.2
36-----
37The 'restore_client' option now takes into consideration the 'client_can_X'
38settings of the original client before considering the 'client_can_X' settings
39of the restore client. To get the previous behaviour, where only the restore
40client's settings were considered, use the new 'super_client' option instead
41of 'restore_client'.
42
432.2.14
44------
45For security, the burp client will no longer let you restore over symlinks
46that point outside of your desired destination directory. Specifying a
47'-d <directory>' with your restore parameters is now mandatory. If you wish
48to restore everything back to the original locations, you can give '-d /',
49which will also work on Windows clients. If you wish server-initiated restores
50to restore to original locations, you should add '-d /' to the timed job
51in the client side.
52
532.2.12
54------
55The command line option to print the version number, is now '-V'.
56It has made way for the new '-v' option, which means 'log to stdout'.
57
582.2.10
59------
60The server side options 'address', 'port', 'status_address', and 'status_port'
61have been removed. They have been replaced with 'listen' and 'listen_status'.
62
632.0.42
64------
65A bug in generating protocol 2 rabin checksums was fixed. Any protocol 2
66backups made up to this point should be discarded.
67
682.0.32
69------
70'make install' will now install everything except configuration files.
71'make install-config' will install configuration files, and will overwrite
72without warning.
73'make install-all' will install everything.
74
752.0.30
76------
77The configure system has been rewritten and vastly improved. One difference
78to watch out for is that 'make install' will now overwrite any existing burp
79config files and scripts without any warning.
80
812.0.26
82------
83The dhfile generation command in burp_ca has changed from 'openssl dhparam -out
84"$dhfile" 1024' to 'openssl dhparam -dsaparam -out "$dhfile" 2048' in order
85to make ssl key exchange more secure.
86Your existing /etc/burp/dhfile.pem on your burp server will not be regenerated
87unless you delete /etc/burp/dhfile.pem by hand (rm -f /etc/burp/dhfile.pem)
88and restart the burp server.
89
902.0.22
91------
92The protocol2 manifest formats have changed. You should therefore not mix
93earlier 2.0.x servers and clients with this version, and protocol2 backups from
94earlier versions will no longer work.
95
962.0.20
97------
98The option 'working_dir_recovery_method = use' has been removed.
99
1002.0.12
101------
102Executable scripts that used to be in /etc/burp are now installed in
103/usr/share/burp/scripts: notify_script, ssl_extra_checks_script,
104summary_script, and timer_script.
105On upgrading, you should probably fix the paths to these scripts in
106/etc/burp/burp-server.conf.
107Package building files have not yet been updated to reflect this change.
108Patches gratefully accepted.
109
1102.0.10
111------
112The status monitor system and ncurses client are now working to some degree.
113You now need to use a burp client to connect to the status port via SSL.
114This also means that you may use the ncurses client on a machine that is not
115the burp server.
116You can use 'burp -a m' to get a raw connection (useful for debugging or to
117see the JSON), or 'burp -a s' to use the ncurses client.
118You will not be able to see details of any clients unless you are connecting
119from the client in question, or you are a restore_client (see the man page
120for this option).
121On upgrading from previous versions of burp, you will not have some of the
122necessary config values for connecting to the status port.
123Both server and client will need 'status_port = 4972'.
124The client will need 'server = <server address>'.
125The server address may need to be '::1' if you are connecting locally. You may
126use 'netstat -plant | grep burp' to determine the address that burp is
127listening on.
128There are still some pieces in the ncurses client that are not fully
129implemented.
130More details about all this will be in documentation to be written soon.
131
1322.0.9
133-----
134The configuration file parser now understands single quotes and double quotes
135properly. If you have single quotes or double quotes around your config value,
136the parser will now treat backslash as the escaping character. If you do not
137have quotes around your config value, the config value will be taken literally.
138
1392.0.7
140-----
141The bedup program is now contained within the burp binary. 'make install' will
142create a 'bedup' symlink to the burp binary. Executing 'bedup' will then work
143as before.
144
1452.0.6
146-----
147Warning about hardlinked_archive in protocol1 style backups:
148In this version, I have changed the way that hardlinked_archive works slightly,
149in order to fix https://github.com/grke/burp/issues/176 - unnecessary
150duplication and deletion.
151In the past, the previous current backup would have a file called 'hardlinked'
152created when the next backup was being finalised. So, the decision was being
153made during the next backup.
154Now, the decision is being made for each backup when it is being finalised
155itself (rather than waiting for the next one).
156This means that, when you upgrade, your most recent backup will look like a
157non-hardlinked_archive, and when you make you next protocol1 style backup with a
1582.0.x server, it will treat the previous backup as a non-hardlinked_archive.
159If you need it to be a hardlinked_archive, make sure that you anticipate this
160before the next backup happens, by creating a file called something like:
161/var/spool/burp/<client>/current/hardlinked
162
1632.0.4
164-----
165There has been a massive rewrite of most of burp.
166
167The intention is that burp1 clients will continue to work with burp2
168servers.
169Burp2 clients can also be configured to work in burp1 mode. See the 'protocol'
170option in the man page and example config files.
171Burp2 code is capable of doing variable length chunking for inline
172deduplication, with sparse indexing on the server side.
173
174Use this version with extreme caution.
175Burp2 is currently missing some features, such as acl/xattr, Windows EFS,
176encryption and compression support.
177The burp1 protocol should still work with these features, but be careful.
178The status monitor is also not working.
179Due to the extent of the rewrite, pretty much anything may not working
180correctly.
181Do not expect burp2, and the backups that it makes, to be compatible
182with future releases of burp2.
183
1841.3.24
185------
186If installing with 'make install' and you want to use the
187server_script_pre/post_notify feature, then you will probably need to overwrite
188/etc/burp/notify_script by hand. The arguments to it have not changed though,
189so if you do not want to use that feature, you do not need to do this.
190
1911.3.18
192------
193Special care is advised when testing this release, as some of the main
194structure of the program has been tweaked in order to support the stripping
195out of Windows VSS information.
196
1971.3.16
198------
199If you have any clients on 1.3.14, you should upgrade them to 1.3.14 due to
200a bug in the exclude_comp feature.
201
2021.3.14
203------
204If installing with 'make install', you will probably need to overwrite
205/etc/burp/notify_script by hand.
206The arguments to it have changed, so you will also need to update the
207configuration in /etc/burp/burp-server.conf to be in the new style. The example
208config in configs/server/burp.conf will help.
209
210The '-l <path>' and 'logfile = <path>' options have been removed because they
211didn't work properly, and there was no sensible way to make the work properly.
212There are now three settings in the conf files: stdout=[0|1], syslog=[0|1],
213and progress_counters=[0|1]. If you want to see output, you may need to set
214these options.
215
2161.3.3
217-----
218If installing with 'make install' and you want to use the 'initialise manual
219backup from server' feature, you will need to replace /etc/burp/timer_script
220with configs/server/timer_script from the source, because 'make install' will
221not overwrite the old version.
222
2231.3.2
224-----
225The process of generating SSL certificates has been automated, so the old
226default keys and certificates have been removed from new installs.
227See docs/burp_ca.txt for more information.
228
2291.3.1
230-----
231Due to Debian policy, burp and bedup will now be installed in /usr/sbin.
232Therefore, you may need to update any cron jobs that were previously using
233/sbin.
234
2351.2.4
236-----
237There was a critical bug in 1.2.4.
238Please upgrade clients and servers to 1.2.5 as soon as you can.
239
2401.1.x to 1.2.0
241---------------
242* Clients on 1.1.70 or older will not work with a 1.2.0 server. You will need
243to upgrade the clients at the same time. Your old backups will continue to
244work.
245* If you previously compiled with './configure --prefix=/usr', you will probably
246now want to compile with just './configure'. The binary will now go to
247/sbin/burp, with a symlink from /usr/sbin/burp.
248* If you are installing from source onto the server, you may want to
249'rm /etc/burp/notify_script' before 'make installation', otherwise you won't
250get the updated version.
251