Skip to content

Commit

Permalink
docs: minor update/fix to documentation
Browse files Browse the repository at this point in the history
Add more links to the table of content tree (index page left navigation)

Replace dashboard screenshot by logo on index page

Add Symfony Console to the list of used components

Remove archive installation as it's not supported anymore

Remove upgrade from archive section from Upgrade page

Fix typos in several pages
  • Loading branch information
dfranco committed Dec 4, 2023
1 parent c8ead7c commit 0f1e59c
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 150 deletions.
2 changes: 2 additions & 0 deletions docs/source/01_about/about.rst
Expand Up @@ -78,6 +78,7 @@ Component License
`Twig`_ BSD-3-Clause
`cocur/human-date`_ MIT
`odan/session`_ MIT
`Symfony Console`_ MIT
=========================== ================

Supported browser
Expand Down Expand Up @@ -185,3 +186,4 @@ You can find a complete `list of GUI`_ on the Bacula's web site
.. _cocur/human-date: https://github.com/cocur/human-date
.. _odan/session: https://github.com/odan/session
.. _Twig: https://github.com/twigphp/Twig
.. _Symfony Console: https://github.com/symfony/console
2 changes: 1 addition & 1 deletion docs/source/02_install/finalize.rst
Expand Up @@ -56,7 +56,7 @@ You can manage users from the **General settings** dropdown menu.

To add more users, simply use the **Add user** form at the bottom of the page (password must be at least 6 characters long).

.. note:: User's email address is not for the moment but it will in a future version
.. note:: User's email address is not used for the moment, but it will in a future version

.. image:: /_static/bacula-web-users.jpg
:scale: 60%
10 changes: 4 additions & 6 deletions docs/source/02_install/index.rst
Expand Up @@ -25,13 +25,11 @@ Bacula-Web can be installed in different way, but the recommended way is by usin
You will find more details by following the links below

* Install :ref:`using Composer<install/installcomposer>`
* Install :ref:`using the archive<install/installarchive>` (see note below)
* Install using Docker, more details https://hub.docker.com/r/baculaweb/bacula-web (available since version 8.7.0
* Install using the archive is not supported anymore, see note below)

As of version version 8.7.0, Bacula-Web can also be run using **Docker container image** (follow link below for more details)

* Install using Docker (more details https://hub.docker.com/r/baculaweb/bacula-web)

.. important:: Composer archive installation will be deprecated soon, more installation options will come at the same time
.. important:: Installation using the archive which used to be available on GitHub releases is not supported anymore due to several issues, such as conflicts
between different PHP versions used by community users.

Make sure your system meets the minimal requirements by checking the :ref:`requirement <install/requirements>` page

Expand Down
100 changes: 0 additions & 100 deletions docs/source/02_install/installarchive.rst

This file was deleted.

41 changes: 3 additions & 38 deletions docs/source/02_install/upgrade.rst
Expand Up @@ -24,44 +24,9 @@ Check the requirements

Ensure that you meet all system requirements (more information in the :ref:`install/requirements` page).

Upgrade from archive
====================

Steps below describe how to upgrade Bacula-Web if you've used the archive available on Bacula-Web web site

Empty the current folder
------------------------

On Centos / Fedora / RHEL

::

# rm -rfv /var/www/html/bacula-web/*
On Debian / Ubuntu

::

# rm -rfv /var/www/bacula-web


Now proceed with the upgrade by downloading the new archive (read the :ref:`install/installarchive` chapter)

Once you've downloaded latest Bacula-Web archive, copy Bacula-Web configuration file and users database into latest Bacula-Web folder

::

# cp -pv $HOME/config.php <bacula-web path>/application/config/
# cp -pv $HOME/application.db <bacula-web path>/application/assets/protected/

Using Composer
==============

Steps below describe how to upgrade Bacula-Web if you've used Composer installation method

Upgrade using Composer
----------------------

Please use steps described below to upgrade Bacula-Web to latest stable version using Composer

Move to Apache root folder
Expand All @@ -71,7 +36,7 @@ Move to Apache root folder
::

$ cd /var/www/html
$ sudo mv -v bacula-web bacula-web.beforeupgrade
$ sudo mv -v bacula-web bacula-web-beforeupgrade

.. note:: The path might need to be adapted depending on your setup

Expand All @@ -93,8 +58,8 @@ Copy configuration and users database to new Bacula-Web folder

::

$ sudo cp -pv bacula-web.beforeupgrade/application/config/config.php bacula-web/application/config/
$ sudo cp -pv bacula-web.beforeupgrade/application/assets/protected/* bacula-web/application/assets/protected/
$ sudo cp -pv bacula-web-beforeupgrade/application/config/config.php bacula-web/application/config/
$ sudo cp -pv bacula-web-beforeupgrade/application/assets/protected/* bacula-web/application/assets/protected/

Fix files ownership
===================
Expand Down
13 changes: 8 additions & 5 deletions docs/source/index.rst
Expand Up @@ -7,17 +7,20 @@
Welcome to Bacula-Web documentation
===================================

.. image:: _static/bacula-web-dashboard-crop.jpeg
:scale: 25 %
:width: 2555px
:height: 2906px
.. image:: _static/bacula-web-logo.png
:scale: 125%
:align: center
:alt: Bacula-Web dashboard
:alt: Bacula-Web logo

.. toctree::
:maxdepth: 2

01_about/index
02_install/index
02_install/requirements
02_install/configure
02_install/finalize
02_install/upgrade
02_install/test
03_get-help/index
04_contribute/index

0 comments on commit 0f1e59c

Please sign in to comment.