Skip to content

Commit 60a884d

Browse files
Clarify the neo4j-admin.conf file permissions for using `--expand-c… (#1621)
…… (#1591) …ommands`
1 parent 846479a commit 60a884d

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

modules/ROOT/pages/configuration/command-expansion.adoc

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ If they fail, Neo4j does not evaluate the script commands in _neo4j.conf_, and t
5555

5656
On Unix (both Linux and Mac OS)::
5757

58-
* The _neo4j.conf_ file must, at least, be readable by its owner or by the user-group to which the owner belongs.
58+
* The _neo4j.conf_ and _neo4j-admin.conf_ files must, at most, be readable or writable by their owner and readable by the user-group to which the owner belongs.
59+
The _neo4j-admin.conf_ file is a configuration file located in the same directory as the _neo4j.conf_ file.
60+
You can use the _neo4j-admin.conf_ file to provide administration-task-specific settings.
5961
* The Neo4j process must run as a user who is either the owner of the _neo4j.conf_ file or in the user-group which owns the _neo4j.conf_ file.
6062

6163
[NOTE]
@@ -67,7 +69,26 @@ For example, the _neo4j.conf_ file can have no group permissions and only be rea
6769

6870
On Windows::
6971

70-
* The _neo4j.conf_ file must, at least, be readable by the user that the Neo4j process runs as.
72+
* The _neo4j.conf_ and _neo4j-admin.conf_ files must, at most, be readable/modifiable but not executable by the owner only.
73+
74+
[NOTE]
75+
====
76+
The owner may have the following permissions from the Access Control List (ACL):
77+
78+
* `READ_DATA`
79+
* `WRITE_DATA`
80+
* `APPEND_DATA`
81+
* `READ_ATTRIBUTES`
82+
* `WRITE_ATTRIBUTES`
83+
* `READ_NAMED_ATTRS`
84+
* `WRITE_NAMED_ATTRS`
85+
* `READ_ACL`
86+
* `WRITE_ACL`
87+
* `DELETE`
88+
* `DELETE_CHILD`
89+
* `WRITE_OWNER`
90+
* `SYNCHRONIZE`
91+
====
7192

7293
== Logging
7394

@@ -89,4 +110,4 @@ In this case, the execution stops and the server does not start.
89110
* Errors for incorrect values -- The returned value is not the one expected for the setting.
90111
In this case, the server does not start.
91112

92-
For more information, see xref:tools/neo4j-admin/index.adoc#neo4j-admin-exit-codes[Exit codes].
113+
For more information, see xref:tools/neo4j-admin/index.adoc#neo4j-admin-exit-codes[Exit codes].

modules/ROOT/pages/configuration/file-locations.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,15 @@ File permissions:: Read only
6969
| Default file location
7070

7171
| Linux / macOS / Docker | _<NEO4J_HOME>/conf/neo4j.conf_ +
72+
_<NEO4J_HOME>/conf/neo4j-admin.conf_ +
7273
_<NEO4J_HOME>/conf/server-logs.xml_ +
7374
_<NEO4J_HOME>/conf/user-log.xml_
7475
| Windows | _<NEO4J_HOME>\conf\neo4j.conf_ +
76+
_<NEO4J_HOME>\conf\neo4j-admin.conf_ +
7577
_<NEO4J_HOME>\conf\server-logs.xml_ +
7678
_<NEO4J_HOME>\conf\user-log.xml_
7779
| Debian / RPM | _/etc/neo4j/neo4j.conf_ +
80+
_/etc/neo4j/neo4j-admin.conf_ +
7881
_/etc/neo4j/server-logs.xml_ +
7982
_/etc/neo4j/user-log.xml_
8083
| Neo4j Desktop | From the _Open_ dropdown menu of your active Neo4j DBMS, select _Terminal_ and run `cd conf`.

0 commit comments

Comments
 (0)