Browse Source

Run update.sh

Docker Library Bot 9 years ago
parent
commit
8bdaf0260d
1 changed files with 21 additions and 17 deletions
  1. 21 17
      neo4j/README.md

+ 21 - 17
neo4j/README.md

@@ -17,36 +17,44 @@ For detailed information about the virtual/transfer sizes and individual layers
 
 Neo4j is a highly scalable, robust, native graph database. It is used in mission-critical apps by thousands of leading startups, enterprises, and governments around the world. You can learn more [here](http://neo4j.com/developer).
 
-![logo](https://raw.githubusercontent.com/docker-library/docs/c8e2434fd7f640cfb78070c28729693ad1a1d46c/neo4j/logo.png)
+![logo](https://raw.githubusercontent.com/docker-library/docs/2289fb3b561c63750032ac74ff65034c0e486072/neo4j/logo.png)
 
 # How to use this image
 
-## Neo4j 2.3
+## Start an instance of neo4j
 
-Documentation for the Neo4j 2.3 image can be found [here](http://neo4j.com/developer/docker-2.x/).
-
-You can start a Neo4j 2.3 container like this:
+You can start a Neo4j container like this:
 
 ```console
 docker run \
-    --publish=7474:7474 \
+    --publish=7474:7474 --publish=7687:7687 \
     --volume=$HOME/neo4j/data:/data \
-    neo4j:2.3
+    neo4j
 ```
 
-## Neo4j 3.0
+which allows you to access neo4j through your browser at [http://localhost:7474](http://localhost:7474).
+
+This binds two ports (`7474` and `7687`) for HTTP and Bolt access to the Neo4j API. A volume is bound to `/data` to allow the database to be persisted outside the container.
+
+By default, this requires you to login with `neo4j/neo4j` and change the password. You can, for development purposes, disable authentication by passing `--env=NEO4J_AUTH=none` to docker run.
+
+## Note on version 2.3
 
-Documentation for the Neo4j 3.0 image can be found [here](http://neo4j.com/developer/docker-3.x/).
+Neo4j 3.0 introduced several major user-facing changes, primarily the new binary Bolt protocol. This is not available in 2.3 and as such, there is no need to expose the `7687` port. Due to changes made to the structure of configuration files, several environment variables used to configure the image has changed as well. Please see the [2.x specific section in the manual](http://neo4j.com/developer/docker-2.x/) for further details.
 
-You can start a Neo4j 3.0 container like this:
+You can start an instance of Neo4j 2.3 like this:
 
 ```console
 docker run \
-    --publish=7474:7474 --publish=7687:7687 \
+    --publish=7474:7474 \
     --volume=$HOME/neo4j/data:/data \
-    neo4j:3.0
+    neo4j:2.3
 ```
 
+# Documentation
+
+For more examples and complete documentation please go [here for 2.x](http://neo4j.com/developer/docker-2.x/) and [here for 3.x](http://neo4j.com/developer/docker-3.x/).
+
 # Supported Docker versions
 
 This image is officially supported on Docker version 1.11.2.
@@ -57,15 +65,11 @@ Please see [the Docker installation documentation](https://docs.docker.com/insta
 
 # User Feedback
 
-## Documentation
-
-Documentation for this image is stored in the [`neo4j/` directory](https://github.com/docker-library/docs/tree/master/neo4j) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request.
-
 ## Issues
 
 If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/neo4j/docker-neo4j/issues).
 
-For general Neo4j questions, please ask on [StackOverflow](http://stackoverflow.com/).
+For general Neo4j questions, please ask on [StackOverflow](http://stackoverflow.com/questions/tagged/neo4j).
 
 ## Contributing