Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,43 +1,37 @@
Now, install the DB-related packages

.. tab-set::

.. tab-item:: Ubuntu 22.04
:sync: ubu22

.. code:: console

# apt install carbonio-ws-collaboration-db \
carbonio-tasks-db carbonio-docs-connector-db \
carbonio-message-dispatcher-db \
# apt install carbonio-tasks-db carbonio-docs-connector-db \
carbonio-ws-collaboration-db carbonio-message-dispatcher-db \
carbonio-notification-push-db

.. tab-item:: Ubuntu 24.04
:sync: ubu24

.. code:: console

# apt install carbonio-ws-collaboration-db \
carbonio-tasks-db carbonio-docs-connector-db \
carbonio-message-dispatcher-db \
# apt install carbonio-tasks-db carbonio-docs-connector-db \
carbonio-ws-collaboration-db carbonio-message-dispatcher-db \
carbonio-notification-push-db

.. tab-item:: RHEL 8
:sync: rhel8

.. code:: console

# dnf install carbonio-ws-collaboration-db \
carbonio-tasks-db carbonio-docs-connector-db \
carbonio-message-dispatcher-db \
# dnf install carbonio-tasks-db carbonio-docs-connector-db \
carbonio-ws-collaboration-db carbonio-message-dispatcher-db \
carbonio-notification-push-db

.. tab-item:: RHEL 9
:sync: rhel9

.. code:: console

# dnf install carbonio-ws-collaboration-db \
carbonio-tasks-db carbonio-docs-connector-db \
carbonio-message-dispatcher-db \
# dnf install carbonio-tasks-db carbonio-docs-connector-db \
carbonio-ws-collaboration-db carbonio-message-dispatcher-db \
carbonio-notification-push-db
20 changes: 12 additions & 8 deletions source/carbonio/architecture/components/component-chats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,22 @@ into account the following points:
* There is a *Preparation* phase that requires to install some package
on other Nodes before starting the |wsc| installation.

#. Install the database components on the **Database Node**: please
follow the instructions to Section :ref:`connectors-wsc-db-install`
remembering to bootstrap the Message Dispatcher and the |wsc| databases

#. Install package :file:`carbonio-ws-collaboration-ui` on the
#. DB connectors (packages ``carbonio-ws-collaboration-db``,
``carbonio-message-dispatcher-db``, and
``carbonio-notification-push-db``) on the
:ref:`component-db-install` Node: please follow the instructions
in Section :ref:`other-db-conn-install`, then execute the
:ref:`comp-db-ps`, and :ref:`initialise the databases
<chats-db-bootstrap>`

#. Package :file:`carbonio-ws-collaboration-ui` on the
:ref:`component-proxy-install` Node

#. Install package :file:`carbonio-message-broker` on the
#. Package :file:`carbonio-message-broker` on the
:ref:`component-mesh-install` Node

#. Install the :ref:`component-vs-wsc-install` Component on any
Node, even better if on a dedicated one
#. The :ref:`component-vs-wsc-install` Component on any Node, even
better if on a dedicated one

Now, depending on how you plan to install |wsc|, the procedure
slightly changes.
Expand Down
52 changes: 33 additions & 19 deletions source/carbonio/architecture/components/component-db.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Installation of PostgreSQL

.. include:: /_includes/_installation/pg.rst

Installation of other DB Components
-----------------------------------
Installation of Mailbox DB Component
------------------------------------

The following database components need to be installed to ensure
The following database component needs to be installed to ensure
proper working of |product|

.. tab-set::
Expand All @@ -23,8 +23,7 @@ proper working of |product|

.. code:: console

# apt install carbonio-files-db carbonio-mailbox-db \
carbonio-docs-connector-db carbonio-tasks-db
# apt install carbonio-mailbox-db \

.. tab-item:: RHEL
:sync: rhel
Expand All @@ -34,14 +33,17 @@ proper working of |product|
# dnf install carbonio-files-db carbonio-mailbox-db \
carbonio-docs-connector-db carbonio-tasks-db

.. _connectors-wsc-db-install:
.. _other-db-conn-install:

Database Components of |wsc|
----------------------------
Installation of Other DB Components
-----------------------------------

If you plan to install the :ref:`component-wsc-install` Component, you need to
install the following packages, which constitute the DB portion of
that Component, then follow the instructions to complete its installation
If you plan to install one or more of the |docs|, |file|, |task|, or
|wsc| Components, you need to install the corresponding "``-db``"
packages, which constitute the DB portion of that Component, then
follow the instructions to complete its installation. Remember also to
initialise the DB by executing the corresponding :ref:`bootstrap
command <dbs-bootstrap>`.

.. tab-set::

Expand All @@ -50,32 +52,44 @@ that Component, then follow the instructions to complete its installation

.. code:: console

# apt install carbonio-ws-collaboration-db \
carbonio-message-dispatcher-db carbonio-notification-push-db
# apt install carbonio-docs-connector-db carbonio-tasks-db \
carbonio-files-db carbonio-ws-collaboration-db \
carbonio-message-dispatcher-db \
carbonio-notification-push-db

.. tab-item:: RHEL
:sync: rhel

.. code:: console

# dnf install carbonio-ws-collaboration-db \
carbonio-message-dispatcher-db carbonio-notification-push-db
# dnf install carbonio-docs-connector-db carbonio-tasks-db \
carbonio-files-db carbonio-ws-collaboration-db \
carbonio-message-dispatcher-db \
carbonio-notification-push-db

Pending setups
.. _comp-db-ps:

Pending Setups
--------------

.. include:: /_includes/_installation/pset.rst

.. _dbs-bootstrap:

Bootstrap Databases
-------------------

You can use the password of the Postgres user ``carbonio_adm`` that
you defined during the *Database* Component's installation, or of any
other administrator user created previously.
other administrator user created previously. Only the first bootstrap
command (the one for the Mailbox) is mandatory, the other are required
only if you install the Component.

.. include:: /_includes/_installation/_steps/db-bootstrap.rst

If you plan to install also the :ref:`component-wsc-install`, execute also
the following commands.
.. _chats-db-bootstrap:

The :ref:`component-wsc-install` components requires three bootstrap
commands to be executed:

.. include:: /_includes/_installation/_steps/db-bootstrap-chats.rst
12 changes: 12 additions & 0 deletions source/carbonio/architecture/components/component-docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ Install Packages
.. include:: /_includes/_installation/warningservicediscoveragent.rst
.. include:: /_includes/_installation/_packages/component-docs.rst

.. dropdown:: On the Database Node
:color: danger
:class-title: sd-bg-danger
:open:

Additionally, go to the Node which features the
:ref:`component-db-install` Component and make sure that the
corresponding :ref:`DB connector <other-db-conn-install>` package
(``carbonio-docs-connector-db``) is installed. If not, install it,
then execute the :ref:`comp-db-ps` and :ref:`initialise the
database <dbs-bootstrap>`.

Bootstrap |carbonio|
--------------------

Expand Down
12 changes: 12 additions & 0 deletions source/carbonio/architecture/components/component-files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ Install Packages
.. include:: /_includes/_installation/warningservicediscoveragent.rst
.. include:: /_includes/_installation/_packages/component-files.rst

.. dropdown:: On the Database Node
:color: danger
:class-title: sd-bg-danger
:open:

Additionally, go to the Node which features the
:ref:`component-db-install` Component and make sure that the
corresponding :ref:`DB connector <other-db-conn-install>` package
(``carbonio-files-db``) is installed. If not, install it, then
execute the :ref:`comp-db-ps` and :ref:`initialise the database
<dbs-bootstrap>`.

Bootstrap |carbonio|
--------------------

Expand Down
13 changes: 13 additions & 0 deletions source/carbonio/architecture/components/component-tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ Install Packages
.. include:: /_includes/_installation/warningservicediscoveragent.rst
.. include:: /_includes/_installation/_packages/component-tasks.rst

.. dropdown:: On the Database Node
:color: danger
:class-title: sd-bg-danger
:open:

Additionally, go to the Node which features the
:ref:`component-db-install` Component and make sure that the
corresponding :ref:`DB connector <other-db-conn-install>` package
(``carbonio-tasks-db``) is installed. If not, install it, then
execute the :ref:`comp-db-ps` and :ref:`initialise the database
<dbs-bootstrap>`.


Bootstrap |carbonio|
====================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,20 @@ of them to expand the content.
carbonio-docs-connector postgresql16 \
carbonio-push-connector carbonio-notification-push

.. dropdown:: Step 4: Package installation on **Core Node**
.. dropdown:: Step 4: Tasks to carry out on the **Core Node**
:color: danger
:class-title: sd-bg-danger

Login to the *Core Node* and install the following packages.
These task are required only if you plan to install the
corresponding Component.

.. hint:: All the commands in this step **must be executed** on the
Core Node as the |ru|.

.. rubric:: Install user interface packages

These packages provide the Graphic User Interface for |wsc| and
|task|.

.. tab-set::

Expand Down Expand Up @@ -161,6 +170,33 @@ of them to expand the content.
# apt install carbonio-ws-collaboration-ui \
carbonio-tasks-ui


.. rubric:: Install DB connectors packages

These packages provide access to the Database to |task|, |docs|, and |wsc|.

.. include:: /_includes/_installation/step-package-install-single-collaboration-node-cb.rst

.. rubric:: Register DB connectors to |mesh|

.. include:: /_includes/_installation/pset.rst

.. rubric:: Bootstrap Databases

Execute the following commands to initialise the
databases. Remember to use the password |dbadmpwd| password set in
the *Initialisation* in :ref:`Step 4 <n1-s4>` of Core Node's
installation.

.. code:: console

# PGPASSWORD=$DB_ADM_PWD carbonio-docs-connector-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-tasks-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-message-dispatcher-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-ws-collaboration-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-notification-push-db-bootstrap carbonio_adm 127.0.0.1


.. dropdown:: Step 5: Bootstrap |product|

To carry out this step, you need the **LDAP password** and the
Expand Down
16 changes: 2 additions & 14 deletions source/carbonio/install/scenarios/single/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ repositories.
.. dropdown:: Step 3: System Upgrade and Package Installation

.. include:: /_includes/_installation/step-package-install-single-cb.rst
.. include:: /_includes/_installation/step-package-install-single-collaboration-node-cb.rst

.. _n1-s4:

Expand Down Expand Up @@ -147,25 +146,14 @@ repositories.

.. dropdown:: Step 8: Databases Bootstrap

Now you have to bootstrap some DBs with the password set in the Preliminary Tasks.
Now you have to bootstrap the DBs with the |dbadmpwd| password set
in the *Initialisation* in :ref:`Step 4 <n1-s4>`.

.. code:: console

# PGPASSWORD=$DB_ADM_PWD carbonio-mailbox-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-files-db-bootstrap carbonio_adm 127.0.0.1

If you plan to install also the Collaboration Node, you need to
bootstrap also the following databases

.. code:: console

# PGPASSWORD=$DB_ADM_PWD carbonio-docs-connector-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-tasks-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-message-dispatcher-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-ws-collaboration-db-bootstrap carbonio_adm 127.0.0.1
# PGPASSWORD=$DB_ADM_PWD carbonio-notification-push-db-bootstrap carbonio_adm 127.0.0.1


.. _n1-s9:

.. dropdown:: Step 9: Complete Installation
Expand Down