Skip to content

Fix broken links after testing #2333

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 7 commits into from
Jun 16, 2025
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
4 changes: 2 additions & 2 deletions models/hospital/access-control-old.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

When creating a database, administrators may want to establish which users have the ability to access certain information.

As described in xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
As described in xref:authentication-authorization/built-in-roles.adoc[Built-in roles], Neo4j already offers preset roles configured to specific permissions (i.e. read, edit, or write).
While these built-in roles cover many common daily scenarios, it is also possible to create custom roles for specific needs.

This page contains an example that illustrates various aspects of security and fine-grained access control.
Expand Down Expand Up @@ -85,7 +85,7 @@ This allows users to be created entirely within the database security model, a s
For more information, see link:{neo4j-docs-base-uri}/cypher-manual/current/access-control/[Cypher Manual -> Access control].

The following examples show two different approaches to using Neo4j security features to support the _healthcare_ database application.
The first approach uses xref:authentication-authorization/built-in-roles/auth-built-in-roles[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.
The first approach uses xref:authentication-authorization/built-in-roles.adoc[Built-in roles], whereas the second uses more advanced resources with fine-grained privileges for <<auth-access-control-using-privileges, sub-graph access control>>.

In this example, consider five users of the _healthcare_ database:

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/authentication-authorization/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For more information, see xref:authentication-authorization/password-and-user-re
When triggered, Neo4j logs an error containing a timestamp and the message `failed to log in: too many failed attempts` in the _security.log_.
====
+
For the relevant Cypher commands, see xref:authentication-authorization/manage-users.adoc#access-control-user-syntax[Manage users syntax], xref:authentication-authorization/manage-roles.adoc#access-control-role-syntax[Manage roles syntax], and xref:authentication-authorization/manage-privileges.adoc#access-control-privileges-syntax[Manage privileges syntax].
For the relevant Cypher commands, see xref:authentication-authorization/manage-users.adoc#access-control-user-syntax[Manage users syntax], xref:authentication-authorization/manage-roles.adoc#access-control-role-syntax[Manage roles syntax], and xref:authentication-authorization/manage-privileges.adoc[Manage privileges syntax].
Various scenarios that illustrate the use of the native auth provider are available in xref:tutorial/access-control.adoc[].

*User auth providers*::
Expand All @@ -47,7 +47,7 @@ The configuration steps are described in xref:authentication-authorization/sso-i
*Custom-built plugin auth providers*::
A plugin option for building custom integrations.
It is recommended that this option is used as part of a custom delivery as negotiated with link:https://neo4j.com/professional-services/[Neo4j Professional Services].
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins#extending-neo4j-security-plugins[Java Reference -> Authentication and authorization plugins].
For more information, see link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/security-plugins[Java Reference -> Authentication and authorization plugins].

*Kerberos authentication and single sign-on*::
In addition to LDAP, native, and custom providers, Neo4j supports Kerberos for authentication and single sign-on.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ this LDAP group will fail authentication, even if their credentials are correct.
|===

All settings are defined at server startup time in the default configuration file _xref:configuration/neo4j-conf.adoc[neo4j.conf]_ or can be modified at
runtime using xref:procedures.adoc#procedure_dbms_setconfigvalue[`dbms.setConfigValue()`].
runtime using xref:procedures.adoc#procedure_dbms_setConfigValue[`dbms.setConfigValue()`].


[[auth-ldap-configure-provider]]
Expand Down Expand Up @@ -470,7 +470,7 @@ SET AUTH 'ldap' { SET ID 'cn=alice,ou=sales,dc=example,dc=com' }
You can verify that your LDAP configuration is correct, and that the LDAP server responds, by using the LDAP command-line tool `ldapsearch`.

The `ldapsearch` command accepts the LDAP configuration setting values as input and verifies both the authentication (using the `simple` mechanism) and authorization of a user.
See the https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation^] for more advanced usage and how to use SASL authentication mechanisms.
See the link:https://docs.ldap.com/ldap-sdk/docs/tool-usages/ldapsearch.html[ldapsearch official documentation] for more advanced usage and how to use SASL authentication mechanisms.

. Verify the authentication and authorization of a user.
For example, `john`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The elevated privileges only apply within the procedure or user-defined function
--
The steps below assume that the procedure or user-defined function is already developed and installed.

Please refer to link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j#extending-neo4j[Java Reference -> Extending Neo4j] for a description of creating and using user-defined procedures and functions.
Please refer to link:{neo4j-docs-base-uri}/java-reference/{page-version}/extending-neo4j/[Java Reference -> Extending Neo4j] for a description of creating and using user-defined procedures and functions.
--


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ RETURN user AS adminUser
[[access-control-list-user-auth-providers]]
== Listing user auth providers

To inspect users' xref:authentication-authorization/auth-providers.adoc#access-control-list-user-auth-providers[auth providers], use `SHOW USERS WITH AUTH`.
To inspect available user auth providers, use `SHOW USERS WITH AUTH`.
The command produces a row per user per auth provider and yields the following two columns in addition to those output by `SHOW USERS`:

[options="header", width="100%", cols="1a,4,1m,^.^,^.^"]
Expand Down Expand Up @@ -745,6 +745,8 @@ WHERE provider = 'oidc1'

======

For more information about auth providers, see xref:authentication-authorization/auth-providers.adoc[User auth providers].

[[access-control-create-users]]
== Creating users

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ DENY DELETE ON GRAPH * RELATIONSHIPS bar TO regularUsers
[NOTE]
====
Users with `DELETE` privilege, but restricted `TRAVERSE` privileges, will not be able to do `DETACH DELETE` in all cases.
See href:tutorial/access-control.adoc#detach-delete-restricted-user[delete restricted user] for more info.
See xref:tutorial/access-control.adoc#detach-delete-restricted-user[delete restricted user] for more info.
====

[NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To specify the property/value conditions of the privilege, you can use the follo
----
{GRANT | DENY | REVOKE [GRANT | DENY]}
[IMMUTABLE]
{MATCH | READ | TRAVERSE}
{MATCH | READ | TRAVERSE}
ON { HOME GRAPH | GRAPH[S] { * | name[, ...] } }
[
ELEMENT[S] { * | label-or-rel-type[, ...] }
Expand All @@ -50,7 +50,7 @@ To specify the property/value conditions of the privilege, you can use the follo
WHERE [NOT] var.property { { = | <> | > | >= | < | <= } value | IS NULL | IS NOT NULL | IN { "["[value[, ...]]"]" | listParam } } "]"-[>]()
}
]
{TO | FROM} role[, ...]
{TO | FROM} role[, ...]
----


Expand Down Expand Up @@ -173,7 +173,7 @@ This is essential when revoking property-based privileges containing evaluated f

[NOTE]
====
Not all temporal values are comparable, see link:{neo4j-docs-base-uri}/cypher-manual/current/syntax/operators/#cypher-ordering[Cypher Manual -> Syntax -> Operators -> Ordering and comparison of values].
Not all temporal values are comparable, see link:{neo4j-docs-base-uri}/cypher-manual/current/values-and-types/ordering-equality-comparison[Cypher Manual -> Equality, ordering, and comparison of value types].
====

You can show the privilege created by the command in the previous example as a revoke command by running:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ dbms.security.authorization_providers=oidc-newsso,oidc-oldsso,native
. Check connectivity.
Neo4j needs to connect to the identity provider to discover settings and fetch public keys to verify tokens.
Check firewall settings and security controls, and, if necessary, logs to ensure that the Neo4j server is able to connect to the identity provider using HTTPS.
If a proxy is required, this can be https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html#Proxies[configured] in the Java virtual machine using the configuration setting xref:configuration/configuration-settings.adoc#config_server.jvm.additional[server.jvm.additional].
If a proxy is required, this can be link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/doc-files/net-properties.html#Proxies[configured] in the Java virtual machine using the configuration setting xref:configuration/configuration-settings.adoc#config_server.jvm.additional[server.jvm.additional].
Proxies that require credentials are not supported.

[[auth-sso-map-idp-roles]]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/backup-restore/consistency-checker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Value can be plain numbers, like `10000000` or e.g. `20G` for 20 gigabytes, or e

|--from-path-data=<path>
|Path to the databases directory, containing the database directory to source from.
| xref:configuration/configuration-settings.adoc#config_server.directories.data, [`server.directories.data`]/databases
| xref:configuration/configuration-settings.adoc#config_server.directories.data[`server.directories.data`]/databases

|--from-path-txn=<path>
|Path to the transactions directory, containing the transaction directory for the database to source from.
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c

[NOTE]
====
`neo4j-admin database backup` is not supported in https://neo4j.com/cloud/aura/[Neo4j Aura].
`neo4j-admin database backup` is not supported in link:https://neo4j.com/cloud/aura/[Neo4j Aura].
====

[[backup-command-syntax]]
Expand Down Expand Up @@ -465,9 +465,9 @@ bin/neo4j-admin database backup --to-path=azb://myStorageAccount/myContainer/myD
[[diff-backup-as-parent]]
=== Perform a differential backup using the `--prefer-diff-as-parent` option

By default, a differential backup (`--type=DIFF`) uses the *most recent non-empty* backup -- whether full or differential -- in the directory as its parent.
By default, a differential backup (`--type=DIFF`) uses the *most recent non-empty* backup -- whether full or differential -- in the directory as its parent.

The `--prefer-diff-as-parent` option changes this behavior and forces the backup job to use the *latest differential* backup as the parent, even if a newer full backup exists.
The `--prefer-diff-as-parent` option changes this behavior and forces the backup job to use the *latest differential* backup as the parent, even if a newer full backup exists.

This approach allows you to maintain a chain of differential backups for all transactions and restore to any point in time.
Without this option, the transactions between the last full backup and a previous differential backup cannot be backed up as individual transactions.
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/backup-restore/restore-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

A database backup artifact (full or differential) can be restored within the same or to a later Neo4j version using the `restore` command of `neo4j-admin`.

You can also load a **full** database backup artifact using the xref:backup-restore/restore-dump.adoc#restore-dump-command[`neo4j-admin database load`] command.
You can also load a **full** database backup artifact using the xref:backup-restore/restore-dump.adoc[`neo4j-admin database load`] command.
This functionality is available in the Community Edition.

[NOTE]
Expand All @@ -23,7 +23,7 @@ For more information, see xref:database-administration/standard-databases/create
[NOTE]
====
If you are using CDC, make sure you create the new database with the same `txLogEnrichment` value and handle the potential loss or corruption of CDC data in your CDC application.
For more information, see the link:{neo4j-docs-base-uri}/cdc/{page-version}[Change Data Capture (CDC)] documentation.
For more information, see the link:https://neo4j.com/docs/cdc/current/[Change Data Capture (CDC)] documentation.
====

[NOTE]
Expand Down
32 changes: 16 additions & 16 deletions modules/ROOT/pages/changes-deprecations-removals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,19 +69,19 @@ For more information, see xref:monitoring/logging.adoc#_default_logging_configur
| Community Edition
| Enterprise Edition

| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_movetonextdiscoveryversion[`dbms.cluster.moveToNextDiscoveryVersion()`]
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures.adoc#procedure_dbms_cluster_moveToNextDiscoveryVersion[`dbms.cluster.moveToNextDiscoveryVersion()`]
|
| {check-mark}

| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_showparalleldiscoverystate[`dbms.cluster.showParallelDiscoveryState()`]
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures.adoc#procedure_dbms_cluster_showParallelDiscoveryState[`dbms.cluster.showParallelDiscoveryState()`]
|
| {check-mark}

| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_switchdiscoveryserviceversion[`dbms.cluster.switchDiscoveryServiceVersion()`]
| link:{neo4j-docs-base-uri}/operations-manual/5/procedures.adoc#procedure_dbms_cluster_switchDiscoveryServiceVersion[`dbms.cluster.switchDiscoveryServiceVersion()`]
|
| {check-mark}

|link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_setDatabaseAllocator[`dbms.setDatabaseAllocator()`]
|link:{neo4j-docs-base-uri}/operations-manual/5/procedure_dbms_cluster_dbms.setDatabaseAllocator()[`dbms.setDatabaseAllocator()`]
|
|{check-mark}

Expand Down Expand Up @@ -401,64 +401,64 @@ Replaced by xref:procedures.adoc#procedure_dbms_recreateDatabase[`dbms.recreateD
Replaced by xref:procedures.adoc#procedure_dbms_unquarantineDatabase[`dbms.unquarantineDatabase()`]


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`]
| xref:procedures.adoc#procedure_dbms_cluster_uncordonServer[`dbms.cluster.uncordonServer()`]
|
| {check-mark}
| label:deprecated[Deprecated in 5.23]. +
Before Neo4j 5.23, the procedure can be run only with an admin privilege. +
Replaced by xref:clustering/server-syntax.adoc#server-management-syntax[`ENABLE SERVER`].


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_routing_getroutingtable[`dbms.cluster.routing.getRoutingTable()`]
| xref:procedures.adoc#procedure_dbms_cluster_routing_getRoutingTable[`dbms.cluster.routing.getRoutingTable()`]
| {check-mark}
| {check-mark}
| label:deprecated[Deprecated in 5.21]. +
Replaced by: xref:procedures.adoc#procedure_dbms_routing_getroutingtable[`dbms.routing.getRoutingTable()`].
Replaced by: xref:procedures.adoc#procedure_dbms_routing_getRoutingTable[`dbms.routing.getRoutingTable()`].


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_cdc_current[`cdc.current()`] label:beta[]
| xref:procedures.adoc#procedure_cdc_current[`cdc.current()`] label:beta[]
|
| {check-mark}
| label:deprecated[Deprecated in 5.17] +
Replaced by: xref:procedures.adoc#procedure_db_cdc_current[`db.cdc.current()`]

| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_cdc_earliest[`cdc.earliest()`] label:beta[]
| xref:procedures.adoc#procedure_cdc_earliest[`cdc.earliest()`] label:beta[]
|
| {check-mark}
| label:deprecated[Deprecated in 5.17] +
Replaced by: xref:procedures.adoc#procedure_db_cdc_earliest[`db.cdc.earliest()`]

| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_cdc_query[`cdc.query()`] label:beta[] label:admin-only[]
| xref:procedures.adoc#procedure_cdc_query[`cdc.query()`] label:beta[] label:admin-only[]
|
| {check-mark}
| label:deprecated[Deprecated in 5.17] +
Replaced by: xref:procedures.adoc#procedure_db_cdc_query[`db.cdc.query()`]


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_db_create_setVectorProperty[`db.create.setVectorProperty()`] label:beta[]
| xref:procedures.adoc#procedure_db_create_setVectorProperty[`db.create.setVectorProperty()`] label:beta[]
| {check-mark}
| {check-mark}
| label:deprecated[Deprecated in 5.13] +
Replaced by: xref:procedures.adoc#procedure_db_create_setNodeVectorProperty[`db.create.setNodeVectorProperty()`]


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_upgrade[`dbms.upgrade()`] label:admin-only[]
| xref:procedures.adoc#procedure_dbms_upgrade[`dbms.upgrade()`] label:admin-only[]
| {check-mark}
| {check-mark}
| label:deprecated[Deprecated in 5.9]


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_upgradestatus[`dbms.upgradeStatus()`] label:admin-only[]
| xref:procedures.adoc#procedure_dbms_upgradeStatus[`dbms.upgradeStatus()`] label:admin-only[]
| {check-mark}
| {check-mark}
| label:deprecated[Deprecated in 5.9]


| link:{neo4j-docs-base-uri}/operations-manual/5/procedures/#procedure_dbms_cluster_readreplicatoggle[`dbms.cluster.readReplicaToggle()`] label:admin-only[]
| xref:procedures.adoc#procedure_dbms_cluster_readReplicaToggle[`dbms.cluster.readReplicaToggle()`] label:admin-only[]
|
| {check-mark}
| label:deprecated[Deprecated in 5.6] +
Replaced by: xref:procedures.adoc#procedure_dbms_cluster_secondaryreplicationdisable[`dbms.cluster.secondaryReplicationDisable()`].
Replaced by: xref:procedures.adoc#procedure_dbms_cluster_secondaryReplicationDisable[`dbms.cluster.secondaryReplicationDisable()`].
|===
====

Expand All @@ -475,7 +475,7 @@ Replaced by: xref:procedures.adoc#procedure_dbms_cluster_secondaryreplicationdis
| Comment

| xref:configuration/configuration-settings.adoc#config_dbms.routing.load_balancing.plugin[`dbms.routing.load_balancing.plugin`]
|
|
| {check-mark}
| label:deprecated[Deprecated in 2025.05]

Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/cloud-deployments/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@ Neo4j's cloud marketplace listings represent a quick and easy way of getting sta

| Amazon Web Services
| xref:cloud-deployments/neo4j-aws.adoc[Neo4j on AWS]
| https://neo4j.com/partners/amazon/[Neo4j in the AWS Marketplace^]
| link:https://neo4j.com/partners/amazon/[Neo4j in the AWS Marketplace]

| Google Cloud
| Google Cloud
| xref:cloud-deployments/neo4j-gcp.adoc[Neo4j on Google Cloud Platform]
| https://neo4j.com/partners/google/[Neo4j in the GCP Marketplace^]
| link:https://neo4j.com/partners/google/[Neo4j in the GCP Marketplace]

| Microsoft Azure
| xref:cloud-deployments/neo4j-azure.adoc[Neo4j on Microsoft Azure]
| https://neo4j.com/partners/microsoft/[Neo4j in the Azure Marketplace^]
| link:https://neo4j.com/partners/microsoft/[Neo4j in the Azure Marketplace]

|===

.Other cloud deployment options
[TIP]
====
*Neo4j Aura* is a fully managed Neo4j database, hosted in the cloud and requires no installation.
For more information, see https://neo4j.com/aura/[the Aura product^], https://aura.support.neo4j.com/[support pages^], and the https://www.neo4j.com/docs/aura[Aura documentationˆ].
For more information, see link:https://neo4j.com/aura/[the Aura product], link:https://aura.support.neo4j.com/[support pages], and the link:https://www.neo4j.com/docs/aura[Aura documentation].

//Neo4j can be run in a *Docker* container.
//For information on running Neo4j on Docker, see xref:docker/index.adoc[Docker].
Expand Down
Loading