-%%
-%%
-
\chapter{Console Configuration}
\label{ConsoleConfChapter}
\index[general]{Configuration!Console}
The Console configuration file is the simplest of all the configuration files,
and in general, you should not need to change it except for the password. It
simply contains the information necessary to contact the Director or
-Directors.
+Directors.
For a general discussion of the syntax of configuration files and their
resources including the data types recognized by {\bf Bacula}, please see
the \ilink{Configuration}{ConfigureChapter} chapter of this manual.
-The following Console Resource definition must be defined:
+The following Console Resource definition must be defined:
\section{The Director Resource}
\label{DirectorResource3}
The Director resource defines the attributes of the Director running on the
network. You may have multiple Director resource specifications in a single
Console configuration file. If you have more than one, you will be prompted to
-choose one when you start the {\bf Console} program.
+choose one when you start the {\bf Console} program.
\begin{description}
\item [Director]
\item [Name = \lt{}name\gt{}]
\index[console]{Name}
The director name used to select among different Directors, otherwise, this
- name is not used.
+ name is not used.
\item [DIRPort = \lt{}port-number\gt{}]
\index[dir]{DIRPort}
Specify the port to use to connect to the Director. This value will most
likely already be set to the value you specified on the {\bf
- \verb:--:with-base-port} option of the {\bf ./configure} command. This port must be
+ \lstinline:--:with-baseport} option of the {\bf ./configure} command. This port must be
identical to the {\bf DIRport} specified in the {\bf Director} resource of
the \ilink{Director's configuration}{DirectorChapter} file. The
- default is 9101 so this directive is not normally specified.
+ default is 9101 so this directive is not normally specified.
\item [Address = \lt{}address\gt{}]
\index[dir]{Address}
Where the address is a host name, a fully qualified domain name, or a network
- address used to connect to the Director.
+ address used to connect to the Director.
\item [Password = \lt{}password\gt{}]
\index[dir]{Password}
Where the password is the password needed for the Director to accept the
Console connection. This password must be identical to the {\bf Password}
- specified in the {\bf Director} resource of the
- \ilink{Director's configuration}{DirectorChapter} file. This
- directive is required.
+ specified in the {\bf Director} resource of the
+ \ilink{Director's configuration}{DirectorChapter} file. This
+ directive is required.
\end{description}
-An actual example might be:
+An actual example might be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = HeadMan
address = rufus.cats.com
password = xyz1erploit
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{The ConsoleFont Resource}
The ConsoleFont resource is available only in the GNOME version of the
console. It permits you to define the font that you want used to display in
-the main listing window.
+the main listing window.
\begin{description}
\item [ConsoleFont]
\index[console]{ConsoleFont}
- Start of the ConsoleFont directives.
+ Start of the ConsoleFont directives.
\item [Name = \lt{}name\gt{}]
\index[console]{Name}
- The name of the font.
+ The name of the font.
\item [Font = \lt{}Pango Font Name\gt{}]
\index[console]{Font}
The string value given here defines the desired font. It is specified in the
- Pango format. For example, the default specification is:
+ Pango format. For example, the default specification is:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Font = "LucidaTypewriter 9"
-\end{verbatim}
+\end{lstlisting}
\normalsize
\end{description}
-Thanks to Phil Stracchino for providing the code for this feature.
+Thanks to Phil Stracchino for providing the code for this feature.
-An different example might be:
+An different example might be:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
ConsoleFont {
Name = Default
Font = "Monospace 10"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\section{The Console Resource}
\index[general]{Console Resource}
\index[general]{Resource!Console}
-As of Bacula version 1.33 and higher, there are three different kinds of
-consoles, which the administrator or user can use to interact with the
-Director. These three kinds of consoles comprise three different security
-levels.
+There are three different kinds of consoles, which the administrator or
+user can use to interact with the Director. These three kinds of consoles
+comprise three different security levels.
-\begin{itemize}
-\item The first console type is an {\bf anonymous} or {\bf default} console,
- which has full privileges. There is no console resource necessary for this
- type since the password is specified in the Director resource. This is the
- kind of console that was initially implemented in versions prior to 1.33 and
- remains valid. Typically you would use it only for administrators.
+\begin{bsysitemize}
+\item The first console type is an {\bf anonymous} or {\bf default}
+ console, which has full privileges. There is no console resource
+ necessary for this type since the password is specified in the Director
+ resource. Typically you would use this {\bf anonymous} console
+ only for administrators.
-\item The second type of console, and new to version 1.33 and higher is a
+\item The second type of console is a
"named" or "restricted" console defined within a Console resource in
both the Director's configuration file and in the Console's
configuration file. Both the names and the passwords in these two
This second type of console begins with absolutely no privileges except
those explicitly specified in the Director's Console resource. Note,
- the definition of what these restricted consoles can do is determined
+ the definition of what these restricted consoles can do is determined
by the Director's conf file.
Thus you may define within the Director's conf file multiple Consoles
DHCP (non-fixed IP addresses) to "notify" the Director of their current
IP address.
-\end{itemize}
+\end{bsysitemize}
The Console resource is optional and need not be specified. However, if it is
specified, you can use ACLs (Access Control Lists) in the Director's
configuration file to restrict the particular console (or user) to see only
-information pertaining to his jobs or client machine.
+information pertaining to his jobs or client machine.
You may specify as many Console resources in the console's conf file. If
you do so, generally the first Console resource will be used. However, if
The following configuration files were supplied by Phil Stracchino. For
example, if we define the following in the user's bconsole.conf file (or
-perhaps the bwx-console.conf file):
+perhaps the bwx-console.conf file):
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = MyDirector
DIRport = 9101
Password = "XXXXXXXXXXX" # no, really. this is not obfuscation.
}
-
+
Console {
Name = restricted-user
Password = "UntrustedUser"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
Where the Password in the Director section is deliberately incorrect, and the
Console resource is given a name, in this case {\bf restricted-user}. Then
in the Director's bacula-dir.conf file (not directly accessible by the user),
-we define:
+we define:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Console {
Name = restricted-user
Password = "UntrustedUser"
CatalogACL = DefaultCatalog
CommandACL = run
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
the user logging into the Director from his Console will get logged in as {\bf
a FileSet named {\bf Restricted Client's FileSet}, a Catalog named {\bf
DefaultCatalog}, and the only command he can use in the Console is the {\bf
run} command. In other words, this user is rather limited in what he can see
-and do with Bacula.
+and do with Bacula.
The following is an example of a bconsole conf file that can access
several Directors and has different Consoles depending on the director:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Director {
Name = MyDirector
DIRport = 9101
Password = "A different UntrustedUser"
Director = SecondDirector
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
The second Director referenced at "secondserver" might look
like the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
Console {
Name = restricted-user
Password = "A different UntrustedUser"
CommandACL = run, restore
WhereACL = "/"
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
\index[general]{Console Commands}
\index[general]{Commands!Console}
-For more details on running the console and its commands, please see the
-\ilink{Bacula Console}{_ConsoleChapter} chapter of this manual.
+For more details on running the console and its commands, please see the
+\bsysxrlink{Bacula Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}.
\section{Sample Console Configuration File}
\label{SampleConfiguration2}
\index[general]{File!Sample Console Configuration}
\index[general]{Sample Console Configuration File}
-An example Console configuration file might be the following:
+An example Console configuration file might be the following:
\footnotesize
-\begin{verbatim}
+\begin{lstlisting}
#
# Bacula Console Configuration File
#
address = "my_machine.my_domain.com"
Password = Console_password
}
-\end{verbatim}
+\end{lstlisting}
\normalsize
projects / bacula / docs / blobdiff