Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
c970136
Add docker compose configuration section
stefgia Sep 2, 2024
8c48b93
Clean up and make the document more concise
stefgia Sep 2, 2024
c0a7dc6
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
996b475
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
2685c1c
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
8faf17d
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
0647495
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
f02f78c
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
de28df6
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
269d6f1
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
096efc0
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
43e8d3d
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
cf02fc0
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
571ffdd
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
7ddf1c1
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
6e51a2d
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
d446d52
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
1e912a5
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
32b8389
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
a7d454c
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
b488165
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
ffb96a8
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
f6b43f7
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
e8c2c7d
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
e6218ad
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
8bf77af
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
1c4daf2
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
f17e22c
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
551394e
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
a663e3e
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
a528a26
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
dad56f8
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
49a5b75
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
cbed6bc
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
504dd29
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
7b617ec
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
0683e7a
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
ef6f7f3
Update modules/ROOT/pages/docker/docker-compose-settings.adoc
renetapopova Sep 4, 2024
7e4bfee
editorial update of the page
renetapopova Sep 5, 2024
fb46403
forgot to add the file
renetapopova Sep 5, 2024
23d1886
fix the link on the intro page
renetapopova Sep 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
** xref:docker/mounting-volumes.adoc[]
** xref:docker/configuration.adoc[]
** xref:docker/plugins.adoc[]
** xref:docker/docker-compose-standalone.adoc[]
** xref:docker/clustering.adoc[]
** xref:docker/operations.adoc[]
** xref:docker/dump-load.adoc[]
Expand Down
106 changes: 106 additions & 0 deletions modules/ROOT/pages/docker/docker-compose-standalone.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
:description: Running Neo4j in a Docker container using Docker Compose
[[docker-compose-neo4j-standalone]]
= Deploy a Neo4j standalone server using Docker Compose

You can deploy a Neo4j standalone server using Docker Compose by defining the container configuration in a _docker-compose.yml_ file and authenticating with basic authentication or Docker secrets.

[[docker-compose-basic-authentication]]
== Deploy a Neo4j server using basic authentication mechanism

Before you start, verify that you have installed Docker Compose.
For more information, see the https://docs.docker.com/compose/install/[Install Docker Compose official documentation].

. Create a project folder where you will store your _docker-compose.yml_ file and run your Neo4j server.
. Prepare your _docker-compose.yml_ file using the following example.
For more information, see the Docker Compose official documentation on https://docs.docker.com/compose/compose-file/#service-configuration-reference[Docker Compose specification].
+
.Example of a _docker-compose.yml_ file
[source,yaml,subs="attributes+,+macros"]
----
services:
neo4j:
image: neo4j:latest
volumes: # <1>
- /$HOME/neo4j/logs:/logs
- /$HOME/neo4j/config:/config
- /$HOME/neo4j/data:/data
- /$HOME/neo4j/plugins:/plugins
environment:
- NEO4J_AUTH=neo4j/your_password # <2>
ports:
- "7474:7474"
- "7687:7687"
restart: always
----
<1> Mount the _/$HOME/neo4j/<..>:_ directories to local directories on your host machine to store logs, configuration, data, and plugins.
For more information about mounting volumes, see xref:docker/mounting-volumes.adoc[].
<2> Set the `neo4j` username and password.

. Deploy your Neo4j server by running `docker-compose up` from your project folder.
+
[source,shell,subs="attributes+,+macros"]
----
docker-compose up -d
----
+
The `-d` flag starts the container in detached mode.

[role=label--recommended]
[[docker-compose-secrets]]
== Deploy a Neo4j server with Docker secrets

It is advisable not to store sensitive information, such as the database username and password, in the _docker-compose.yml_ file.
You can instead store your credentials in files and use them in your _docker-compose.yml_ file without exposing their values.

. Create a file, for example, _neo4j_auth.txt_, containing the username and password for the Neo4j server to be used as a Docker secret.
+
[source,text,subs="attributes"]
----
neo4j:your_password
----
. Prepare your _docker-compose.yml_ file using the following example.
For more information, see the Docker Compose official documentation on https://docs.docker.com/compose/compose-file/#service-configuration-reference[Docker Compose specification].
+
.Example of a _docker-compose.yml_ file
[source,yaml,subs="attributes+,+macros"]
----
services:
neo4j:
image: neo4j:latest
volumes: # <1>
- /$HOME/neo4j/logs:/logs
- /$HOME/neo4j/config:/config
- /$HOME/neo4j/data:/data
- /$HOME/neo4j/plugin:/plugins
environment:
- NEO4J_AUTH_FILE=/run/secrets/neo4j_auth_file # <2>
ports:
- "7474:7474"
- "7687:7687"
restart: always
secrets:
- neo4j_auth_file #<3>
secrets:
neo4j_auth_file: # <4>
file: ./neo4j_auth.txt # <5>
----
<1> Mount the _/$HOME/neo4j/<..>:_ directories to local directories on your host machine to store logs, configuration, data, and plugins.
<2> Path to the file where the value for the `NEO4J_AUTH` environment variable can be found.
<3> The name of the secret, for example `neo4j_auth_file`.
<4> Path to the _neo4j_auth.txt_ file.
<5> The name of the secret in the `neo4j` service.
+
[WARNING]
====
The secret value overrides the equivalent environment variable if they are both defined.
So, for example, if you also define an environment variable `NEO4J_AUTH=neo4j/your_other_password` in the `environment` section of the `neo4j` service, the value of `NEO4J_AUTH_FILE` will be the one used.
====

. Deploy your Neo4j server by running `docker-compose up` from your project folder.
+
[source,shell,subs="attributes+,+macros"]
----
docker-compose up -d
----
+
The `-d` flag starts the container in detached mode.
2 changes: 2 additions & 0 deletions modules/ROOT/pages/docker/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ This chapter describes the following:
* xref:docker/mounting-volumes.adoc[Persisting data with Docker volumes] -- How and where to mount persistent storage to the Docker container.
* xref:docker/configuration.adoc[Modify the default configuration] -- How to configure Neo4j to run in a Docker container.
* xref:docker/plugins.adoc[Plugins] -- How to load plugins when using Neo4j in Docker.
* xref:docker/docker-compose-standalone.adoc[Deploy a Neo4j server with Docker Compose] -- How to set up a Neo4j server with Docker Compose using a basic authentication mechanism or Docker secrets.
* xref:docker/clustering.adoc[Deploy a Neo4j cluster on Docker] -- How to set up and deploy a Neo4j cluster on Docker.
* xref:docker/operations.adoc[Docker specific operations] -- Descriptions of various `neo4j-admin` and `cypher-shell` operations that are specific to using Docker.
* xref:docker/dump-load.adoc[Offline dump and load] -- How to perform dump and load of a containerized Neo4j database.
* xref:docker/backup-restore.adoc[Online backup and restore] -- How to perform backup and restore of a containerized Neo4j database. Enterprise Only.
* xref:docker/security.adoc[Security] -- Information about using encryption with a Neo4j Docker image.
* xref:docker/ref-settings.adoc[Docker specific configuration settings] -- A conversion table for the Neo4j configuration settings to Docker format.


[NOTE]
====
Docker does not run natively on macOS or Windows.
Expand Down