Skip to content

Conversation

renetapopova
Copy link
Collaborator

No description provided.

@renetapopova renetapopova requested review from rhysemmas and thelonelyvulpes and removed request for rhysemmas September 24, 2025 16:27
@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-operations-2610.surge.sh

Updated pages:

=== Configure the backup client for SSL
When using `neo4j-admin backup` command, you need to specify the SSL policy to be used by the backup client.
Copy link

@thelonelyvulpes thelonelyvulpes Sep 25, 2025

Choose a reason for hiding this comment

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

I think this doesn't make it entirely clear that you can back up against the cluster endpoint(6000 default) and its SSL policy dbms.ssl.policy.cluster.*, or the backup endpoint(6362 default) and its SSL policy dbms.ssl.policy.backup.*, but regardless of which you do back up against, the admin client will use the SSL policy specified for backups dbms.ssl.policy.backup.*

=== Configure the backup client for SSL
When using `neo4j-admin backup` command, you need to specify the SSL policy to be used by the backup client.
You can do this by setting a matching SSL configuration in the _neo4j.conf_ and _neo4j-admin.conf_ files.
Copy link

@thelonelyvulpes thelonelyvulpes Sep 25, 2025

Choose a reason for hiding this comment

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

It is not entirely true that they must match, but be sympathetic of/mirror one another.
i.e., if they want mutualTLS with self-signed certificates, the server must have the client's certificate in its trusted_dir, and the client must have the server's certificate in its trusted_dir

Choose a reason for hiding this comment

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

However, when they use a certificate authority to signs both the client's and server's certificates, the trusted_dir only needs to contain an intermediate CA cert.

dbms.ssl.policy.backup.client_auth=REQUIRE
----
=== Configure the backup client for SSL
Copy link

@thelonelyvulpes thelonelyvulpes Sep 25, 2025

Choose a reason for hiding this comment

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

bit of a meta comment, but it might be worth including in the documentation, we do not the validate the keys of ssl policy values so
dbms.ssl.policy.backup.foo will parse happily but will not help, so it is important that users validate the config keys when configuring SSL, dbms.ssl.policy.backup.trusted_directory got me as it must be dbms.ssl.policy.backup.trusted_dir which is inconsistent with *.base_directory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants