Skip to content

Commit

Permalink
fix(docs): fix toc tree and navigation
Browse files Browse the repository at this point in the history
Fix toc tree and navigation for the whole documentation
  • Loading branch information
dfranco committed Dec 29, 2023
1 parent d53bd3f commit ff7a826
Show file tree
Hide file tree
Showing 18 changed files with 109 additions and 107 deletions.
19 changes: 11 additions & 8 deletions docs/source/01_about/about.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.. _about/about:

About the project
=================

Bacula-Web is a php web based tool that provide you a summarized view of jobs, pools and volumes. Its obtain his information from your bacula catalog database.

This tool provide you information on the last day jobs status, medias and pool usage, catalog size usage, and even more ...
Expand All @@ -19,15 +22,15 @@ If you're looking for a tool able to manage Bacula like bat, Bacula-Web might no
I'd advise to have a look on Bweb, baculum, BAT or Bacula Webmin plugin instead.

The project history
===================
-------------------

Bacula-Web was originally created and developed by Juan-Luis Frances Jimenez.
He made a very nice work.

Since the end of 2010, I was officially designed the official maintainer by Kern S. and Eric B. for this project.

Project timeline
****************
----------------

**2004 - 2008**

Expand All @@ -52,7 +55,7 @@ Then, I've found Bacula-Web which at this time, wasn't maintained since few year
After I've submitted some patches to Bacula developers, I proposed to become the official maintainer of this project. So the project revival started on July 2010.

Third-party tools and libraries
===============================
-------------------------------

Bacula-Web use the following tools and libraries

Expand All @@ -78,7 +81,7 @@ Component License
=========================== ================

Supported browser
=================
-----------------

Bacula-Web was successfully tested with

Expand All @@ -90,7 +93,7 @@ Bacula-Web was successfully tested with
.. important:: Bacula-Web needs Javascript and Cookies to run well in your web browser, do not disable one of those.

Translations
============
------------

Bacula-Web language is by default in english, but it's also translated in not less than 15 languages

Expand All @@ -117,14 +120,14 @@ You're all doing a fantastic job !!!
.. important:: If you want to contribute in maintaining translations for a language or add a new one, have a look at the :ref:`contribute/translations` chapter

About Bacula
============
------------

Bacula is a set of Open Source, enterprise ready, computer programs that permit you (or the system administrator) to manage backup, recovery, and verification of computer data across a network of computers of different kinds. Bacula is relatively easy to use and efficient, while offering many advanced storage management features that make it easy to find and recover lost or damaged files. In technical terms, it is an Open Source, enterprise ready, network based backup program (source `www.bacula.org`_).

IMHO, Bacula is a great open source backup tool (for professional and private purpose)

About myself
============
------------

I've discovered Linux with `Slackware`_ maybe around 1995 ( I know, I'm an old guy).
Since this time, I had some experiences with
Expand All @@ -141,7 +144,7 @@ And many more stuff that I'll not describe there (it's not a resume, it's just a
My preferred Linux distros is `Gentoo`_ and I use `Centos`_ for labs, development and testing

Others good tools
=================
-----------------

There are a lot of tool which can help you administering, monitoring and configuring Bacula like

Expand Down
66 changes: 30 additions & 36 deletions docs/source/01_about/features.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
.. _about/features:

########
Features
########
Features overview
=================

********
Overview
********

Install once, monitor several directors
=======================================
---------------------------------------

You just need to Install Bacula-Web once, then monitor as much Bacula directors you have.

Bacula-Web give you the ability to keep an eye on all your Bacula directors from a single point.
You can Install it on a dedicated server and manage all your Bacula instances from a single Bacula-Web instance.

Keep an eye on Bacula events and resources
===========================================
------------------------------------------

Bacula-Web Dashboard provide an overall overview of your Bacula jobs, Volumes, Pools, Catalog statistics, Amount of Bytes/Files protected by Bacula, etc..

You can choose within predefined period like last 24 hours, last week, last month or since beginning of time period.

Bacula-Web in your language
===========================
---------------------------

Bacula-Web come by default in english but, with the help of the community, it has been translated in several languages listed below

Expand All @@ -48,13 +44,13 @@ Translations are a work in progress, if you want to contribute, please read the
.. note:: A huge thanks to the community for his help translating Bacula-Web :)

Jobs report page
================
----------------

The jobs report page shows you Bacula jobs with several ordering and filtering options.
Another useful feature is that you can check log or each jobs and jump to **Backup job report** page from any backup job.

Client backup report
====================
--------------------

Client backup report provide you for each Bacula client the details below

Expand All @@ -63,41 +59,40 @@ Client backup report provide you for each Bacula client the details below
* last x days stored bytes and files graphs

Backup job report
=================
-----------------

Backup job report display useful information about Bacula jobs like

* last completed jobs
* last x days stored bytes and files graphs

Job files report
================
----------------

Job files report list all files and folder backed up by a backup job

.. note:: Since Bacula-Web 8.4.0, you can filter the file(s)/folder(s) list using a search box

Pools and volumes
=================
-----------------

Pools and volumes provide you a list of all Bacula pools and assigned volumes with details like volume name, Bytes, Media type, expiration date, last written date, status

Directors
=========
---------

The directors report display basic information about all Bacula catalog you have configured

Test page
=========
---------

Test page give you some useful information about your Bacula-Web installation and configuration

*************
Features list
*************
=============

Dashboard
=========
---------

.. image:: /_static/bacula-web-dashboard-crop.jpeg
:scale: 15%
Expand All @@ -117,7 +112,7 @@ Bacula-Web Dashboard provide a lot of information about your Bacula infrastructu
----

Jobs report
===========
-----------

.. image:: /_static/bacula-web-jobs-report.jpg
:scale: 15%
Expand All @@ -143,7 +138,7 @@ Jobs report display latest Bacula jobs (backup,copy,restore) in a table format c
----

Job logs
========
--------

.. image:: /_static/bacula-web-job-logs-option.jpg
:scale: 60%
Expand All @@ -152,8 +147,8 @@ Job logs can be displayed by clicking on the loop icon off each job

----

Filter and options
==================
Job filter and options
----------------------

.. image:: /_static/bacula-web-jobs-report-options.jpg
:scale: 60%
Expand All @@ -163,7 +158,7 @@ You can use different filter and ordering options
----

Job logs
========
--------

.. image:: /_static/bacula-web-job-logs.jpg
:scale: 20%
Expand All @@ -176,7 +171,7 @@ The Job logs page display
----

Pools
=====
-----

.. image:: /_static/bacula-web-pools.jpg
:scale: 20%
Expand All @@ -192,7 +187,7 @@ You can display associated volumes of each pool by clicking on **Show volumes**
----

Volumes
=======
-------

.. image:: /_static/bacula-web-volumes.jpg
:scale: 20%
Expand All @@ -218,7 +213,7 @@ The total of bytes and number of volumes is displayed at the bottom of the page
----

Volume details
==============
--------------

.. image:: /_static/bacula-web-volume-details.jpg
:scale: 20%
Expand All @@ -238,7 +233,7 @@ Display volume details such as
----

Backup jobs report
==================
------------------

.. image:: /_static/bacula-web-backupjob-report.jpg
:scale: 20%
Expand All @@ -259,7 +254,7 @@ You can choose different periods such as last
----

Clients backup report
=====================
---------------------

.. image:: /_static/bacula-web-client-report.jpg
:scale: 25%
Expand All @@ -282,7 +277,7 @@ You can choose different periods such as last
----

Directors
=========
---------

.. image:: /_static/bacula-web-directors.jpg
:scale: 20%
Expand All @@ -306,7 +301,7 @@ Bacula director details are
----

Job files
=========
---------

.. image:: /_static/bacula-web-jobfiles.jpg
:scale: 20%
Expand All @@ -318,7 +313,7 @@ This report list all files of a Bacula backup job with pagination.
----

Test page
=========
---------

.. image:: /_static/bacula-web-test-page.jpg
:scale: 20%
Expand All @@ -342,7 +337,7 @@ The test page do the following check for you
----

General settings
================
----------------

.. image:: /_static/bacula-web-settings.jpg
:scale: 20%
Expand All @@ -357,7 +352,7 @@ page in a future version.
----

User settings
=============
-------------

.. image:: /_static/bacula-web-user-settings.jpg
:scale: 20%
Expand All @@ -370,9 +365,8 @@ It also allow each users to reset their own password.

----

*****************
Known limitations
*****************
-----------------

As of now, Bacula-Web is only a reporting and monitoring tool, it only access your Bacula director (read only) to retrieve information from Bacula catalog.

Expand Down
6 changes: 5 additions & 1 deletion docs/source/01_about/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
.. _about/index:

#####
About
#####

.. toctree::
:maxdepth: 2

about
features
release
release
license
security
17 changes: 5 additions & 12 deletions docs/source/02_install/apache-installation.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
.. _install/apache-installation:

==============================
Apache web server
==============================

Installation
============

Before you start
----------------
Apache
======

Before proceeding to Apache / PHP installation and configuration, read the :ref:`install/requirements` page.

Expand Down Expand Up @@ -161,10 +154,10 @@ With SQLite bacula catalog
.. note:: A big thanks to Dean E. Weimer who provided me Bacula-Web installation instructions for \*BSD setup

Apache web server configuration
===============================
-------------------------------

PHP configuration
=================
-----------------

Update the timezone parameter in your PHP configuration in order to prevent Apache warning messages (see below)

Expand Down Expand Up @@ -192,7 +185,7 @@ Reload Apache configuration
$ sudo service httpd reload || sudo /etc/init.d/httpd reload

Apache virtualhost
==================
------------------

In order to secure the application folder and avoid exposing sensitive information contained in Bacula-Web configuration.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/02_install/configure.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _install/configure:

====================
********************
Configure Bacula-Web
====================
********************

This section explain how to create the configuration file which contain your custom settings.

Expand Down

0 comments on commit ff7a826

Please sign in to comment.