ABOUT
Posts Tagged ‘documentation’
The Shell Control Box 3 F3 Administrator Guide
Hi,
We have published the latest edition of The Shell Control Box 3 F3 Administrator Guide. New features have been included, for example: RPC-API for remote SCB access and integration, TLS support for Telnet and VNC and Support for Citrix XenDesktop. Also, several issues have been fixed.
We have also published the SCB 3.3.0 RPC API User Guide. It describes the RPC API, that enables remote SCB access, facilitates integration into custom applications and environments, and provides flexible, dynamic search queries and management. It is available here, and can be opened from the SCB web interface as well.
The Administrator Guide, Upgrade Guide and What is new documents are now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions.
The most important changes to the document have been described in the Announcement, Whatsnew and also the Summary of changes section of the document.
The following parts have been changed:
- Chapter The SCB RPC API has been added to the document.
- Procedure Enabling TLS-encryption for Telnet connections and Procedure Enabling TLS-encryption for VNC connections have been added to the document.
- Section Database tables available for custom queries has been updated for SCB 3 F3.
- The live replay mode of the Audit Player application has been added to Procedure Replaying a session with the Audit Player.
- The description of cipher strength settings have been included in Procedure Creating and editing protocol-level Telnet settings and Procedure Creating and editing protocol-level VNC settings.
- Information about uploading certificate chains have been included in Procedure Uploading external certificates to SCB.
- Procedure Adding a new font to the OCR database has been added to the document.
- Procedure Restoring configuration from a configuration backup has been added to the document.
- Corrections and clarifications have been made in Procedure Authenticating users to a RADIUS server.
- The troubleshooting section has been moved to Chapter Troubleshooting SCB.
- Procedure Replacing a HA node has been added to Section Troubleshooting an SCB cluster.
- Typos have been corrected in Procedure Exporting the configuration of SCB.
- Notes about username case-sensitivity and authenticating domain users have been added to Section Using credential stores for server-side authentication.
The syslog-ng Store Box 3 LTS Administrator Guide
Hi,
We have published the latest edition of The syslog-ng Store Box 3 LTS Administrator Guide. SSB can now forward messages to an SNMP destination, and is powered by a 64-bit operating system. Message rate alerting is available, to detect abnormalities. SSB can now search for wildcards and boolean expressions, and rewrite parts of the messages using rewrite rules.
The documents are now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions.
The most significant changes to the document have been described in the Announcement, Whatsnew and also the Summary of changes section of the document. These include new features, stability and performance improvements, and other changes.
- Description of the Don’t parse messages has been added to Procedure Creating message sources in SSB.
- Figures Configuring SNMP and e-mail alerting; Default message sources in SSB; Configuring syslog-ng options; Configuring persistent name resolution; Configuring TLS settings for syslog-ng; Creating database destinations; Creating server destinations; Displaying search information; Displaying statistics; Creating a new logstore; Creating a new text logspace and Creating new message sources have been updated.
- Figures Creating an early time alert; Using the master alert to indicate unexpected events and Modifying messages using rewrite have been added to the document.
- Alerts Message rate was outside the specified limits and Too many message rate alerts were generated have been added to Section Alerts related to syslog-ng.
- The list of sources in Section Default message sources in SSB has been updated with the BSDsyslog (legacy TCP) protocol.
- Procedure Configuring message rate alerting has been added to the document.
- Section Using wildcards and boolean search has been added to the document.
- Procedure Modifying messages using rewrite has been added to the document.
- Procedure Preventing disk space fill up has been added to the document.
- Procedure Restoring configuration from a configuration backup has been added to the document.
- Section Default message sources in SSB has been updated with new default ports.
- Section Supported web browsers and operating systems has been updated with new supported and tested browsers.
- Section Statistics collection options has been updated.
- Rate limiting has been removed from Procedure Creating message sources in SSB.
- The troubleshooting section has been moved to Troubleshooting SSB.
- A warning has been added to Procedure Configuring e-mail alerts.
The syslog-ng Premium Edition 4F2 Administrator Guide
Hi,
We have published the latest edition of The syslog-ng Premium Edition 4F2 Administrator Guide. New features, and the description of a new protocol has been included.
The documents are now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions.
The most important changes to the document have been described in the Announcement, Whatsnew and also the Summary of changes section of the document. We have added the description of reliable disk-based buffering that prevents log loss in case of reload/restart, unreachable destination or syslog-ng PE crash. Starting with version 4 F2, the syslog-ng PE application is able to collect messages from tables or relational databases, such as Microsoft SQL (MSSQL), MySQL, Oracle and PostgreSQL databases. A new protocol – Reliable Log Transfer Protocol™ (RLTP™) has been introduced in this edition. It is a new transport protocol that prevents message loss during connection breaks. We have added a new hard macro to the macro list, syslog-ng PE can now be installed to an alternative location using .RUN installer, the number of processors/cores are limited in the license file, lgstool cat and lgstool tali –filter options are available and AIX 7.1 has been added to the list of supported platforms. These, and many more are available in the latest edition of the document.
The following parts have been changed:
- Section 6.7, Collecting messages from tables or relational database has been added to the document.
- Section format-welf has been added to the document.
- Section 8.3.1, Enabling reliable disk-based buffering has been added to the document.
- Section 8.3.2, Enabling normal disk-based buffering has been added to the document.
- Section 8.3.3, Enabling memory buffering has been added to the document.
- Section 3.5, Installing syslog-ng PE using .pkg installer has been added to the document.
- Section 3.2, Installing syslog-ng using the .run installer has been updated with alternative path-related information.
- Section 6.4, Collecting messages using the RFC3164 protocol has been added to the document.
- Section 7.3, Sending messages to a remote logserver using the RFC3164 protocol has been added to the document.
- Chapter 11, Reliable Log Transfer Protocol™ has been added to the document.
- The macro RCPTID() has been added to the document. For details, see Section use_rcptid() and Section RCPTID.
- The module disk-buffer() has been added to destinations program(), sql(), syslog(), tcp(), tcp6(), udp(), udp6(), unix-dgram() and unix-stream() in Chapter 7, Sending and storing log messages — destinations and destination drivers.
- The –filter option has been added to the lgstool cat and tail commands in the section called “The cat command” and the section called “The tail command”.
- Figures Installation path and Registering as syslog service have been added to the document.
- A note has been added to Section 7.5, Sending messages to external applications.
- The option flush_timeout() has become deprecated.
- The description of the option flush_lines() has been modified.
- AIX 7.1 has been added to the list of supported platforms.
- Missing example titles have been added.
- The description of option mark() has been clarified in Section 9.2, Global options.
- The format of macros has been modified from $<MACRONAME> to ${<MACRONAME>} in Chapter 2, The concepts of syslog-ng, Chapter 4, The syslog-ng PE quick-start guide, Chapter 6, Collecting log messages — sources and source drivers, Chapter 7, Sending and storing log messages — destinations and destination drivers, Chapter 8, Routing messages: log paths, reliability, and filters, Chapter 12, Manipulating messages, Chapter 13, Parsing and segmenting structured messages, Chapter 14, Processing message content with a pattern database, Chapter 16, Multithreading and scaling in syslog-ng PE, the section called “The cat command”, the section called “The tail command” , the section called “The dump command” and the section called “The match command”.
- Typo corrections and clarifications to the manual pages in Appendix 1, The syslog-ng manual pages.
The syslog-ng Premium Edition 4F1 Administrator Guide
Hi,
We have published the latest edition of The syslog-ng Premium Edition 4F1 Administrator Guide. The document has undergone some significant structural changes to facilitate finding and understanding information.
The documents are now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions.
The most important changes to the document have been described in the Announcement, Whatsnew and also the Summary of changes section of the document. The structure of the document has changed significantly; several important topics and feature descriptions were moved to their own chapters. These chapters contain most (if not all) the information related to the feature, including concepts, configuration, and reference. We have also made many other clarifications, corrections, reordering of sections, and other changes. The structure of the Premium Edition document now resembles the structure of the Open Source Edition document, so upgrading from OSE to PE has become simpler.
The following parts of the document have been changed:
- Section 10.4, “TLS options” includes the descriptions of the new
ca-dir-layout()and thecipher-suite()options. - The
log_fifo_size()option can be set for logstore destinations as well. The default value oflog_fifo_size()has been increased to 10000. - Section 8.2, “Managing incoming and outgoing messages with flow-control” has been updated with description about hard and soft flow-control.
- A note has been added to the section called “mark_mode()”.
- Chapter 1, Introduction to syslog-ng has been updated with data on performance.
- Removed section Handling lots of parallel connections.
- Added a note about the statistics of messages with high facility numbers to Chapter 14, Statistics of syslog-ng.
- The description of the
dir_perm()option of file destinations has been clarified. - The description of the
time_reap()option has been added to Section 7.1.1, “file() destination options”. - The descriptions of facility and priority values used by the
internal()source has been added to Section 6.2, “Collecting internal messages”. - The description of the
pad_size()option has been clarified in Section 6.3.2, “file() source options”. - The description of the
port()option has been added to Section 7.6, “Storing messages in an SQL database”. - The working of the SQL destination driver has been clarified.
- The description of the
pad_size()option has been added to Section 7.1.1, “file() destination options” and Section 7.3.1, “pipe() destination options”. - The handling of IETF-syslog messages has been clarified in Section 2.9.2, “IETF-syslog messages”.
- Documented that multiple configuration files can be included from a directory in Section 5.5.1, “Including configuration files”.
- The syntax of the configuration file has been clarified in Section 5.5.1, “Including configuration files”.
- The
follow_freq()option has been removed from Section 6.10.1, “unix-stream() and unix-dgram() source options”. - The
optional()option has been removed from Section 6.7.1, “syslog() source options”. - The
ip_tos(), ip_ttl(), so_broadcast(), so_sndbuf(), follow_freq()options have been removed from Section 6.9.1, “tcp(), tcp6(), udp() and udp6() source options”. - The
so_broadcast(), so_sndbuf()options have been removed from Section 6.10.1, “unix-stream() and unix-dgram() source options”. - Section 2.9.3, “Message representation in syslog-ng PE” has been added to the document.
- Section 2.6, “Versions and releases of syslog-ng PE” has been updated.
- Section 5.4.1, “Loading modules”
- Section 7.5, “Sending SNMP traps”
- Chapter 15, Multithreading and scaling in syslog-ng PE
- Section 5.2, “Global and environmental variables”
- Section 5.5.2, “Reusing configuration blocks”
- Section 6.8, “Collecting the system-specific log messages of a platform”
- Section 8.5.3, “Comparing macro values in filters”
- Section 11.1.5, “Using template functions”
- Section 11.2.1, “Conditional rewrites”
- Section 13.3, “Correlating log messages”
- Section 13.4, “Triggering actions for identified messages”
- Section 13.5.2, “What’s new in the syslog-ng pattern database format V4”
- pdbtool(1)
The syslog-ng Store Box 2 F1 Administrator Guide
Hi,
We have published the latest edition of The syslog-ng Store Box 2 F1 Administrator Guide. We did not change too much in the document this time, but there are still some significant features that are worth mentioning.
The documents are now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions.
The most significant changes to the document have been described in the Announcement, Whatsnew and also the Summary of changes section of the document. These include new features, stability and performance improvements, and other changes.
We have
- Added Procedure Receiving SNMP messages to the document.
- Updated and corrected references to hardware manuals in Appendix syslog-ng Store Box Hardware Installation Guide.
- Added Appendix syslog-ng Store Box VMware Installation Guide to the document.
- Added Procedure Modifying the IP address of SSB to the document.
- Updated Section High Availability status explained with ‘Converted’ status.
- Added Windows 7 to the supported operating systems list in sections Supported web browsers and operating systems, Supported protocols and client applications and Viewing session information and replaying audit trails.
- Added a note to Section Accessing shared files.
- Added Section Summary of changes to the document.
- Made procedures in the HTML version of the document appear on separate HTML pages.
- Corrected labels of cross-references pointing to procedure steps.
- Restructured procedures to facilitate easier understanding.
- Replaced Latin abbreviations with their English equivalents.
The syslog-ng Premium Edition 4.0 Administrator Guide
Hi,
We have published the latest edition of The syslog-ng Premium Edition 4.0 Administrator Guide. This is again the result of a fruitful cooperation between the syslog-ng team and the technical writer team, and a long, but useful review period.
The documents are now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions.
The most significant changes to the document have been described in the Announcement, Whatsnew and also the Summary of changes section of the document. These include new supported platforms, new features, stability and performance improvements, new macros and utilities and other changes.
We have
- Added Section “retry_sql_inserts” to the document.
- Added Section “flags()” to the document.
- Added Section 3.4, “Upgrading syslog-ng PE” to the document.
- Updated Section 1.6, “Supported platforms” with additional supported platforms.
- Updated destinations
file(),pipe(),program(),syslog(),tcp(),udp(),unix-dgram()andunix-stream()in Section 6.2, “Destination drivers”. - Updated options
mark()andmark_freq()and addedmark_mode()to Section “mark() (DEPRECATED)”. It has also been linked to the relevant destination drivers. - Message types were enlisted in Section 6.1.1, “internal()”.
- Updated Section 4.3.2, “Collecting messages from text files” with
file@-related information. - Updated section
pad_size()in Section 6.1.3, “pipe()”. - Updated Section 4.1.3, “Notes about the configuration syntax”.
- Added Section 1.6.1, “Certified packages” to the document.
- Added the description of the
serializedlogstore flag to Section “flags()”. - Moved Section 4.1.3, “Notes about the configuration syntax” from Section 4.2, “Defining global objects” to Section 4.1, “The syslog-ng configuration file”.
Summary of changes
Hi,
I am happy to inform you that we have included a new section in the Preface chapter of the latest documents: Summary of changes. We aim to facilitate information flow between the documentation team and our external and internal customers with this minor innovation.
The section intends to describe the changes in the document between two subsequent versions, focusing on the document itself. ( /! Note: if you would like to know about the changes in the product, consult the Announcement, it enumerates the new features and bugfixes.) It enables you to follow the updates of the three latest versions. The user-visible updates that affect documentation are described in the “Changes in product” section, whereas editorial, structural, linguistic or other documentation-related changes and bugfixes are listed in the “Changes in documentation” section. The updated chapters / sections / procedures / figures / tables are enumerated along with the description of the change, where applicable.
If you are interested in the newest updates in our documents, do not hesitate to read the Summary of changes section.
The syslog-ng Agent for Windows 3.2 Administrator Guide, 3rd edition
Hi,
We have published the latest edition of The syslog-ng Agent for Windows 3.2 Administrator Guide. In this release, we have been working together closely with the development team, we had a quite thorough document review phase, and the result is now available on the BalaBit Documentation Page in PDF, HTML and single-page HTML versions. I would like to express my warmest thanks to the team for their cooperation and help.
The most significant changes to the document have been described in the Announcement and also the Summary of changes section of the document.
We have
- Added how to set file encoding to Procedure 3.3.2, “Managing file sources”.
- Added the Snare protocol description to Procedure 3.2.1, “Configuring the destination logservers”.
- Added global and destination-specific filters to Section 3.5, “Filtering messages”.
- Documented XML export and import in Section 3.1.3, “Using an XML-based configuration file” and removed the obsolete XML examples.
- Added how to process multi-line messages to “Processing multi-line messages”.
- Added filters to Procedure 3.5.1, “Filtering eventlog messages”.
- Added filters to Procedure 3.5.2, “Filtering file messages”.
- Updated macros in Section 3.6.3, “Macros available in the syslog-ng Agent”.
- Figures have now also been added to the document to facilitate easier understanding.og
