diff options
| -rw-r--r-- | manuals/en/developers/regression.md | 15 | ||||
| -rw-r--r-- | manuals/en/developers/tls-techdoc.md | 90 | ||||
| -rw-r--r-- | manuals/en/main/bareos.sty | 20 | ||||
| -rw-r--r-- | manuals/en/main/bconsole.tex | 46 | ||||
| -rw-r--r-- | manuals/en/main/catmaintenance.tex | 180 | ||||
| -rw-r--r-- | manuals/en/main/dirdconf-fileset.tex | 2 | ||||
| -rw-r--r-- | manuals/en/main/director-resource-director-definitions.tex | 16 | ||||
| -rw-r--r-- | manuals/en/main/programs.tex | 158 | ||||
| -rw-r--r-- | manuals/en/main/releasenotes.tex | 39 | ||||
| -rw-r--r-- | manuals/en/main/tls.tex | 2 |
10 files changed, 311 insertions, 257 deletions
diff --git a/manuals/en/developers/regression.md b/manuals/en/developers/regression.md index 6804ff4..d7d3c23 100644 --- a/manuals/en/developers/regression.md +++ b/manuals/en/developers/regression.md @@ -378,8 +378,8 @@ backend as your installed binaries. Then define the variables `bin` and Example: - bin=/opt/bareos/bin - scripts=/opt/bareos/scripts + bin=/usr/sbin/ + scripts=/usr/lib/bareos/scripts/ The `./scripts/prepare-other-loc` will tweak the regress scripts to use your binary location. You will need to run it manually once before you @@ -392,14 +392,16 @@ run any regression tests. All regression scripts must be run by hand or by calling the test scripts. These are principally scripts that begin with <span>**all\_...**</span> such as <span>**all\_disk\_tests**</span>, -<span>**./all\_test**</span> ... None of the +<span>**./all\_test**</span> ... + +None of the <span>**./do\_disk**</span>, <span>**./do\_all**</span>, <span>**./nightly...**</span> scripts will work. If you want to switch back to running the regression scripts from source, first remove the <span>**bin**</span> and <span>**scripts**</span> variables from your <span>**config**</span> -file and rerun the <span>**make setup**</span> step. +file and rerun the `make setup` step. Running a Single Test --------------------- @@ -438,8 +440,9 @@ You can run any individual test by hand by cd’ing to the The directory structure of the regression tests is: regress - Makefile, scripts to start tests - |------ scripts - Scripts and conf files - |-------tests - All test scripts are here + |------ scripts - Scripts (and old configuration files) + |------ tests - All test scripts are here + |------ configs - configuration files (for newer tests) | |------------------ -- All directories below this point are used | for testing, but are created from the diff --git a/manuals/en/developers/tls-techdoc.md b/manuals/en/developers/tls-techdoc.md index e34b0bb..f6150af 100644 --- a/manuals/en/developers/tls-techdoc.md +++ b/manuals/en/developers/tls-techdoc.md @@ -27,79 +27,29 @@ explicit trust upon the two-way Cram-MD5 implementation. Cram-MD5 is subject to known plaintext attacks, and is should be considered considerably less secure than PKI certificate-based authentication. -Appropriate autoconf macros have been added to detect and use OpenSSL. -Two additional preprocessor defines have been added: *HAVE\_TLS* and -*HAVE\_OPENSSL*. All changes not specific to OpenSSL rely on -*HAVE\_TLS*. OpenSSL-specific code is constrained to *src/lib/tls.c* to -facilitate the support of alternative TLS implementations. - -New Configuration Directives ----------------------------- - -Additional configuration directives have been added to both the Console -and Director resources. These new directives are defined as follows: - -- *(yes/no)* Enable TLS support. - -- *(yes/no)* Require TLS connections. - -- *(path)* Path to PEM encoded TLS certificate. Used as either a - client or server certificate. - -- *(path)* Path to PEM encoded TLS private key. Must correspond with - the TLS certificate. - -- *(yes/no)* Verify peer certificate. Instructs server to request and - verify the client’s x509 certificate. Any client certificate signed - by a known-CA will be accepted unless the TLS Allowed CN - configuration directive is used. Not valid in a client context. - -- *(string list)* Common name attribute of allowed peer certificates. - If directive is specified, all client certificates will be verified - against this list. This directive may be specified more than once. - Not valid in a client context. - -- *(path)* Path to PEM encoded TLS CA certificate(s). Multiple - certificates are permitted in the file. One of *TLS CA Certificate - File* or *TLS CA Certificate Dir* are required in a server context - if is also specified, and are always required in a client context. - -- *(path)* Path to TLS CA certificate directory. In the current - implementation, certificates must be stored PEM encoded with - OpenSSL-compatible hashes. One of *TLS CA Certificate File* or *TLS - CA Certificate Dir* are required in a server context if *TLS Verify - Peer* is also specified, and are always required in a client - context. - -- *(path)* Path to PEM encoded Diffie-Hellman parameter file. If this - directive is specified, DH ephemeral keying will be enabled, - allowing for forward secrecy of communications. This directive is - only valid within a server context. To generate the parameter file, - you may use openssl: - - openssl dhparam -out dh1024.pem -5 1024 TLS API Implementation ---------------------- -To facilitate the use of additional TLS libraries, all OpenSSL-specific -code has been implemented within *src/lib/tls.c*. In turn, a generic TLS -API is exported. +Appropriate autoconf macros have been added to detect and use OpenSSL. +Two additional preprocessor defines have been added: `HAVE_TLS` and +`HAVE_OPENSSL`. All changes not specific to OpenSSL rely on +`HAVE_TLS`. In turn, a generic TLS API is exported. ### Library Initialization and Cleanup - int init_tls (void); + int init_tls(void); Performs TLS library initialization, including seeding of the PRNG. PRNG seeding has not yet been implemented for win32. - int cleanup_tls (void); + int cleanup_tls(void); Performs TLS library cleanup. ### Manipulating TLS Contexts - TLS_CONTEXT *new_tls_context (const char *ca_certfile, + TLS_CONTEXT *new_tls_context(const char *ca_certfile, const char *ca_certdir, const char *certfile, const char *keyfile, const char *dhfile, bool verify_peer); @@ -113,20 +63,20 @@ initialize the local certificate and private key. If *dhfile* is non-NULL, it is used to initialize Diffie-Hellman ephemeral keying. If *verify\_peer* is *true* , client certificate validation is enabled. - void free_tls_context (TLS_CONTEXT *ctx); + void free_tls_context(TLS_CONTEXT *ctx); Deallocated a previously allocated *TLS\_CONTEXT* structure. ### Performing Post-Connection Verification - bool tls_postconnect_verify_host (TLS_CONNECTION *tls, const char *host); + bool tls_postconnect_verify_host(TLS_CONNECTION *tls, const char *host); Performs post-connection verification of the peer-supplied x509 certificate. Checks whether the *subjectAltName* and *commonName* attributes match the supplied *host* string. Returns *true* if there is a match, *false* otherwise. - bool tls_postconnect_verify_cn (TLS_CONNECTION *tls, alist *verify_list); + bool tls_postconnect_verify_cn(TLS_CONNECTION *tls, alist *verify_list); Performs post-connection verification of the peer-supplied x509 certificate. Checks whether the *commonName* attribute matches any @@ -135,33 +85,33 @@ there is a match, *false* otherwise. ### Manipulating TLS Connections - TLS_CONNECTION *new_tls_connection (TLS_CONTEXT *ctx, int fd); + TLS_CONNECTION *new_tls_connection(TLS_CONTEXT *ctx, int fd); Allocates and initializes a new *TLS\_CONNECTION* structure with context *ctx* and file descriptor *fd*. - void free_tls_connection (TLS_CONNECTION *tls); + void free_tls_connection(TLS_CONNECTION *tls); Deallocates memory associated with the *tls* structure. - bool tls_bsock_connect (BSOCK *bsock); + bool tls_bsock_connect(BSOCK *bsock); Negotiates a a TLS client connection via *bsock*. Returns *true* if successful, *false* otherwise. Will fail if there is a TLS protocol error or an invalid certificate is presented - bool tls_bsock_accept (BSOCK *bsock); + bool tls_bsock_accept(BSOCK *bsock); Accepts a TLS client connection via *bsock*. Returns *true* if successful, *false* otherwise. Will fail if there is a TLS protocol error or an invalid certificate is presented. - bool tls_bsock_shutdown (BSOCK *bsock); + bool tls_bsock_shutdown(BSOCK *bsock); Issues a blocking TLS shutdown request to the peer via *bsock*. This function may not wait for the peer’s reply. - int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes); + int tls_bsock_writen(BSOCK *bsock, char *ptr, int32_t nbytes); Writes *nbytes* from *ptr* via the *TLS\_CONNECTION* associated with *bsock*. Due to OpenSSL’s handling of *EINTR*, *bsock* is set @@ -170,7 +120,7 @@ blocking state before the function returns. Less than *nbytes* may be written if an error occurs. The actual number of bytes written will be returned. - int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes); + int tls_bsock_readn(BSOCK *bsock, char *ptr, int32_t nbytes); Reads *nbytes* from the *TLS\_CONNECTION* associated with *bsock* and stores the result in *ptr*. Due to OpenSSL’s handling of *EINTR*, @@ -212,17 +162,17 @@ according to the MSDN documentation, but has not been tested. These functions are prototyped as follows: - int bnet_set_nonblocking (BSOCK *bsock); + int bnet_set_nonblocking(BSOCK *bsock); Enables non-blocking I/O on the socket associated with *bsock*. Returns a copy of the socket flags prior to modification. - int bnet_set_blocking (BSOCK *bsock); + int bnet_set_blocking(BSOCK *bsock); Enables blocking I/O on the socket associated with *bsock*. Returns a copy of the socket flags prior to modification. - void bnet_restore_blocking (BSOCK *bsock, int flags); + void bnet_restore_blocking(BSOCK *bsock, int flags); Restores blocking or non-blocking IO setting on the socket associated with *bsock*. The *flags* argument must be the return value of either diff --git a/manuals/en/main/bareos.sty b/manuals/en/main/bareos.sty index a2f38de..df62af9 100644 --- a/manuals/en/main/bareos.sty +++ b/manuals/en/main/bareos.sty @@ -161,6 +161,9 @@ \newcommand{\bareosDeveloperGuideApiModeJson}{% \developerGuide{api-mode-2-json} } +\newcommand{\bareosDeveloperGuideStorageMediaOutputFormat}{% +\developerGuide{storage-media-output-format} +} \newcommand{\bareosWhitepaperTapeSpeedTuning}{% \elink{Bareos Whitepaper Tape Speed Tuning}{http://www.bareos.org/en/Whitepapers/articles/Speed_Tuning_of_Tape_Drives.html}\xspace% @@ -201,6 +204,7 @@ \newcommand{\configresource}[1]{\path|#1|} \newcommand{\configline}[1]{\path|#1|} \newcommand{\directory}[1]{\path|#1|} +\newcommand{\dbtable}[1]{\path|#1|} \newcommand{\email}[1]{\url{#1}} \newcommand{\file}[1]{\path|#1|} \newcommand{\fileset}[1]{\resourcename{Dir}{FileSet}{#1}} @@ -262,13 +266,29 @@ % \newcommand{\warning}[1]{Please note! \textit{#1}} + +\newcommand{\releasenoteSection}[1]{ + \section*{#1} + \addcontentsline{toc}{section}{\protect\numberline{}#1}% +} + % 1: version, 2: description \newcommand{\releasenote}[2]{ \subsection*{bareos-#1} + \addcontentsline{toc}{subsection}{\protect\numberline{}#1}% + \label{bareos-#1} \index[general]{bareos-#1!Release Notes}% #2 } +\newcommand{\releasenoteUnstable}[2]{ + \subsection*{\textit{bareos-#1 (unstable)}} + %\addcontentsline{toc}{subsection}{\protect\numberline{}#1}% + %\index[general]{bareos-#1!Release Notes}% + #2 +} + + \newcommand{\sinceVersion}[3]{% % 1: daemon (dir|sd|fd), % 2: item, diff --git a/manuals/en/main/bconsole.tex b/manuals/en/main/bconsole.tex index 35f84c1..20ef931 100644 --- a/manuals/en/main/bconsole.tex +++ b/manuals/en/main/bconsole.tex @@ -1689,15 +1689,18 @@ unmount [jobid=<id> | job=<job-name>] of updating a Pool record, the new information will be automatically taken from the corresponding Director's configuration resource record. It can be used to increase the maximum number of volumes permitted or to set a maximum - number of volumes. The following main keywords may be specified: - -\footnotesize -\begin{verbatim} - media, volume, pool, slots, stats -\end{verbatim} -\normalsize - -In the case of updating a Volume, you will be prompted for which value you + number of volumes. The following main keywords may be specified: + + \begin{itemize} + \item volume + \item pool + \item slots + \item iobid + \item stats + \end{itemize} + +In the case of updating a Volume (\bcommand{update}{volume}), +you will be prompted for which value you wish to change. The following Volume parameters may be changed: \footnotesize @@ -1720,7 +1723,7 @@ wish to change. The following Volume parameters may be changed: \end{verbatim} \normalsize - For slots {\bf update slots}, Bareos will obtain a list of slots and + For slots \bcommand{update}{slots}, Bareos will obtain a list of slots and their barcodes from the Storage daemon, and for each barcode found, it will automatically update the slot in the catalog Media record to correspond to the new value. This is very useful if you have moved @@ -1733,11 +1736,11 @@ wish to change. The following Volume parameters may be changed: autochanger. If you do not have barcodes, you can accomplish the same thing - by using the {\bf update slots scan} command. - The {\bf scan} keyword tells Bareos to physically mount each tape and to + by using the \bcommand{update}{slots scan} command. + The \parameter{scan} keyword tells Bareos to physically mount each tape and to read its VolumeName. - For Pool {\bf update pool}, Bareos will move the Volume record from its + For Pool \bcommand{update}{pool}, Bareos will move the Volume record from its existing pool to the pool specified. For {\bf Volume from Pool}, {\bf All Volumes from Pool} and {\bf All Volumes @@ -1745,13 +1748,22 @@ wish to change. The following Volume parameters may be changed: Recycle, RecyclePool, VolRetention, VolUseDuration, MaxVolJobs, MaxVolFiles, and MaxVolBytes. + For updating the statistics, use \bcommand{updates}{stats}, see \nameref{sec:JobStatistics}. + The full form of the update command with all command line arguments is: \begin{bconsole}{update} -update volume=<volume-name> pool=<poolname> - slots volstatus=<volume-status> VolRetention=<volume-retention> - VolUse=<volume-use-period> MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes|no - slot=nnn enabled=n recyclepool=<pool-name> +update volume=<volume-name> [volstatus=<status>] + [volretention=<time-def>] [pool=<pool-name>] + [recycle=<yes/no>] [slot=<number>] [inchanger=<yes/no>] | + pool=<pool-name> [maxvolbytes=<size>] [maxvolfiles=<nb>] + [maxvoljobs=<nb>][enabled=<yes/no>] [recyclepool=<pool-name>] + [actiononpurge=<action>] | + slots [storage=<storage-name>] [scan] | + jobid=<jobid> [jobname=<name>] [starttime=<time-def>] + [client=<client-name>] [filesetid=<fileset-id>] + [jobtype=<job-type>] | + stats [days=<number>] \end{bconsole} diff --git a/manuals/en/main/catmaintenance.tex b/manuals/en/main/catmaintenance.tex index a989860..4b7e904 100644 --- a/manuals/en/main/catmaintenance.tex +++ b/manuals/en/main/catmaintenance.tex @@ -77,7 +77,7 @@ Bareos comes with a number of scripts to prepare and update the databases. All t \file{make_bareos_tables} & installation & create Bareos tables \\ \file{grant_bareos_privileges} & installation & grant database access privileges \\ \hline -\file{update_bareos_tables} & update & update the database schema \\ +\file{update_bareos_tables} [-f] & update & update the database schema \\ \hline \file{drop_bareos_tables} & deinstallation & remove Bareos database tables \\ \file{drop_bareos_database} & deinstallation & remove Bareos database \\ @@ -108,32 +108,31 @@ The database preparation scripts have following configuration options: \item[db\_type] \hfill \begin{itemize} \item command line parameter \$1 - \item config file \configFileDirUnix: catalog.MyCatalog.dbdriver + \item \linkResourceDirective{Dir}{Catalog}{DB Driver} from the configuration \item installed database backends \item fallback: postgresql \end{itemize} \item[db\_name] \hfill \begin{itemize} \item environment variable \variable{db_name} - \item config file \configFileDirUnix: catalog.MyCatalog.dbname + \item \linkResourceDirective{Dir}{Catalog}{DB Name} from the configuration \item default: bareos \end{itemize} \item[db\_user] \hfill \begin{itemize} \item environment variable \variable{db_user} - \item config file \configFileDirUnix: catalog.MyCatalog.dbuser + \item \linkResourceDirective{Dir}{Catalog}{DB User} from the configuration \item default: bareos \end{itemize} \item[db\_password] \hfill \begin{itemize} \item environment variable \variable{db_password} - \item config file \configFileDirUnix: catalog.MyCatalog.dbpassword + \item \linkResourceDirective{Dir}{Catalog}{DB Password} from the configuration \item default: \textit{none} \end{itemize} \end{description} -Reading the settings from the configuration file \configFileDirUnix is of course only possible, -if the current user have read access to this file. +Reading the settings from the configuration require read permission for the current user. The normal PostgreSQL administrator user (\user{postgres}) don't have these permissions. So if you plan to use non-default database settings, you might add the user \user{postgres} to the group \group{bareos}. @@ -144,7 +143,7 @@ See the following section about howto achieve this for the different database sy To view and test the currently configured settings, use following commands: \begin{commands}{Show current database configuration} -<command> </command><parameter>/usr/sbin/bareos-dbcheck -B -c /etc/bareos/bareos-dir.conf</parameter> +<command> </command><parameter>/usr/sbin/bareos-dbcheck -B</parameter> catalog=MyCatalog db_name=bareos db_driver=mysql @@ -167,7 +166,7 @@ Database=bareos User=bareos MySQL connect failed either server not running or your authorization is incorrect. bareos-dir: mysql.c:239-0 closedb ref=0 connected=0 db=0 25-Apr 16:25 bareos-dir ERROR TERMINATION -Please correct configuration file: bareos-dir.conf +Please correct the configuration in /etc/bareos/bareos-dir.d/*/*.conf \end{commands} @@ -347,7 +346,7 @@ On productive systems you normally want to have password secured access. The bareos database preparation scripts require password-less access to the database. To guarantee this, create a MySQL credentials file \elink{\file{~/.my.cnf}}{http://dev.mysql.com/doc/refman/4.1/en/password-security.html} with the credentials of the database administrator: -\begin{config}{MySQL credentials file ~/.my.cnf} +\begin{config}{MySQL credentials file .my.cnf} [client] host=localhost user=root @@ -370,8 +369,6 @@ Choose a database password and add it into the Bareos Director configuration fil # Catalog { Name = MyCatalog - # Uncomment the following lines if you want the dbi driver - # dbdriver = "dbi:postgresql"; dbaddress = 127.0.0.1; dbport = dbdriver = "mysql" dbname = "bareos" dbuser = "bareos" @@ -383,7 +380,7 @@ Catalog { After this, run the Bareos database preparation scripts. For Bareos $<=$ 13.2.2, the database password must be specified as environment variable \variable{db_password}. From \sinceVersion{dir}{MySQL password from configuration file}{13.2.3} -the database password is read from \configFileDirUnix, if no environment variable is given. +the database password is read from the configuration, if no environment variable is given. \begin{commands}{Setup Bareos catalog database} export db_password=<input>YourSecretPassword</input> @@ -466,29 +463,22 @@ If you want to change the Bareos database credentials, do the following: \begin{itemize} \item stop the Bareos director - \item modify the configuration file \configFileDirUnix + \item modify the configuration \item rerun the grant script \command{grant_bareos_privileges} (or modify database user directly) \item start the Bareos director \end{itemize} -Modify the configuration file \configFileDirUnix: +Modify the configuration, set a new password: -\begin{bconfig}{Bareos catalog configuration: set new password} -... -# -# Generic catalog service -# +\begin{bareosConfigResource}{bareos-dir}{Catalog}{MyCatalog} Catalog { Name = MyCatalog - # Uncomment the following lines if you want the dbi driver - # dbdriver = "dbi:postgresql"; dbaddress = 127.0.0.1; dbport = dbdriver = "mysql" dbname = "bareos" dbuser = "bareos" dbpassword = "MyNewSecretPassword" } -... -\end{bconfig} +\end{bareosConfigResource} Rerun the Bareos grant script \command{grant_bareos_privileges} ... @@ -528,8 +518,7 @@ mysql> <input>SELECT user,host,password FROM mysql.user WHERE user='bareos';</in +--------+-----------+-------------------------------------------+ 3 rows in set (0.00 sec) -mysql> - +mysql> \end{commands} @@ -572,6 +561,48 @@ sqlite> \section{Retention Periods} +\subsection{Database Size} +\index[general]{Size!Database} +\index[general]{Database Size} + +As mentioned above, if you do not do automatic pruning, your Catalog will grow +each time you run a Job. Normally, you should decide how long you want File +records to be maintained in the Catalog and set the {\bf File Retention} +period to that time. Then you can either wait and see how big your Catalog +gets or make a calculation assuming approximately 154 bytes for each File +saved and knowing the number of Files that are saved during each backup and +the number of Clients you backup. + +For example, suppose you do a backup of two systems, each with 100,000 files. +Suppose further that you do a Full backup weekly and an Incremental every day, +and that the Incremental backup typically saves 4,000 files. The size of your +database after a month can roughly be calculated as: + +\footnotesize +\begin{verbatim} +Size = 154 * No. Systems * (100,000 * 4 + 10,000 * 26) +\end{verbatim} +\normalsize + +where we have assumed four weeks in a month and 26 incremental backups per month. +This would give the following: + +\footnotesize +\begin{verbatim} +Size = 154 * 2 * (100,000 * 4 + 10,000 * 26) = 203,280,000 bytes +\end{verbatim} +\normalsize + +So for the above two systems, we should expect to have a database size of +approximately 200 Megabytes. Of course, this will vary according to how many +files are actually backed up. + +You will note that the File table (containing the file attributes) make up +the large bulk of the number of records as well as the space used. +As a consequence, the most important Retention +period will be the {\bf File Retention} period. + + Without proper setup and maintenance, your Catalog may continue to grow indefinitely as you run Jobs and backup Files, and/or it may become very inefficient and slow. How fast the size of your @@ -582,7 +613,7 @@ deleting old expired records (dates older than the Retention period), your database size will remain constant. -\subsection*{Setting Retention Periods} +\subsection{Setting Retention Periods} \index[general]{Setting Retention Periods} \index[general]{Periods!Setting Retention} \label{Retention} @@ -654,10 +685,11 @@ modifier specification. The default Job Retention period is 180 days. -\item [AutoPrune = {\textless}yes/no{\textgreater}] +\item \linkResourceDirective{Dir}{Client}{Auto Prune} \index[general]{AutoPrune} \index[general]{Job!Retention!AutoPrune} - If AutoPrune is set to {\bf yes} (default), Bareos will automatically apply + If set to {\bf yes}, +Bareos will automatically apply the File retention period and the Job retention period for the Client at the end of the Job. If you turn this off by setting it to {\bf no}, your Catalog will grow each @@ -665,10 +697,9 @@ time you run a Job. \end{description} -\subsubsection{Job statistics} +\subsubsection{Job Statistics} -%\chapter{Using Bareos catalog to grab information} -\label{UseBareosCatalogToExtractInformationChapter} +\label{sec:JobStatistics} \index[general]{Statistics} \index[general]{Job!Statistics} @@ -695,27 +726,28 @@ However, these statistics are accurate only if your job retention is greater than your statistics period. Ie, if jobs are purged from the catalog, you won't be able to use them. -Now, you can use the \textbf{update stats [days=num]} console command to fill +Now, you can use the \bcommand{update}{stats [days=num]} console command to fill the JobHistory table with new Job records. If you want to be sure to take in -account only \textbf{good jobs}, ie if one of your important job has failed but +account only good jobs, ie if one of your important job has failed but you have fixed the problem and restarted it on time, you probably want to -delete the first \textit{bad} job record and keep only the successful one. For +delete the first bad job record and keep only the successful one. For that simply let your staff do the job, and update JobHistory table after two or -three days depending on your organization using the \textbf{[days=num]} option. +three days depending on your organization using the \parameter{[days=num]} option. These statistics records aren't used for restoring, but mainly for capacity planning, billings, etc. -The \configdirective{Statistics Retention = {\textless}time{\textgreater}} director directive defines +The \linkResourceDirective{Dir}{Director}{Statistics Retention} defines the length of time that Bareos will keep statistics job records in the Catalog database after the Job End time. This information is stored in the \texttt{JobHistory} table. When this time -period expires, and if user runs \texttt{prune stats} command, Bareos will +period expires, and if user runs \bcommand{prune}{stats} command, Bareos will prune (remove) Job records that are older than the specified period. -You can use the following Job resource in your nightly \textbf{BackupCatalog} +You can use the following Job resource in your nightly \job{BackupCatalog} job to maintain statistics. -\begin{verbatim} + +\begin{bareosConfigResource}{bareos-dir}{Job}{BackupCatalog} Job { Name = BackupCatalog ... @@ -726,7 +758,7 @@ Job { RunsOnClient = no } } -\end{verbatim} +\end{bareosConfigResource} \section{PostgreSQL} @@ -1181,14 +1213,13 @@ select * from pg_indexes where tablename='file'; \end{verbatim} \normalsize -If you do not see output that indicates that all three indexes -are created, you can create the two additional indexes using: +If the indexes are not present, especially the JobId index, you can +create them with the following commands: \footnotesize \begin{verbatim} psql bareos CREATE INDEX file_jobid_idx on file (jobid); -CREATE INDEX file_jpf_idx on file (jobid, pathid, filenameid); \end{verbatim} \normalsize @@ -1211,7 +1242,6 @@ create them with the following commands: \begin{verbatim} mysql bareos CREATE INDEX file_jobid_idx on File (JobId); -CREATE INDEX file_jpf_idx on File (JobId, FilenameId, PathId); \end{verbatim} \normalsize @@ -1263,7 +1293,6 @@ create them with the following commands: \begin{verbatim} sqlite <path>/bareos.db CREATE INDEX file_jobid_idx on File (JobId); -CREATE INDEX file_jfp_idx on File (JobId, PathId, FilenameId); \end{verbatim} \normalsize @@ -1299,15 +1328,15 @@ The basic sequence of events to make this work correctly is as follows: \item After running your nightly backups, run a Catalog backup Job \item The Catalog backup job must be scheduled after your last nightly backup -\item You use {\bf RunBeforeJob} to create the ASCII backup file and {\bf - RunAfterJob} to clean up +\item You use \linkResourceDirective{Dir}{Job}{Run Before Job} to create the ASCII backup file + and \linkResourceDirective{Dir}{Job}{Run After Job} to clean up \end{itemize} Assuming that you start all your nightly backup jobs at 1:05 am (and that they run one after another), you can do the catalog backup with the following additional Director configuration statements: -\begin{bconfig}{Bareos Catalog Backup Job} +\begin{bareosConfigResource}{bareos-dir}{Job}{BackupCatalog} # Backup the catalog database (after the nightly save) Job { Name = "BackupCatalog" @@ -1328,12 +1357,17 @@ Job { # Should be sent to another system, please change recipient accordingly Write Bootstrap = "|/usr/sbin/bsmtp -h localhost -f \"\(Bareos\) \" -s \"Bootstrap for Job %j\" root@localhost" } +\end{bareosConfigResource} +\begin{bareosConfigResource}{bareos-dir}{Schedule}{WeeklyCycleAfterBackup} # This schedule does the catalog. It starts after the WeeklyCycle Schedule { - Name = "WeeklyCycleAfterBackup + Name = "WeeklyCycleAfterBackup" Run = Level=Full sun-sat at 1:10 } +\end{bareosConfigResource} + +\begin{bareosConfigResource}{bareos-dir}{FileSet}{Catalog} # This is the backup of the catalog FileSet { Name = "Catalog" @@ -1345,54 +1379,10 @@ FileSet { File = "/etc/bareos" # configuration } } -\end{bconfig} +\end{bareosConfigResource} It is preferable to write/send the \ilink{bootstrap}{BootstrapChapter} file to another computer. It will allow you to quickly recover the database backup should that be necessary. If you do not have a bootstrap file, it is still possible to recover your database backup, but it will be more work and take longer. - - - -\section{Database Size} -\index[general]{Size!Database} -\index[general]{Database Size} -\label{Size} - -As mentioned above, if you do not do automatic pruning, your Catalog will grow -each time you run a Job. Normally, you should decide how long you want File -records to be maintained in the Catalog and set the {\bf File Retention} -period to that time. Then you can either wait and see how big your Catalog -gets or make a calculation assuming approximately 154 bytes for each File -saved and knowing the number of Files that are saved during each backup and -the number of Clients you backup. - -For example, suppose you do a backup of two systems, each with 100,000 files. -Suppose further that you do a Full backup weekly and an Incremental every day, -and that the Incremental backup typically saves 4,000 files. The size of your -database after a month can roughly be calculated as: - -\footnotesize -\begin{verbatim} -Size = 154 * No. Systems * (100,000 * 4 + 10,000 * 26) -\end{verbatim} -\normalsize - -where we have assumed four weeks in a month and 26 incremental backups per month. -This would give the following: - -\footnotesize -\begin{verbatim} -Size = 154 * 2 * (100,000 * 4 + 10,000 * 26) = 203,280,000 bytes -\end{verbatim} -\normalsize - -So for the above two systems, we should expect to have a database size of -approximately 200 Megabytes. Of course, this will vary according to how many -files are actually backed up. - -You will note that the File table (containing the file attributes) make up -the large bulk of the number of records as well as the space used. -As a consequence, the most important Retention -period will be the {\bf File Retention} period. diff --git a/manuals/en/main/dirdconf-fileset.tex b/manuals/en/main/dirdconf-fileset.tex index cb69e25..6abd517 100644 --- a/manuals/en/main/dirdconf-fileset.tex +++ b/manuals/en/main/dirdconf-fileset.tex @@ -541,7 +541,7 @@ The options letters specified are used when running a {\bf Backup Level=Full} with BaseJobs. The options letters are the same than in the \textbf{verify=} option below. -\item[accurate={\textless}options{\textgreater}] \index[dir]{accurate} +\item[accurate={\textless}options{\textgreater}] \index[dir]{Accurate} \index[dir]{Directive!accurate} The options letters specified are used when running a {\bf Backup Level=Incremental/Differential} in Accurate mode. The options letters are the same than in the \textbf{verify=} option below. diff --git a/manuals/en/main/director-resource-director-definitions.tex b/manuals/en/main/director-resource-director-definitions.tex index 67f8da5..a7663e8 100644 --- a/manuals/en/main/director-resource-director-definitions.tex +++ b/manuals/en/main/director-resource-director-definitions.tex @@ -221,17 +221,13 @@ With this directive, it will call the specified command to delete these files. S \label{PruneStatistics}% The \configdirective{Statistics Retention} directive defines the length of time that Bareos will keep statistics job records in the Catalog database after the -Job End time (in \texttt{JobHistory} table). When this time period expires, -and if user runs \texttt{prune stats} command, Bareos will prune (remove) +Job End time (in the catalog \dbtable{JobHisto} table). When this time period expires, +and if user runs \bcommand{prune}{stats} command, Bareos will prune (remove) Job records that are older than the specified period. Theses statistics records aren't use for restore purpose, but mainly for capacity planning, billings, etc. -See chapter about \ilink{how to extract information from the catalog}{UseBareosCatalogToExtractInformationChapter} - for additional information. - -See the \ilink{Configuration chapter}{Time} of this manual for additional -details of time specification. +See chapter \nameref{sec:JobStatistics} for additional information. } @@ -239,7 +235,7 @@ details of time specification. In case you want check that the number of active clients don't exceed a specific number, you can define this number here and check with the \bcommand{status subscriptions}{} command. -However, this is only indended to give a hint. No active limiting is implemented. +However, this is only intended to give a hint. No active limiting is implemented. } @@ -266,7 +262,9 @@ may put its status files. This directory should be used only by Bareos but may be shared by other Bareos daemons. Standard shell expansion of the {\bf directory} is done when the configuration file is read so that values such -as {\bf \$HOME} will be properly expanded. +as \path|$HOME| +\hide{$} +will be properly expanded. The working directory specified must already exist and be readable and writable by the Bareos daemon referencing it. diff --git a/manuals/en/main/programs.tex b/manuals/en/main/programs.tex index 8882d62..e07fdfc 100644 --- a/manuals/en/main/programs.tex +++ b/manuals/en/main/programs.tex @@ -112,25 +112,28 @@ developers in dealing with Volumes external to Bareos and to perform other usefu \subsection{Parameter} -\subsubsection{Specifying the Configuration File} +\subsubsection{Specifying the Configuration} Each of the utilities that deal with Volumes require a valid -Storage daemon configuration +\bareosSd configuration (actually, the only part of the configuration file that these programs need is the \resourcetype{Sd}{Device} resource definitions). This permits the programs to find the configuration parameters -for your archive device (generally a tape drive). +for your \linkResourceDirective{Sd}{Device}{Archive Device}. Using the \parameter{-c} option a custom \bareosSd configuration file or directory can be selected. +\subsubsection{Specifying a Device} -\subsubsection{Specifying a Device Name For a Tape} -\index[general]{Tape!Device Name} +Each of these programs require a \parameter{device-name} where the Volume can be +found. +The device-name is either +the name of the \bareosSd device (\linkResourceDirective{Sd}{Device}{Name}) +or its \linkResourceDirective{Sd}{Device}{Archive Device}. -Each of these programs require a {\bf device-name} where the Volume can be -found. In the case of a tape, this is the physical device name such as {\bf -/dev/nst0} or {\bf /dev/rmt/0ubn} depending on your system. For the program to -work, it must find the identical name in the Device resource of the -configuration file. See below for specifying Volume names. +\paragraph{Specifying a Device Name For a Tape} + +In the case of a tape, this is the physical device name such as {\bf +/dev/nst0} or {\bf /dev/rmt/0ubn} depending on your system. \warning{If you have Bareos running and you want to use one of these programs, you will either need to stop the \bareosSd @@ -141,33 +144,33 @@ to load the required volume into the tape drive. } -\subsubsection{Specifying a Device Name For a File} -\index[general]{File!Device Name} +\paragraph{Specifying a Device Name For a File} If you are attempting to read or write an archive file rather than a tape, the -{\bf device-name} should be the full path to the archive location including -the filename. The filename (last part of the specification) will be stripped -and used as the Volume name, and the path (first part before the filename) -must have the same entry in the configuration file. So, the path is equivalent -to the archive device name, and the filename is equivalent to the volume name. -The default file storage path is \fileStoragePath. +\parameter{device-name} can be the full path to the archive location +specified at \linkResourceDirective{Sd}{Device}{Archive Device} +or this including the filename of the volume. +The filename (last part of the specification) will be stripped +and used as the Volume name +So, the path is equivalent to the \linkResourceDirective{Sd}{Device}{Archive Device} +and the filename is equivalent to the volume name. \subsubsection{Specifying Volumes} \index[general]{Volumes!Specifying} -\index[general]{Specifying Volumes} \index[general]{Bootstrap} Often you must specify the Volume name to the programs below. The best method to do so is to specify a -bootstrap file on the command line with the {\bf -b} option. As part of +bootstrap file on the command line with the \parameter{-b} option. As part of the bootstrap file, you will then specify the Volume name or Volume names if more than one volume is needed. For example, suppose you want to read tapes -{\bf tape1} and {\bf tape2}. First construct a {\bf bootstrap} file named say, +\volume{tapevolume1} and \volume{tapevolume2}. +First construct a {\bf bootstrap} file named say, \file{list.bsr} which contains: \footnotesize \begin{verbatim} -Volume=test1|test2 +Volume=tapevolume1|tapevolume2 \end{verbatim} \normalsize @@ -181,26 +184,50 @@ In the case of Bareos Volumes that are on files, you may simply append volumes as follows: \begin{commands}{} -bls /tmp/test1|test2 +bls /var/lib/bareos/storage/volume1\|volume2 \end{commands} where the backslash (\textbackslash{}) was necessary as a shell escape to permit entering the vertical bar (\textbar). And finally, if you feel that specifying a Volume name is a bit complicated -with a bootstrap file, you can use the {\bf -V} option (on all programs except -\command{bcopy}{}) to specify one or more Volume names separated by the vertical bar +with a bootstrap file, you can use the \parameter{-V} option (on all programs except +\command{bcopy}) to specify one or more Volume names separated by the vertical bar (\textbar). For example: \begin{commands}{} -bls -V Vol001 /dev/nst0 +bls /dev/nst0 -V tapevolume1 \end{commands} You may also specify an asterisk (*) to indicate that the program should accept any volume. For example: \begin{commands}{} -bls -V* /dev/nst0 +bls /dev/nst0 -V* +\end{commands} + + + +If your \bareosSd has following resource, +\begin{bareosConfigResource}{bareos-sd}{device}{FileStorage} +Device { + Name = FileStorage + Archive Device = /var/lib/bareos/storage + ... +} +\end{bareosConfigResource} +following calls of \command{bls} should behave identical: + +\begin{commands}{bls using Storage Device Name} +bls FileStorage -V Full1 +\end{commands} +or +\begin{commands}{bls using the Archive Device of a Storage Device} +bls /var/lib/bareos/storage -V Full1 +\end{commands} +or +\begin{commands}{bls using the Archive Device of a Storage Device and volume name} +bls /var/lib/bareos/storage/Full1 \end{commands} @@ -243,34 +270,35 @@ Usage: bls [options] <device-name> -? print this message \end{commands} +Normally if no options are specified, \command{bls} will produce the equivalent +output to the \command{ls -l} command for each volume. + For example, to list the contents of a tape: \begin{commands}{} bls -V Volume-name /dev/nst0 \end{commands} -Or to list the contents of a file: +Or to list the contents of a volume file: \begin{commands}{} -bls /var/lib/bareos/storage/testvol +bls FileStorage -V Full1 \end{commands} or \begin{commands}{} -bls -V testvol /var/lib/bareos/storage +bls /var/lib/bareos/storage -V Full1 +\end{commands} +or +\begin{commands}{} +bls /var/lib/bareos/storage/Full1 \end{commands} -Note that, in the case of a file, the Volume name becomes the filename, so in -the above example, you will replace the {\bf Volume-name} with the name of the volume -(file) you wrote. - -Normally if no options are specified, {\bf bls} will produce the equivalent -output to the {\bf ls -l} command for each file on the tape. Using other -options listed above, it is possible to display only the Job records, only the -tape blocks, etc. For example: +For example: \begin{commands}{} +<command>bls</command> <parameter>FileStorage -V Full1</parameter> bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. -12-Sep 18:30 bls JobId 0: Ready to read from volume "testvol" on device "FileStorage" (/var/lib/bareos/storage). +12-Sep 18:30 bls JobId 0: Ready to read from volume "Full1" on device "FileStorage" (/var/lib/bareos/storage). bls JobId 1: -rwxr-xr-x 1 root root 4614 2013-01-22 22:24:11 /usr/sbin/service bls JobId 1: -rwxr-xr-x 1 root root 13992 2013-01-22 22:24:12 /usr/sbin/rtcwake bls JobId 1: -rwxr-xr-x 1 root root 6243 2013-02-06 11:01:29 /usr/sbin/update-fonts-scale @@ -280,18 +308,45 @@ bls JobId 1: -rwxr-xr-x 1 root root 9480 2013-01-22 22:47:43 / ... bls JobId 456: -rw-r----- 1 root bareos 1008 2013-05-23 13:17:45 /etc/bareos/bareos-fd.conf bls JobId 456: drwxr-xr-x 2 root root 4096 2013-07-04 17:40:21 /etc/bareos/ -12-Sep 18:30 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "testvol" +12-Sep 18:30 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "Full1" 12-Sep 18:30 bls JobId 0: End of all volumes. 2972 files found. \end{commands} +\subsubsection{Show Detailed File Information} + +To retrieve information, about how a file is stored on the volume, you can use \command{bls} in verbose mode: + +\begin{commands}{} +<command>bls</command> <parameter>FileStorage -V TestVolume001 -v</parameter> +bls: butil.c:273-0 Using device: "FileStorage" for reading. +22-Jun 19:34 bls JobId 0: Ready to read from volume "TestVolume001" on device "Storage1" (/var/lib/bareos/storage). +Volume Label Record: VolSessionId=1 VolSessionTime=1498152622 JobId=0 DataLen=168 +Begin Job Session Record: VolSessionId=1 VolSessionTime=1498152622 JobId=1 DataLen=169 +FileIndex=1 Stream=1 UATTR DataLen=129 | -rw-rw-r-- 1 root root 5 2017-06-22 19:30:21 + | /srv/data/test1.dat +FileIndex=1 Stream=29 COMPRESSED DataLen=25 | GZIP, level=9, version=1, length=13 +FileIndex=1 Stream=3 MD5 DataLen=16 | 2Oj8otwPiW/Xy0ywAxuiSQ (base64) +FileIndex=2 Stream=1 UATTR DataLen=123 | drwxrwxr-x 2 root root 4096 2017-06-22 19:30:21 + | /srv/data/ +... +End Job Session Record: VolSessionId=1 VolSessionTime=1498152622 JobId=1 +DataLen=205 +22-Jun 19:34 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "TestVolume001" +22-Jun 19:34 bls JobId 0: End of all volumes. +End of Physical Medium Record: VolSessionId=0 VolSessionTime=0 JobId=0 DataLen=0 +9 files and directories found. +\end{commands} + +For details about the Volume format, see \bareosDeveloperGuideStorageMediaOutputFormat. \subsubsection{Show Label Information} \index[general]{bls!Label} Using the \parameter{-L} the label information of a Volume is shown: -\begin{commandOut}{bls, Show Volume Label}{}{bls -L /var/lib/bareos/storage/testvol} +\begin{commands}{bls: show volume label} +<command>bls</command> <parameter>-L /var/lib/bareos/storage/testvol</parameter> bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. 12-Sep 18:41 bls JobId 0: Ready to read from volume "testvol" on device "FileStorage" (/var/lib/bareos/storage). @@ -308,7 +363,7 @@ MediaType : File PoolType : Backup HostName : debian6 Date label written: 06-Mar-2013 17:21 -\end{commandOut} +\end{commands} \subsubsection{Listing Jobs} @@ -316,10 +371,11 @@ Date label written: 06-Mar-2013 17:21 \index[general]{bls!Listing Jobs} If you are listing a Volume to determine what Jobs to restore, normally the -{\bf -j} option provides you with most of what you will need as long as you +\parameter{-j} option provides you with most of what you will need as long as you don't have multiple clients. For example: -\begin{commandOut}{bls, Listing Jobs}{}{bls /var/lib/bareos/storage/testvol -j} +\begin{commands}{bls: list jobs} +<command>bls</command> <parameter>/var/lib/bareos/storage/testvol -j</parameter> bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. 12-Sep 18:33 bls JobId 0: Ready to read from volume "testvol" on device "FileStorage" (/var/lib/bareos/storage). Volume Record: File:blk=0:193 SessId=1 SessTime=1362582744 JobId=0 DataLen=158 @@ -342,9 +398,9 @@ End Job Session Record: File:blk=0:320694269 SessId=301 SessTime=1369307832 JobI Date=11-Sep-2013 23:10:03 Level=F Type=B Files=12 Bytes=1,472,681 Errors=0 Status=T 12-Sep 18:32 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "testvol" 12-Sep 18:32 bls JobId 0: End of all volumes. -\end{commandOut} +\end{commands} -Adding the {\bf -v} option will display virtually all information that is +Adding the \parameter{-v} option will display virtually all information that is available for each record. \subsubsection{Listing Blocks} @@ -356,7 +412,7 @@ blocks (the "primitive" unit of Bareos data on the Volume). However, you can do so with: \begin{commands}{} -bls -k /tmp/File002 +<command>bls</command> <parameter>-k /tmp/File002</parameter> bls: butil.c:148 Using device: /tmp Block: 1 size=64512 Block: 2 size=64512 @@ -367,11 +423,11 @@ bls: Got EOF on device /tmp End of File on device \end{commands} -By adding the {\bf -v} option, you can get more information, which can be +By adding the \parameter{-v} option, you can get more information, which can be useful in knowing what sessions were written to the volume: \begin{commands}{} -bls -k -v /tmp/File002 +<command>bls</command> <parameter>-k -v /tmp/File002</parameter> Date label written: 2002-10-19 at 21:16 Block: 1 blen=64512 First rec FI=VOL_LABEL SessId=1 SessTim=1035062102 Strm=0 rlen=147 Block: 2 blen=64512 First rec FI=6 SessId=1 SessTim=1035062102 Strm=DATA rlen=4087 @@ -387,11 +443,11 @@ End of File on device Armed with the SessionId and the SessionTime, you can extract just about anything. -If you want to know even more, add a second {\bf -v} to the command line to +If you want to know even more, add a second \parameter{-v} to the command line to get a dump of every record in every block. \begin{commands}{} -bls -k -v -v /tmp/File002 +<command>bls</command> <parameter>-k -vv /tmp/File002</parameter> bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=1 Hdrcksum=b1bdfd6d cksum=b1bdfd6d bls: block.c:92 Rec: VId=1 VT=1035062102 FI=VOL_LABEL Strm=0 len=147 p=80f8b40 diff --git a/manuals/en/main/releasenotes.tex b/manuals/en/main/releasenotes.tex index b49814f..8958b6a 100644 --- a/manuals/en/main/releasenotes.tex +++ b/manuals/en/main/releasenotes.tex @@ -14,7 +14,32 @@ This chapter concentrates on things to do when updating an existing Bareos insta \warning{While all the source code is published on \elink{GitHub}{https://github.com/bareos/bareos}, the releases of packages on \url{http://download.bareos.org} is limited to the initial versions of a major release. Later maintenance releases are only published on \url{https://download.bareos.com}.} -\section*{Bareos-16.2} +\releasenoteSection{Bareos-17.2} + +\releasenoteUnstable{17.2.2}{ + +\begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} +Code Release & \\ +Database Version & 2170\\ +Release Ticket & \\ +Url & \\ +\end{tabular} + +This release contains several enhancements. Excerpt: +\begin{itemize} + \item Denormalization of the \dbtable{File} database table + \begin{itemize} + \item The denormalization of the \dbtable{File} database table leads to enormous performance improvements in installation, which covering a lot of file (millions). + \item For the denormalization the database schema must be modified. + \warning{Updating the database to schema version 2170 will increase the required disk space. + Especially it will require around twice the amount of the current database disk space during the migration.} + \end{itemize} +\end{itemize} + +} + + +\releasenoteSection{Bareos-16.2} \releasenote{16.2.6}{ @@ -136,7 +161,7 @@ First stable release of the Bareos 16.2 branch. \end{itemize} } -\section*{Bareos-15.2} +\releasenoteSection{Bareos-15.2} \releasenote{15.2.4}{ @@ -209,7 +234,7 @@ When coming from bareos-14.2.x, the following things have changed (same as in ba -\releasenote{15.2.1}{ +\releasenoteUnstable{15.2.1}{ \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2015-09-16\\ @@ -236,7 +261,7 @@ Beta release. } -\section*{Bareos-14.2} +\releasenoteSection{Bareos-14.2} It is known, that \command{drop_database} scripts will not longer work on PostgreSQL $<$ 8.4. However, as \command{drop_database} scripts are very seldom needed, package dependencies do not yet enforce PostgreSQL $>=$ 8.4. We plan to ensure this in future version of Bareos. @@ -373,7 +398,7 @@ Url & \releaseUrlDownloadBareosOrg{14.2} \\ First stable release of the Bareos 14.2 branch. } -\releasenote{14.2.1}{ +\releasenoteUnstable{14.2.1}{ \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2014-09-22 \\ @@ -385,7 +410,7 @@ Url & \releaseUrlDownloadBareosOrg{14.2} \\ Beta release. } -\section*{Bareos-13.2} +\releasenoteSection{Bareos-13.2} \releasenote{13.2.5}{ @@ -431,7 +456,7 @@ Url & \releaseUrlDownloadBareosOrg{13.2} \\ -\section*{Bareos-12.4} +\releasenoteSection{Bareos-12.4} \releasenote{12.4.8}{ diff --git a/manuals/en/main/tls.tex b/manuals/en/main/tls.tex index 7bb317f..6cd40ea 100644 --- a/manuals/en/main/tls.tex +++ b/manuals/en/main/tls.tex @@ -73,7 +73,7 @@ Request and verify the peers certificate. In server context, unless the \configdirective{TLS Allowed CN} configuration directive is specified, any client certificate signed by a known-CA will be accepted. -In client context, the server certificate common name attribute is checked against +In client context, the server certificate CommonName attribute is checked against the \configdirective{Address} and \configdirective{TLS Allowed CN} configuration directives. |