Skip to content

box.cfg: add the 'Traffic encryption' section #4009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 22, 2024
Merged

Conversation

andreyaksenov
Copy link
Contributor

@andreyaksenov andreyaksenov commented Jan 22, 2024

Staging:

  1. Moved Traffic encryption to the Configuration in code topic (almost as is, fixed a couple of issues and updated anchors):
    https://docs.d.tarantool.io/en/doc/box-cfg-ssl-params/concepts/configuration/configuration_code/#traffic-encryption

    Note that the old Traffic encryption section will be removed from the Security hardening guide in another PR (Connection settings #3985, step 3).

  2. Made Since version and Dynamic: yes fields look consistent across the entire reference:
    https://docs.d.tarantool.io/en/doc/box-cfg-ssl-params/reference/configuration/

@andreyaksenov andreyaksenov linked an issue Jan 22, 2024 that may be closed by this pull request
8 tasks
@andreyaksenov andreyaksenov marked this pull request as ready for review January 22, 2024 08:33
@andreyaksenov andreyaksenov requested a review from xuniq January 22, 2024 08:34
~~~~~~~~~~~~~

To configure traffic encryption, you need to set the special :ref:`URI parameters <index-uri-several-params>` for a particular connection.
The parameters can be set for the following ``box.cfg`` options and ``nex.box`` method:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The parameters can be set for the following ``box.cfg`` options and ``nex.box`` method:
The parameters can be set for the following ``box.cfg`` options and ``net.box`` method:


* :ref:`box.cfg.listen <cfg_basic-listen>` -- on the server side.
* :ref:`box.cfg.replication <cfg_replication-replication>`--on the client side.
* :ref:`net_box_object.connect() <net_box-connect>`--on the client side.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`net_box_object.connect() <net_box-connect>`--on the client side.
* :ref:`net_box_object.connect() <net_box-connect>` -- on the client side.

The parameters can be set for the following ``box.cfg`` options and ``nex.box`` method:

* :ref:`box.cfg.listen <cfg_basic-listen>` -- on the server side.
* :ref:`box.cfg.replication <cfg_replication-replication>`--on the client side.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* :ref:`box.cfg.replication <cfg_replication-replication>`--on the client side.
* :ref:`box.cfg.replication <cfg_replication-replication>` -- on the client side.

@andreyaksenov andreyaksenov merged commit e98d56a into latest Jan 22, 2024
@andreyaksenov andreyaksenov deleted the box-cfg-ssl-params branch January 22, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Enterprise box.cfg options and options introduced in 3.0
2 participants