Skip to content

updated security docs - https connection method #708

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

Open
wants to merge 32 commits into
base: console
Choose a base branch
from

Conversation

fiquick
Copy link
Collaborator

@fiquick fiquick commented May 28, 2025

No description provided.

fiquick and others added 28 commits May 22, 2025 16:07
@fiquick fiquick changed the title user tools testing updated security docs - https connection method May 28, 2025
Copy link
Collaborator

@AlexicaWright AlexicaWright left a comment

Choose a reason for hiding this comment

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

Nice work! I did like the tabs, but as long as the information is there. Some comments and suggestions.

* Connections using private endpoints are one-way.
Aura VPCs can't initiate connections back to your VPCs.
* In AWS region us-east-1, we do not support the Availability Zone with ID use1-az3 for private endpoints.
* Private endpoints apply to all instances in the region.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't think this should be an admonition, a regular bullet list is sufficient since in essence it is a summary.

When public traffic is disabled, Query and Bloom are not accessible via the public internet.
To continue accessing these tools, xref:getting-started/connect-instance.adoc#_connection_method[connect via HTTPS (port 443)], this is helpful when network security blocks Bolt (port 7687), e.g. when a private link is set up on the database with public traffic disabled.
Alternatively you can set up a VPN (Virtual Private Network) in your VPC and connect to Query and Explore over the VPN.

== Private endpoints

Private endpoints are network interfaces inside your own VPC, which can only be accessed within your private network.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are private endpoints available for all plans now?


To continue accessing Browser and Bloom, you can configure a VPN (Virtual Private Network) in your VPC and connect to Browser and Bloom over the VPN.
For a step-by-step guide, see the link:https://neo4j.com/blog/auradb/neo4j-aws-privatelink-configuration/#2[How to Configure Neo4j Aura With AWS PrivateLink] blog article.
Copy link
Collaborator

Choose a reason for hiding this comment

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

As mentioned before, not a fan of linking to blog posts in the docs. If the content there is important, let's find a place for it in the docs. Add it as a tutorial maybe? The concern is that we (the docs team) have no control over its content.


image::azure_privatelink_03_browser_bloom_over_vpn.png["Accessing Browser and Bloom over a VPN", title="Accessing Browser and Bloom over a VPN"]
.Accessing tools over a VPN
image::azure_privatelink_03_browser_bloom_over_vpn.png["Accessing tools over a VPN"]

==== Enable Azure Private Endpoints for Aura
Copy link
Collaborator

Choose a reason for hiding this comment

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

We need to provide the corresponding instructions for AWS and GCP as well.


To continue accessing Browser and Bloom, you can configure a VPN (Virtual Private Network) in your VPC and connect to Browser and Bloom over the VPN.
For a step-by-step guide, see the link:https://neo4j.com/blog/auradb/neo4j-aws-privatelink-configuration/#2[How to Configure Neo4j Aura With AWS PrivateLink] blog article.
Refer to link:https://aws.amazon.com/privatelink[AWS PrivateLink] docs for IAM requirements.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This piece of information seems to have gone missing:
All applications running Neo4j workloads inside the VPC are routed directly to your isolated environment in Aura without traversing the public internet. You can then disable public traffic, ensuring all traffic to the instance remains private to your VPC.

@neo4j-docops-agent
Copy link
Collaborator

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

Updated pages:

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.

3 participants