IT4Change/Ocelot-Social
3
0
Fork 0
mirror of https://github.com/IT4Change/Ocelot-Social.git synced 2025-12-13 07:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Filled in the instr. to Download, Seed … of Neo4j

Browse Source
This commit is contained in:
Wolfgang Huß 2019-01-21 18:19:34 +01:00 committed by GitHub
parent 4e0581bd17
commit 663a495b4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 96 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
backend/installation/configuration.md Normal file
View File

@ -0,0 +1,96 @@
# Neo4j Installation and Configuration
## Configure Enviroment
Set your Neo4j connection string and credentials in `.env`. For example:
{% code-tabs %}
{% code-tabs-item title=".env" %}
```yaml
NEO4J_URI=bolt://localhost:7687
NEO4J_USER=neo4j
NEO4J_PASSWORD=letmein
```
{% endcode-tabs-item %}
{% endcode-tabs %}
## Neo4j Installation
{% hint style="warning" %}
You **need to install APOC** as a plugin for the graph you create in the neo4j desktop app!
{% endhint %}
Note that grand-stack-starter does not currently bundle a distribution of Neo4j.
{% tabs %}
{% tab title="Neo4j Desktop" %}
You can download [Neo4j Desktop](https://neo4j.com/download-center/) run locally for development.
Chose tab **Neo4j Desktop**.
![Neo4j Download-Center screenshot](../../.gitbook/assets/screenshot-neo4j-download-center-current-releases.png)
After the download is done install the Neo4j Desktop application and open it.
E.g. we have the following version:
```
Neo4j Desktop 1.1.13
```
Click on the empty project **My Project** to chose it.
Click in the **Add Graph** area and after two buttons appear in it on **Create a Local Graph**.
Set the name of the new Graph for clarity to **Human Connection DB**, though the name is free.
And set the password to **letmein** (means: "let me in"). Than click on **Create** and the database will be generated.
After generation of the database was successful, please click in the **Add Plugin** area.
And than click the **Install** button of the **APOC** area.
Now an additional **Install** button appears and you click on it again. If the APOC-Plugin is installed by now close the litte **Plugins** window.
In the **Human Connection DB** area is a **Manage** button. By clicking it the area switches into a manage area with a lot of information and setting possibilities.
Start the Graph database by clicking the **Play-Symbol** button and its start up will be proceeded.
In the **Logs** tab you'll find the status of the start up.
If you have a look in the **Details** tab you find the connection info. As you hopefully see the Bolt port is set by default to the number we set already for our [enviroment configuration](#configure-enviroment) above.
{% endtab %}
{% tab title="Neo4j Non-Desktop Alternatives" %}
You can spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download-center/), run Neo4j in one of the [many cloud options](https://neo4j.com/developer/guide-cloud-deployment/), [spin up Neo4j in a Docker container](https://neo4j.com/developer/docker/) or on Debian-based systems install [Neo4j from the Debian Repository ](http://debian.neo4j.org/). Just be sure to update the Neo4j connection string and credentials accordingly in `.env`.
**Install APOC plugin on Debian-based systems**
When you have install Neo4j from the Debian Repository, then download the [APOC plugin](https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.4.0.3/apoc-3.4.0.3-all.jar) to the `/var/lib/neo4j/plugins` directory manually or with:
```text
wget https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.4.0.3/apoc-3.4.0.3-all.jar -P /var/lib/neo4j/plugins
```
{% endtab %}
{% endtabs %}
## Seeding Database with Data
Yet we have to seed or database with default data, so that GraphQL requests or playing with our GraphQL Playground makes sense.
To fill the database with Nitro-Backend default data send the command:
```bash
$ yarn run db:seed
```
To clear the database from all data after you have changed it somehow and you may like to seed it again use:
```bash
$ yarn run db:reset
```
Now your database is ready to request. You can click on the **Open Browser** button in Neo4j Desktop to have an insight if the seeding was successful or open [http://localhost:7474/](http://localhost:7474/) in you browser.
Click the **Data-Symbol** at the left upper corner and than click on the **Node Label** + **User** to see a graph of the user relations, as an example.

30
backend/installation/configuration1.md
View File

@ -1,30 +0,0 @@
# Configuration
### Configure
Set your Neo4j connection string and credentials in `.env`. For example:
{% code-tabs %}
{% code-tabs-item title=".env" %}
```yaml
NEO4J_URI=bolt://localhost:7687
NEO4J_USER=neo4j
NEO4J_PASSWORD=letmein
```
{% endcode-tabs-item %}
{% endcode-tabs %}
{% hint style="warning" %}
You **need to install APOC** as a plugin for the graph you create in the neo4j desktop app!
{% endhint %}
Note that grand-stack-starter does not currently bundle a distribution of Neo4j. You can download [Neo4j Desktop](https://neo4j.com/download/) and run locally for development, spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download/), run Neo4j in one of the [many cloud options](https://neo4j.com/developer/guide-cloud-deployment/), [spin up Neo4j in a Docker container](https://neo4j.com/developer/docker/) or on Debian-based systems install [Neo4j from the Debian Repository ](http://debian.neo4j.org/). Just be sure to update the Neo4j connection string and credentials accordingly in `.env`.
**Install APOC plugin on Debian-based systems**
When you have install Neo4j from the Debian Repository, then download the [APOC plugin](https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.4.0.3/apoc-3.4.0.3-all.jar) to the `/var/lib/neo4j/plugins` directory manually or with:
```text
wget https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.4.0.3/apoc-3.4.0.3-all.jar -P /var/lib/neo4j/plugins
```