Skip to content

Commit

Permalink
Merge pull request #31 from neo4j-labs/2.0
Browse files Browse the repository at this point in the history
Update dev to latest main
  • Loading branch information
msenechal authored Nov 25, 2024
2 parents 0b893b1 + 3090135 commit d268c9b
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions docs/modules/ROOT/pages/Components/ConnectionModal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,37 @@ https://needle-starterkit.graphapp.io/connection-modal-preview[Link to the live
https://github.com/neo4j-labs/neo4j-needle-starterkit/blob/2.0/src/templates/shared/components/ConnectionModal.tsx[Link to the component code,window=_blank]
The connection modal also comes with a dropzone for the user to upload a file containing the connection details. The file can be either an Aura credential file you downloaded when creating an instance, or your own file containing the connection details.
The accepted file format are either `.env` or `.txt` file with the following structure:
[cols="1,2,1"]
|===
| Name | Description | Example
| `NEO4J_URI`
| The URI of the Neo4j database. Ideally you would have the protocol, hostname and port, but all are optional and will be defaulted if not present.
| neo4j+s://abcd1234.databases.neo4j.io:7687
| `NEO4J_USERNAME`
| Your neo4j username
| neo4j
| `NEO4J_PASSWORD`
| Your neo4j password
| password
| `NEO4J_DATABASE`
| The database name
| neo4j
|===
Example of a `local.env` file:
[source,env]
----
NEO4J_URI=neo4j://localhost:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=password
NEO4J_DATABASE=neo4j
----
== Pre-requisite
- Ensure you have the `@neo4j-ndl` library installed in your project to use this `ConnectionModal` component.
Expand Down

0 comments on commit d268c9b

Please sign in to comment.