Added instruction for Docker install and little corrections

This commit is contained in:
Wolfgang Huß 2019-02-18 12:51:52 +01:00
parent 4edbee6efd
commit 2d99d3903e
7 changed files with 87 additions and 11 deletions

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
# Apple macOS folder attribute file
.DS_Store

View File

@ -6,7 +6,7 @@
* [Backend Installation](backend/installation/README.md)
* [Neo4j Installation and Configuration](backend/installation/configuration.md)
* [Docker](backend/installation/docker.md)
* [Kubernetes](backend/installation/kubernetes.md)
* [GraphQL with Apollo](backend/graphql-with-apollo/README.md)
* [Mocking](backend/graphql-with-apollo/mocking.md)
* [Seeding](backend/graphql-with-apollo/seeding.md)

View File

@ -70,11 +70,86 @@ Configure the file `.env` according to your needs and your local setup.
## Installation and Usage with Docker
Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier.
### General Installation of Docker
There are [sevaral ways to install Docker CE](https://docs.docker.com/install/) on your computer or server.
{% tabs %}
{% tab title="Docker Desktop macOS" %}
Follow these instructions to [install Docker Desktop on macOS](https://docs.docker.com/docker-for-mac/install/).
{% endtab %}
{% tab title="Docker Desktop Windows" %}
Follow these instructions to [install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/).
{% endtab %}
{% tab title="Docker CE" %}
Follow these instructions to [install Docker CE](https://docs.docker.com/install/).
{% endtab %}
{% endtabs %}
Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:
```bash
$ docker --version
Docker version 18.09.2
$ docker-compose --version
docker-compose version 1.23.2
```
### Install Nitro-BackEnd with Docker
Run the following command to install Nitro-Backend as a Docker container. This installation includes Neo4j.
The installation takes a bit longer on the first pass or on rebuild ...
```bash
$ docker-compose up
# rebuild the containers for a cleanup
$ docker-compose up --build
```
#### Seed Neo4j in Docker
To seed the Neo4j database with default data, that GraphQL requests or playing with our GraphQL Playground returns anything else than an empty response, run the command.
Run the following command to seed the Neo4j database with default data requested by Nitro-Web through GraphQL or when you play with our GraphQL playground.
```bash
# open another terminal
# create indices etc.
$ docker-compose exec neo4j migrate
# seed database
$ docker-compose exec backend yarn run db:seed
```
#### Wipe out Neo4j database in Docker
To wipe out your neo4j database and delete the volumes send command:
```bash
# open another terminal and run
$ docker-compose down -v
```
#### Video Tutorial
{% hint style="info" %}
TODO: How to install Docker for Human Connection … \(Also maybe there should be a main docker installation guide for the whole system at once!?\)
TODO: Link to video
{% endhint %}
For further informations see also our [Docker documentation](docker.md).
### Development with Kubernetes
For further informations see also our [Kubernetes documentation](kubernetes.md).
## Local Installation

View File

@ -1,6 +1,6 @@
# Neo4j Installation and Configuration
## Configure Enviroment
## Configure Environment
Set your Neo4j connection string and credentials in `.env`. For example:
@ -57,7 +57,7 @@ You can spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download-cen
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, e.g. with:
```text
wget https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.5.0.1/apoc-3.5.0.1-all.jar -P /var/lib/neo4j/plugins
$ wget https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.5.0.1/apoc-3.5.0.1-all.jar -P /var/lib/neo4j/plugins
```
{% endtab %}
{% endtabs %}

View File

@ -1,5 +0,0 @@
# Docker
Currently you can find some documentation here:
[https://github.com/Human-Connection/Nitro-Backend/tree/master/kubernetes](https://github.com/Human-Connection/Nitro-Backend/tree/master/kubernetes)

View File

@ -0,0 +1,5 @@
# Kubernetes
Currently you can find some documentation here:
[https://github.com/Human-Connection/Nitro-Deployment](https://github.com/Human-Connection/Nitro-Deployment)

View File

@ -118,4 +118,3 @@ TODO: How to modify screenshots in Linux ...
{% endhint %}
{% endtab %}
{% endtabs %}