Browse Source

Improve readme and replace confusing docs section

Jonas Kalderstam 9 years ago
parent
commit
8999f45a55
2 changed files with 11 additions and 20 deletions
  1. 9 14
      neo4j/content.md
  2. 2 6
      neo4j/user-feedback.md

+ 9 - 14
neo4j/content.md

@@ -6,28 +6,23 @@ Neo4j is a highly scalable, robust, native graph database. It is used in mission
 
 # 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 \
     --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).
 
-Documentation for the Neo4j 3.0 image can be found [here](http://neo4j.com/developer/docker-3.x/).
+This exposes three ports (`7474`, `7473`, and `7687`) for HTTP, HTTPS, and Bolt access to the Neo4j API. A volume is bound to `/data` to allow the database to be persisted outside the container.
 
-You can start a Neo4j 3.0 container like this:
+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.
 
-```console
-docker run \
-    --publish=7474:7474 --publish=7687:7687 \
-    --volume=$HOME/neo4j/data:/data \
-    neo4j:3.0
-```
+# 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/).

+ 2 - 6
neo4j/user-feedback.md

@@ -1,12 +1,8 @@
-## Documentation
-
-Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) 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](%%GITHUB-REPO%%/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