Skip to content

Commit 20f197c

Browse files
committed
Move database connection info to getting-started
1 parent 160df07 commit 20f197c

File tree

4 files changed

+87
-75
lines changed

4 files changed

+87
-75
lines changed

additionaldocs/getting-started/README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
# Getting Started
22

3-
This project contains the code needed to create a Docker image of the Graph
4-
Explorer. The image will create the Graph Explorer application and proxy server
5-
that will be served over the standard HTTP or HTTPS ports (HTTPS by default).
3+
This section helps new users install and configure Graph Explorer for the first
4+
time.
65

7-
The proxy server will be created automatically, but will only be necessary if
8-
you are connecting to Neptune. Gremlin-Server and BlazeGraph can be connected to
9-
directly. Additionally, the image will create a self-signed certificate that can
10-
be optionally used.
6+
## Files in this section
117

12-
## Examples
8+
1. [First Connection](first-connection.md) - Connecting to your first database
9+
10+
## Prerequisites
11+
12+
- Graph Explorer installed and running (see [Deployment](../deployment/) guides)
13+
- Access to a graph database endpoint
14+
- Basic familiarity with graph databases
15+
16+
## Quick Start Steps
17+
18+
1. **Deploy Graph Explorer** - Choose a deployment method from the
19+
[Deployment](../deployment/) section
20+
2. **Configure your database** - Follow the
21+
[First Connection](first-connection.md) guide for your database type
22+
3. **Create a connection** - Use the
23+
[Connections UI](../user-guide/connections.md) to set up your connection
24+
4. **Start exploring** - Begin using Graph Explorer with the
25+
[User Guide](../user-guide/)
1326

1427
## Troubleshooting
1528

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# First Connection
2+
3+
This guide contains detailed instructions that help when configuring Graph
4+
Explorer with different graph database engines for the first time. After setting
5+
up your database, see the [Connections UI](../user-guide/connections.md) guide
6+
to learn how to create and manage connections within Graph Explorer.
7+
8+
## Connecting to Neptune
9+
10+
- Ensure that Graph Explorer has access to the Neptune instance by being in the
11+
same VPC or VPC peering.
12+
- If authentication is enabled, read query privileges are needed (See
13+
[ReadDataViaQuery managed policy](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-access-examples.html#iam-auth-data-policy-example-read-query)).
14+
15+
## Connecting to Gremlin-Server
16+
17+
If you are using the default Gremlin Server docker image, you can get the server
18+
running with the following commands:
19+
20+
```
21+
docker pull tinkerpop/gremlin-server:latest
22+
docker run -p 8182:8182 \
23+
tinkerpop/gremlin-server:latest \
24+
conf/gremlin-server-rest-modern.yaml
25+
```
26+
27+
### Enable REST
28+
29+
Graph Explorer only supports HTTP(S) connections. When connecting to
30+
Gremlin-Server, ensure it is configured with a channelizer that supports HTTP(S)
31+
(i.e.
32+
[Channelizer Documentation](https://tinkerpop.apache.org/javadocs/current/full/org/apache/tinkerpop/gremlin/server/Channelizer.html)).
33+
34+
<!-- prettier-ignore -->
35+
> [!TIP]
36+
> The Gremlin Server configuration can be usually found at:
37+
>
38+
> ```
39+
> /conf/gremlin-server.yaml
40+
> ```
41+
42+
### Versions Prior to 3.7
43+
44+
If you have a version of Gremlin Server prior to 3.7, you will need to make the
45+
following changes:
46+
47+
- **Enable property returns** - Remove
48+
".withStrategies(ReferenceElementStrategy)" from
49+
`/scripts/generate-modern.groovy` so that properties are returned.
50+
- **Enable string IDs** - Change `gremlin.tinkergraph.vertexIdManager` and
51+
`gremlin.tinkergraph.edgeIdManager` in `/conf/tinkergraph-empty.properties` to
52+
support string ids. You can use `ANY`.
53+
- Build and run the Docker container as normal.
54+
55+
## Connecting to BlazeGraph
56+
57+
- Build and run the Docker container as normal and connect the proxy-server to
58+
BlazeGraph and your workbench to the proxy-server.
59+
- If using Docker, ensure that the container running the workbench can properly
60+
access the container running BlazeGraph. You can find documentation on how to
61+
connect containers via [Docker networks](https://docs.docker.com/network/).

additionaldocs/user-guide/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ features and connect to different graph databases.
55

66
## Files in this section
77

8-
1. [Connections](connections.md) - Database configuration and connection
9-
management
8+
1. [Connections](connections.md) - Managing database connections in the UI
109
2. [Settings](settings.md) - Application settings and configuration management
1110
3. [Graph Explorer](graph-explorer.md) - Main graph visualization interface
1211
4. [Table View](table-view.md) - Tabular data view and export functionality

additionaldocs/user-guide/connections.md

Lines changed: 4 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,8 @@
1-
# Connections
1+
# Connections UI
22

3-
This guide covers both how to configure Graph Explorer with different graph
4-
database engines and how to manage connections within the application.
5-
6-
## Database Configuration
7-
8-
This section contains detailed instructions that help when configuring Graph
9-
Explorer with different graph database engines.
10-
11-
### Connecting to Neptune
12-
13-
- Ensure that Graph Explorer has access to the Neptune instance by being in the
14-
same VPC or VPC peering.
15-
- If authentication is enabled, read query privileges are needed (See
16-
[ReadDataViaQuery managed policy](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-access-examples.html#iam-auth-data-policy-example-read-query)).
17-
18-
### Connecting to Gremlin-Server
19-
20-
If you are using the default Gremlin Server docker image, you can get the server
21-
running with the following commands:
22-
23-
```
24-
docker pull tinkerpop/gremlin-server:latest
25-
docker run -p 8182:8182 \
26-
tinkerpop/gremlin-server:latest \
27-
conf/gremlin-server-rest-modern.yaml
28-
```
29-
30-
#### Enable REST
31-
32-
Graph Explorer only supports HTTP(S) connections. When connecting to
33-
Gremlin-Server, ensure it is configured with a channelizer that supports HTTP(S)
34-
(i.e.
35-
[Channelizer Documentation](https://tinkerpop.apache.org/javadocs/current/full/org/apache/tinkerpop/gremlin/server/Channelizer.html)).
36-
37-
<!-- prettier-ignore -->
38-
> [!TIP]
39-
> The Gremlin Server configuration can be usually found at:
40-
>
41-
> ```
42-
> /conf/gremlin-server.yaml
43-
> ```
44-
45-
#### Versions Prior to 3.7
46-
47-
If you have a version of Gremlin Server prior to 3.7, you will need to make the
48-
following changes:
49-
50-
- **Enable property returns** - Remove
51-
".withStrategies(ReferenceElementStrategy)" from
52-
`/scripts/generate-modern.groovy` so that properties are returned.
53-
- **Enable string IDs** - Change `gremlin.tinkergraph.vertexIdManager` and
54-
`gremlin.tinkergraph.edgeIdManager` in `/conf/tinkergraph-empty.properties` to
55-
support string ids. You can use `ANY`.
56-
- Build and run the Docker container as normal.
57-
58-
### Connecting to BlazeGraph
59-
60-
- Build and run the Docker container as normal and connect the proxy-server to
61-
BlazeGraph and your workbench to the proxy-server.
62-
- If using Docker, ensure that the container running the workbench can properly
63-
access the container running BlazeGraph. You can find documentation on how to
64-
connect containers via [Docker networks](https://docs.docker.com/network/).
65-
66-
## Connections UI
3+
This guide covers how to manage connections within the Graph Explorer
4+
application. For information on configuring different graph database engines,
5+
see the [First Connection](../getting-started/first-connection.md) guide.
676

687
You can create and manage connections to graph databases using this feature.
698
Connections is accessible as the first screen after deploying the application,

0 commit comments

Comments
 (0)