4 \section*{The Windows Version of Bacula}
6 \index[general]{Windows Version of Bacula }
7 \addcontentsline{toc}{section}{Windows Version of Bacula}
10 \index[general]{General }
11 \addcontentsline{toc}{subsection}{General}
13 At the current time only the File daemon or Client program has been tested on
14 Windows. As a consequence, when we speak of the Windows version of Bacula
15 below, we are referring to the File daemon only.
17 The Windows version of the Bacula File daemon has been tested on Win98, WinMe,
18 WinNT, and Win2000 systems. We have coded to support Win95, but no longer have
19 a system for testing. The Windows version of Bacula is a native Win32 port,
20 but there are very few source code changes, which means that the Windows
21 version is for the most part running code that has long proved stable on Unix
22 systems. When running, it is perfectly integrated with Windows and displays
23 its icon in the system icon tray, and provides a system tray menu to obtain
24 additional information on how Bacula is running (status and events dialog
25 boxes). If so desired, it can also be stopped by using the system tray menu,
26 though this should normally never be necessary.
28 Once installed Bacula normally runs as a system service. This means that it is
29 immediately started by the operating system when the system is booted, and
30 runs in the background even if there is no user logged into the system.
32 \subsubsection*{Win32 Installation}
34 \index[general]{Installation }
35 \index[general]{Win32!Installation }
36 \addcontentsline{toc}{subsubsection}{Win32 Installation}
38 Normally, you will install the Windows version of Bacula from the binaries.
39 This install is standard Windows .exe that runs an install wizard using the
40 NSIS Free Software installer, so if you have already installed Windows
41 software, it should be very familiar to you.
43 If you have a previous version Cygwin of Bacula (1.32 or lower) installed, you
44 should stop the service, uninstall it, and remove the directory possibly
45 saving your bacula-fd.conf file for use with the new version you will install.
46 The new native version of Bacula has far fewer files than the old Cygwin
49 Finally, proceed with the installation.
52 \item Simply double click on the {\bf winbacula-1.xx.0.exe} NSIS install
53 icon. The actual name of the icon will vary from one release version to
56 \includegraphics{./win32-nsis.eps} winbacula-1.xx.0.exe
58 \item Once launched, the installer wizard will ask you if you want to install
61 \addcontentsline{lof}{figure}{Win32 Client Setup Wizard}
62 \includegraphics{./win32-welcome.eps}
64 \item If you proceed, you will be asked to select the components to be
65 installed. You may install the Bacula program (Bacula File Service) and or
66 the documentation. Both will be installed in sub-directories of the install
67 location that you choose later. The components dialog looks like the
70 \addcontentsline{lof}{figure}{Win32 Component Selection Dialog}
71 \includegraphics{./win32-pkg.eps}
73 \item Next you will be asked to select an installation directory.
75 \addcontentsline{lof}{figure}{Win32 Directory Selection Dialog}
76 \includegraphics{./win32-location.eps}
78 \item If you are installing for the first time, you will be asked if you want
79 to edit the bacula-fd.conf file, and if you respond with yes, it will be
82 \item Then the installer will ask if you wish to install Bacula as a service. You
83 should always choose to do so:
85 \addcontentsline{lof}{figure}{Win32 Client Service Selection}
86 \includegraphics{./win32-service.eps}
89 \item If everything goes well, you will receive the following confirmation:
91 \addcontentsline{lof}{figure}{Win32 Client Service Confirmation}
92 \includegraphics{./win32-service-ok.eps}
95 \item Then you will be asked if you wish to start the service. If you respond
96 with yes, any running Bacula will be shutdown and the new one started. You
97 may see a DOS box momentarily appear on the screen as the service is started.
98 It should disappear in a second or two:
100 \addcontentsline{lof}{figure}{Win32 Client Start}
101 \includegraphics{./win32-start.eps}
104 \item Finally, the finish dialog will appear:
106 \addcontentsline{lof}{figure}{Win32 Client Setup Completed}
107 \includegraphics{./win32-finish.eps}
112 That should complete the installation process. When the Bacula File Server is
113 ready to serve files, an icon \includegraphics{./idle.eps} representing a
114 cassette (or tape) will appear in the system tray
115 \includegraphics{./tray-icon.eps}; right click on it and a menu will appear.
117 \ \ \ \ \includegraphics{./menu.eps}
118 The {\bf Events} item is currently unimplemented, by selecting the {\bf
119 Status} item, you can verify whether any jobs are running or not.
121 When the Bacula File Server begins saving files, the color of the holes in the
122 cassette icon will change from white to green \includegraphics{./running.eps},
123 and if there is an error, the holes in the cassette icon will change to red
124 \includegraphics{./error.eps}.
126 If you are using remote desktop connections between your windows boxes, be
127 warned that that tray icon does not always appear. It will always be visible
128 when you log into the console, but the remote desktop may not display it.
130 \subsubsection*{Post Win32 Installation}
131 \index[general]{Post Win32 Installation }
132 \index[general]{Win32!Post Installation }
133 \addcontentsline{toc}{subsubsection}{Post Win32 Installation}
135 After installing Bacula and before running it, you should check the contents
137 c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}bacula-fd.conf} to
138 ensure that it corresponds to your configuration.
140 \subsubsection*{Uninstalling Bacula on Win32}
141 \index[general]{Win32!Uninstalling Bacula }
142 \index[general]{Uninstalling Bacula on Win32 }
143 \addcontentsline{toc}{subsubsection}{Uninstalling Bacula on Win32}
145 Once Bacula has been installed, it can be uninstalled using the standard
146 Windows Add/Remove Programs dialog found on the Control panel.
148 \subsubsection*{Dealing with Win32 Problems}
150 \index[general]{Win32!Dealing with Problems }
151 \index[general]{Dealing with Win32 Problems }
152 \addcontentsline{toc}{subsubsection}{Dealing with Win32 Problems}
154 The most likely source of problems is authentication when the Director
155 attempts to connect to the File daemon that you installed. This can occur if
156 the names and the passwords defined in the File daemon's configuration file
158 c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}bacula-fd.conf} on
159 the Windows machine do not match with the names and the passwords in the
160 Director's configuration file {\bf bacula-dir.conf} located on your Unix/Linux
163 More specifically, the password found in the {\bf Client} resource in the
164 Director's configuration file must be the same as the password in the {\bf
165 Director} resource of the File daemon's configuration file. In addition, the
166 name of the {\bf Director} resource in the File daemon's configuration file
167 must be the same as the name in the {\bf Director} resource of the Director's
170 It is a bit hard to explain in words, but if you understand that a Director
171 normally has multiple Clients and a Client (or File daemon) may permit access
172 by multiple Directors, you can see that the names and the passwords on both
173 sides must match for proper authentication.
175 One user had serious problems with the configuration file until he realized
176 that the Unix end of line conventions were used and Bacula wanted them in
177 Windows format. This has not been confirmed though.
179 Running Unix like programs on Windows machines is a bit frustrating because
180 the Windows command line shell (DOS Window) is rather primitive. As a
181 consequence, it is not generally possible to see the debug information and
182 certain error messages that Bacula prints. With a bit of work, however, it is
183 possible. When everything else fails and you want to {\bf see} what is going
184 on, try the following:
188 Start a DOS shell Window.
195 The {\bf -t} option will cause Bacula to read the configuration file, print
196 any error messages and then exit. the {\bf \gt{}} redirects the output to the
197 file named {\bf out}, which you can list with the {\bf type} command.
199 If something is going wrong later, or you want to run {\bf Bacula} with a
200 debug option, you might try starting it as:
204 bacula-fd -d 100 >out
208 In this case, Bacula will run until you explicitly stop it, which will give
209 you a chance to connect to it from your Unix/Linux server. In later versions
210 of Bacula (1.34 on, I think), when you start the File daemon in debug mode it
211 can write the output to a trace file {\bf bacula.trace} in the current
212 directory. To enable this, before running a job, use the console, and enter:
220 then run the job, and once you have terminated the File daemon, you will find
221 the debug output in the {\bf bacula.trace} file.
223 In addition, you should look in the System Applications log on the Control
224 Panel to find any Windows errors that Bacula got during the startup process.
226 Finally, due to the above problems, when you turn on debugging, and specify
227 trace=1 on a setdebug command in the Console, Bacula will write the debug
228 information to the file {\bf bacula.trace} in the directory from which Bacula
231 \label{Compatibility}
233 \subsubsection*{Windows Compatibility Considerations}
234 \index[general]{Windows Compatibility Considerations }
235 \index[general]{Considerations!Windows Compatibility }
236 \addcontentsline{toc}{subsubsection}{Windows Compatibility Considerations}
238 If any applications are running during the backup and they have files
239 opened exclusively, Bacula will not be able to backup those files, so be
240 sure you close your applications (or tell your users to close their
241 applications) before the backup. Most Microsoft applications do not open
242 files exclusively so that they can be backed up. However, you will need to
243 experiment. In any case, if Bacula cannot open the file, it will print an
244 error message, so you will always know which files were not backed up.
246 During backup, Bacula doesn't know about the system registry, so you will
247 either need to write it out to an ASCII file using {\bf regedit~~/e} or use a
248 program specifically designed to make a copy or backup the registry.
250 In Bacula version 1.31 and later, we use Windows backup API calls by
251 default. Typical of Windows, programming these special BackupRead and
252 BackupWrite calls is a real nightmare of complications. The end result
253 gives some distinct advantages and some disadvantages.
255 First, the advantages are that on WinNT/2K/XP systems, the security and
256 ownership information is now backed up. In addition, with the exception of
257 files in exclusive use by another program (a major disaster for backup
258 programs on Windows), Bacula can now access all system files. This means
259 that when you restore files, the security and ownership information will be
260 restored on WinNT/2K/XP along with the data.
262 The disadvantage of the Windows backup API calls is that it produces
263 non-portable backups. That is files and their data that are backed up on
264 WinNT using the native API calls (BackupRead/BackupWrite) cannot be
265 restored on Win95/98/Me or Unix systems. In principle, a file backed up on
266 WinNT can be restored on WinXP, but this remains to be seen in practice
267 (not yet tested). In addition, the stand-alone tools such as {\bf bls} and
268 {\bf bextract} cannot be used to retrieve the data for those files because
269 those tools are not available on Windows. All restores must use the Bacula
270 {\bf restore} command. This restriction is mentioned for completeness, but
271 in practice should not create any problems.
273 As a default, Bacula backs up Windows systems using the Windows API calls.
274 If you want to backup data on a WinNT/2K/XP system and restore it on a
275 Unix/Win95/98/Me system, we have provided a special {\bf portable} option
276 that backs up the data in a portable fashion by using portable API calls.
277 See the \ilink{portable option}{portable} on the Include statement in a
278 FileSet resource in the Director's configuration chapter for the details on
279 setting this option. However, using the portable option means you may have
280 permissions problems accessing files, and none of the security and
281 ownership information will be backed up or restored. The file data can,
282 however, be restored on any system.
284 You should always be able to restore any file backed up on Unix or Win95/98/Me
285 to any other system. On some systems, such as WinNT/2K/XP, you may have to
286 reset the ownership of such restored files. Any file backed up on WinNT/2K/XP
287 should in principle be able to be restored to a similar system (i.e.
288 WinNT/2K/XP), however, I am unsure of the consequences if the owner
289 information and accounts are not identical on both systems. Bacula will not
290 let you restore files backed up on WinNT/2K/XP to any other system (i.e. Unix
291 Win95/98/Me) if you have used the defaults.
293 Finally, if you specify the {\bf portable=yes} option on the files you back
294 up. Bacula will be able to restore them on any other system. However, any
295 WinNT/2K/XP specific security and ownership information will be lost.
297 The following matrix will give you an idea of what you can expect. Thanks to
298 Marc Brueckner for doing the tests:
302 \addcontentsline{lot}{table}{WinNT/2K/XP Restore Portability Status}
303 \begin{longtable}{|l|l|p{2.8in}|}
305 \multicolumn{1}{|c| }{\bf Backup OS } & \multicolumn{1}{c| }{\bf Restore OS }
306 & \multicolumn{1}{c| }{\bf Results } \\
307 \hline {WinMe } & {WinMe } & {Works } \\
308 \hline {WinMe } & {WinNT } & {Works (SYSTEM permissions) } \\
309 \hline {WinMe } & {WinXP } & {Works (SYSTEM permissions) } \\
310 \hline {WinMe } & {Linux } & {Works (SYSTEM permissions) } \\
311 \hline {\ } & {\ } & {\ } \\
312 \hline {WinXP } & {WinXP } & {Works } \\
313 \hline {WinXP } & {WinNT } & {Works (all files OK, but got ``The data is invalid''
315 \hline {WinXP } & {WinMe } & {Error: Win32 data stream not supported. } \\
316 \hline {WinXP } & {WinMe } & {Works if {\bf Portable=yes} specified during backup.} \\
317 \hline {WinXP } & {Linux } & {Error: Win32 data stream not supported. } \\
318 \hline {WinXP } & {Linux } & {Works if {\bf Portable=yes} specified during backup.}\\
319 \hline {\ } & {\ } & {\ } \\
320 \hline {WinNT } & {WinNT } & {Works } \\
321 \hline {WinNT } & {WinXP } & {Works } \\
322 \hline {WinNT } & {WinMe } & {Error: Win32 data stream not supported. } \\
323 \hline {WinNT } & {WinMe } & {Works if {\bf Portable=yes} specified during backup.}\\
324 \hline {WinNT } & {Linux } & {Error: Win32 data stream not supported. } \\
325 \hline {WinNT } & {Linux } & {Works if {\bf Portable=yes} specified during backup. }\\
326 \hline {\ } & {\ } & {\ } \\
327 \hline {Linux } & {Linux } & {Works } \\
328 \hline {Linux } & {WinNT } & {Works (SYSTEM permissions) } \\
329 \hline {Linux } & {WinMe } & {Works } \\
330 \hline {Linux } & {WinXP } & {Works (SYSTEM permissions) }
335 \subsubsection*{Windows Firewalls}
336 \index[general]{Firewalls!Windows }
337 \index[general]{Windows Firewalls }
338 \addcontentsline{toc}{subsubsection}{Windows Firewalls}
340 If you turn on the firewalling feature on Windows (default in WinXP SP2), you
341 are likely to find that the Bacula ports are blocked and you cannot
342 communicate to the other daemons. This can be deactivated through the {\bf
343 Security Notification} dialog, which is apparently somewhere in the {\bf
344 Security Center}. I don't have this on my computer, so I cannot give the exact
351 netsh firewall set opmode disable
355 is purported to disable the firewall, but this command is not accepted on my
358 \subsubsection*{Windows Port Usage}
359 \index[general]{Windows Port Usage }
360 \index[general]{Usage!Windows Port }
361 \addcontentsline{toc}{subsubsection}{Windows Port Usage}
363 If you want to see if the File daemon has properly opened the port and is
364 listening, you can enter the following command in a shell window:
368 netstat -an | findstr 910[123]
372 \subsubsection*{Windows Disaster Recovery}
373 \index[general]{Recovery!Windows Disaster }
374 \index[general]{Windows Disaster Recovery }
375 \addcontentsline{toc}{subsubsection}{Windows Disaster Recovery}
377 We don't currently have a good solution for disaster recovery on Windows as we
378 do on Linux. The main piece lacking is a Windows boot floppy or a Windows boot
379 CD. Microsoft releases a Windows Pre-installation Environment ({\bf WinPE})
380 that could possibly work, but we have not investigated it. This means that
381 until someone figures out the correct procedure, you must restore the OS from
382 the installation disks, then you can load a Bacula client and restore files.
383 Please don't count on using {\bf bextract} to extract files from your backup
384 tapes during a disaster recovery unless you have backed up those files using
385 the {\bf portable} option. {\bf bextract} does not run on Windows, and the
386 normal way Bacula saves files using the Windows API prevents the files from
387 being restored on a Unix machine. Once you have an operational Windows OS
388 loaded, you can run the File daemon and restore your user files.
391 \ilink{ Disaster Recovery of Win32 Systems}{Win3233} for the latest
392 suggestion, which looks very promising.
394 It looks like Bart PE Builder, which creates a Windows PE (Pre-installation
395 Environment) Boot-CD, may be just what is needed to build a complete disaster
396 recovery system for Win32. This distribution can be found at
397 \elink{http://www.nu2.nu/pebuilder/ }{http://www.nu2.nu/pebuilder/}.
399 \subsubsection*{Windows Ownership and Permissions Problems}
400 \index[general]{Problems!Windows Ownership and Permissions }
401 \index[general]{Windows Ownership and Permissions Problems }
402 \addcontentsline{toc}{subsubsection}{Windows Ownership and Permissions
405 If you restore files backed up from WinNT/XP/2K to an alternate directory,
406 Bacula may need to create some higher level directories that were not saved
407 (or restored). In this case, the File daemon will create them under the SYSTEM
408 account because that is the account that Bacula runs under as a service. As of
409 version 1.32f-3, Bacula creates these files with full access permission.
410 However, there may be cases where you have problems accessing those files even
411 if you run as administrator. In principle, Microsoft supplies you with the way
412 to cease the ownership of those files and thus change the permissions.
413 However, a much better solution to working with and changing Win32 permissions
414 is the program {\bf SetACL}, which can be found at
415 \elink{http://setacl.sourceforge.net/ }{http://setacl.sourceforge.net/}.
417 \subsubsection*{Manually resetting the Permissions}
418 \index[general]{Manually resetting the Permissions }
419 \index[general]{Permissions!Manually resetting the }
420 \addcontentsline{toc}{subsubsection}{Manually resetting the Permissions}
422 The following solution was provided by Dan Langille \lt{}dan at langille in
423 the dot org domain\gt{}. The steps are performed using Windows 2000 Server but
424 they should apply to most Win32 platforms. The procedure outlines how to deal
425 with a problem which arises when a restore creates a top-level new directory.
426 In this example, ``top-level'' means something like {\bf
427 c:\textbackslash{}src}, not {\bf c:\textbackslash{}tmp\textbackslash{}src}
428 where {\bf c:\textbackslash{}tmp} already exists. If a restore job specifies /
429 as the {\bf Where:} value, this problem will arise.
431 The problem appears as a directory which cannot be browsed with Windows
432 Explorer. The symptoms include the following message when you try to click on
435 \includegraphics{./access-is-denied.eps}
437 If you encounter this message, the following steps will change the permissions
438 to allow full access.
441 \item right click on the top level directory (in this example, {\bf c:/src})
442 and select {\bf Properties}.
443 \item click on the Security tab.
444 \item If the following message appears, you can ignore it, and click on {\bf
447 \includegraphics{./view-only.eps}
449 You should see something like this:
451 \includegraphics{./properties-security.eps}
452 \item click on Advanced
453 \item click on the Owner tab
454 \item Change the owner to something other than the current owner (which is
455 {\bf SYSTEM} in this example as shown below).
457 \includegraphics{./properties-security-advanced-owner.eps}
458 \item ensure the ``Replace owner on subcontainers and objects'' box is
461 \item When the message ``You do not have permission to read the contents of
462 directory ''c:\textbackslash{}src\textbackslash{}basis. Do you wish to replace
463 the directory permissions with permissions granting you Full Control?``, click
466 \includegraphics{./confirm.eps}
467 \item Click on OK to close the Properties tab
470 With the above procedure, you should now have full control over your restored
473 \subsubsection*{Backing Up the WinNT/XP/2K System State}
474 \index[general]{State!Backing Up the WinNT/XP/2K System }
475 \index[general]{Backing Up the WinNT/XP/2K System State }
476 \addcontentsline{toc}{subsubsection}{Backing Up the WinNT/XP/2K System State}
478 A suggestion by Damian Coutts using Microsoft's NTBackup utility in
479 conjunction with Bacula should permit a full restore of any damaged system
480 files on Win2K/XP. His suggestion is to do an NTBackup of the critical system
481 state prior to running a Bacula backup with the following command:
485 ntbackup backup systemstate /F c:\systemstate.bkf
489 The {\bf backup} is the command, the {\bf systemstate} says to backup only the
490 system state and not all the user files, and the {\bf /F
491 c:\textbackslash{}systemstate.bkf} specifies where to write the state file.
492 this file must then be saved and restored by Bacula.
494 To restore the system state, you first reload a base operating system if the
495 OS is damaged, otherwise, this is not necessary, then you would use Bacula to
496 restore all the damaged or lost user's files and to recover the {\bf
497 c:\textbackslash{}systemstate.bkf} file. Finally if there are any damaged or
498 missing system files or registry problems, you run {\bf NTBackup} and {\bf
499 catalogue} the system statefile, and then select it for restore. The
500 documentation says you can't run a command line restore of the systemstate.
502 To the best of my knowledge, this has not yet been tested. If you test it,
503 please report your results to the Bacula email list.
505 \subsubsection*{Windows Considerations for Filename Specifications}
506 \index[general]{Specifications!Windows Considerations for Filename }
507 \index[general]{Windows Considerations for Filename Specifications }
508 \addcontentsline{toc}{subsubsection}{Windows Considerations for Filename
512 \ilink{Director's Configuration chapter}{win32} of this manual
513 for important considerations on how to specify Windows paths in Bacula FileSet
514 Include and Exclude directives.
516 \subsubsection*{Command Line Options Specific to the Bacula Windows File
518 \index[general]{Client!Command Line Options Specific to the Bacula Windows
520 \index[general]{Command Line Options Specific to the Bacula Windows File
522 \addcontentsline{toc}{subsubsection}{Command Line Options Specific to the
523 Bacula Windows File Daemon (Client)}
525 These options are not normally seen or used by the user, and are documented
526 here only for information purposes. At the current time, to change the default
527 options, you must either manually run {\bf Bacula} or you must manually edit
528 the system registry and modify the appropriate entries.
530 In order to avoid option clashes between the options necessary for {\bf
531 Bacula} to run on Windows and the standard Bacula options, all Windows
532 specific options are signaled with a forward slash character (/), while as
533 usual, the standard Bacula options are signaled with a minus (-), or a minus
534 minus (\verb{--{). All the standard Bacula options can be used on the Windows
535 version. In addition, the following Windows only options are implemented:
539 \item [/servicehelper ]
540 \index[fd]{/servicehelper }
541 Run the service helper application (don't use this it is deprecated.).
544 \index[fd]{/service }
545 Start Bacula as a service
549 Run the Bacula application
552 \index[fd]{/install }
553 Install Bacula as a service in the system registry
557 Uninstall Bacula from the system registry
561 Show the Bacula about dialogue box
565 Show the Bacula status dialogue box
569 Show the Bacula events dialogue box (not yet implemented)
573 Stop any running {\bf Bacula}
577 Show the Bacula help dialogue box
580 It is important to note that under normal circumstances the user should never
581 need to use these options as they are normally handled by the system
582 automatically once Bacula is installed. However, you may note these options in
583 some of the .bat files that have been created for your use.
585 \subsubsection*{Shutting down Windows Systems}
586 \index[general]{Shutting down Windows Systems }
587 \index[general]{Systems!Shutting down Windows }
588 \addcontentsline{toc}{subsubsection}{Shutting down Windows Systems}
590 Some users like to shutdown their windows machines after a backup using a
591 Client Run After Job directive. If you want to do something similar, you might
592 take the shutdown program from the
593 \elink{apcupsd project}{http://www.apcupsd.com} or one from the
595 project}{http://www.sysinternals.com/ntw2k/freeware/psshutdown.shtml}.