git.sur5r.net Git - bacula/docs/blob - docs/manual/consoleconf.tex

   1 %%
   2 %%
   3
   4 \section*{Console Configuration}
   5 \label{_ChapterStart36}
   6 \index[general]{Configuration!Console }
   7 \index[general]{Console Configuration }
   8 \addcontentsline{toc}{section}{Console Configuration}
   9
  10 \subsection*{General}
  11 \index[general]{General }
  12 \addcontentsline{toc}{subsection}{General}
  13
  14 The Console configuration file is the simplest of all the configuration files,
  15 and in general, you should not need to change it except for the password. It
  16 simply contains the information necessary to contact the Director or
  17 Directors.
  18
  19 For a general discussion of configuration file and resources including the
  20 data types recognized by {\bf Bacula}, please see the
  21 \ilink{Configuration}{_ChapterStart16} chapter of this manual.
  22
  23 The following Console Resource definition must be defined:
  24
  25 \begin{itemize}
  26 \item
  27    \ilink{Director}{DirectorResource3} -- to  define the
  28    Director's name and his access password. Note,  you may define more than one
  29 Director resource in the  Console configuration file. If you do so, the
  30 Console program  will ask you which one you want to use.
  31 \end{itemize}
  32
  33 \subsection*{The Director Resource}
  34 \label{DirectorResource3}
  35 \index[general]{Director Resource }
  36 \index[general]{Resource!Director }
  37 \addcontentsline{toc}{subsection}{Director Resource}
  38
  39 The Director resource defines the attributes of the Director running on the
  40 network. You may have multiple Director resource specifications in a single
  41 Console configuration file. If you have more than one, you will be prompted to
  42 choose one when you start the {\bf Console} program.
  43
  44 \begin{description}
  45
  46 \item [Director]
  47    \index[console]{Director }
  48    Start of the Director records.
  49
  50 \item [Name = \lt{}name\gt{}]
  51    \index[console]{Name  }
  52    The director name used to select  among different Directors, otherwise, this
  53 name is not used.
  54
  55 \item [DIRPort = \lt{}port-number\gt{}]
  56    \index[dir]{DIRPort  }
  57    Specify the port to use to connect  to the Director. This value will most
  58 likely already be set to the value  you specified on the {\bf
  59 \verb:--:with-base-port} option of the  {\bf ./configure} command. This port must be
  60 identical to the  {\bf DIRport} specified in the {\bf Director} resource of
  61 the
  62 \ilink{Director's configuration}{_ChapterStart40} file.  The
  63 default is 9101 so this record is not normally specified.
  64
  65 \item [Address = \lt{}address\gt{}]
  66    \index[dir]{Address  }
  67    Where the address is a host name,  a fully qualified domain name, or a network
  68 address used to connect  to the Director.
  69
  70 \item [Password = \lt{}password\gt{}]
  71    \index[dir]{Password  }
  72    Where the password is the  password needed for the Director to accept the
  73 Console connection.  This password must be identical to the {\bf Password}
  74 specified in  the {\bf Director} resource of the
  75 \ilink{Director's configuration}{_ChapterStart40} file. This
  76 record is required.
  77 \end{description}
  78
  79 An actual example might be:
  80
  81 \footnotesize
  82 \begin{verbatim}
  83 Director {
  84   Name = HeadMan
  85   address = rufus.cats.com
  86   password = xyz1erploit
  87 }
  88 \end{verbatim}
  89 \normalsize
  90
  91 \subsection*{The ConsoleFont Resource}
  92 \index[general]{Resource!ConsoleFont }
  93 \index[general]{ConsoleFont Resource }
  94 \addcontentsline{toc}{subsection}{ConsoleFont Resource}
  95
  96 The ConsoleFont resource is available only in the GNOME version of the
  97 console. It permits you to define the font that you want used to display in
  98 the main listing window.
  99
 100 \begin{description}
 101
 102 \item [ConsoleFont]
 103    \index[console]{ConsoleFont }
 104    Start of the ConsoleFont records.
 105
 106 \item [Name = \lt{}name\gt{}]
 107    \index[console]{Name  }
 108    The name of the font.
 109
 110 \item [Font = \lt{}X-Window Font Specification\gt{}]
 111    \index[console]{Font  }
 112    The string value given here defines the desired font. It  is specified in the
 113 standard cryptic X Window format. For  example, the default specification is:
 114
 115 \footnotesize
 116 \begin{verbatim}
 117 Font = "-misc-fixed-medium-r-normal-*-*-130-*-*-c-*-iso8859-1"
 118 \end{verbatim}
 119 \normalsize
 120
 121 \end{description}
 122
 123 Thanks to Phil Stracchino for providing the code for this feature.
 124
 125 An actual example might be:
 126
 127 \footnotesize
 128 \begin{verbatim}
 129 ConsoleFont {
 130   Name = Default
 131 Font = "-misc-fixed-medium-r-normal-*-*-130-*-*-c-*-iso8859-1"
 132 }
 133 \end{verbatim}
 134 \normalsize
 135
 136 \subsection*{The Console Resource}
 137 \label{ConsoleResource}
 138 \index[general]{Console Resource }
 139 \index[general]{Resource!Console }
 140 \addcontentsline{toc}{subsection}{Console Resource}
 141
 142 As of Bacula version 1.33 and higher, there are three different kinds of
 143 consoles, which the administrator or user can use to interact with the
 144 Director. These three kinds of consoles comprise three different security
 145 levels.
 146
 147 \begin{itemize}
 148 \item The first console type is an {\bf anonymous} or {\bf default}  console,
 149    which has full privileges. There is no console  resource necessary for this
 150    type since the password is  specified in the Director resource. This is the
 151 kind of  console that was initially implemented in versions prior to  1.33 and
 152 remains valid. Typically you would use it only  for administrators.
 153 \item The second type of console, and new to version 1.33 and  higher is a
 154    ``named'' console defined within a  Console resource in both the Director's
 155    configuration file  and in the Console's configuration file. Both the names
 156 and the passwords in these two entries must match much as  is the case for
 157 Client programs.
 158
 159 This second type of  console begins with absolutely no privileges except those
 160 explicitly specified in the Director's Console resource.  Thus you can have
 161 multiple Consoles with different names  and passwords, sort of like multiple
 162 users, each with  different privileges. As a default, these consoles can do
 163 absolutely nothing -- no commands what so ever. You give  them privileges or
 164 rather access to commands and resources  by specifying access control lists in
 165 the Director's  Console resource. Note, if you are specifying such a  console,
 166 you will want to put a null password in the  Director resource.
 167 \item The third type of console is similar to the above mentioned  one in that
 168    it requires a Console resource definition in  both the Director and the
 169    Console. In addition, if the  console name, provided on the {\bf Name =}
 170 directive, is  the same as a Client name, the user of that console is
 171 permitted to use the {\bf SetIP} command to change the  Address directive in
 172 the Director's client resource to the  IP address of the Console. This permits
 173 portables or other  machines using DHCP (non-fixed IP addresses) to
 174 ``notify'' the Director of their current IP  address.
 175 \end{itemize}
 176
 177 The Console resource is optional and need not be specified. However, if it is
 178 specified, you can use ACLs (Access Control Lists) in the Director's
 179 configuration file to restrict the particular console (or user) to see only
 180 information pertaining to his jobs or client machine.
 181
 182 The following configuration files were supplied by Phil Stracchino. For
 183 example, if we define the following in the user's bconsole.conf file (or
 184 perhaps the wx-console.conf file):
 185
 186 \footnotesize
 187 \begin{verbatim}
 188  Director {
 189    Name = MyDirector
 190    DIRport = 9101
 191    Address = myserver
 192    Password = "XXXXXXXXXXX"    # no, really.  this is not obfuscation.
 193  }
 194
 195  Console {
 196    Name = restricted-user
 197    Password = "UntrustedUser"
 198  }
 199 \end{verbatim}
 200 \normalsize
 201
 202 Where the Password in the Director section is deliberately incorrect, and the
 203 Console resource is given a name, in this case {\bf restricted-client}. Then
 204 in the Director's bacula-dir.conf file (not directly accessible by the user),
 205 we define:
 206
 207 \footnotesize
 208 \begin{verbatim}
 209 Console {
 210   Name = restricted-user
 211   Password = "UntrustedUser"
 212   JobACL = "Restricted Client Save"
 213   ClientACL = restricted-client
 214   StorageACL = main-storage
 215   ScheduleACL = *all*
 216   PoolACL = *all*
 217   FileSetACL = "Restricted Client's FileSet"
 218   CatalogACL = DefaultCatalog
 219   CommandACL = run
 220 }
 221 \end{verbatim}
 222 \normalsize
 223
 224 the user logging into the Director from his Console will get logged in as {\bf
 225 restricted-client}, and he will only be able to see or access a Job with the
 226 name {\bf Restricted Client Save} a Client with the name {\bf
 227 restricted-client}, a Storage device {\bf main-storage}, any Schedule or Pool,
 228 a FileSet named {\bf Restricted Client's File}, a Catalog named {\bf
 229 DefaultCatalog}, and the only command he can use in the Console is the {\bf
 230 run} command. In other words, this user is rather limited in what he can see
 231 and do with Bacula.
 232
 233 \subsection*{Console Commands}
 234 \index[general]{Console Commands }
 235 \index[general]{Commands!Console }
 236 \addcontentsline{toc}{subsection}{Console Commands}
 237
 238 For more details on running the console and its commands, please see the
 239 \ilink{Bacula Console}{_ConsoleChapter} chapter of this manual.
 240
 241 \subsection*{Sample Console Configuration File}
 242 \label{SampleConfiguration2}
 243 \index[general]{File!Sample Console Configuration }
 244 \index[general]{Sample Console Configuration File }
 245 \addcontentsline{toc}{subsection}{Sample Console Configuration File}
 246
 247 An example Console configuration file might be the following:
 248
 249 \footnotesize
 250 \begin{verbatim}
 251 #
 252 # Bacula Console Configuration File
 253 #
 254 Director {
 255   Name = HeadMan
 256   address = "my_machine.my_domain.com"
 257   Password = Console_password
 258 }
 259 \end{verbatim}
 260 \normalsize