Skip to content

Commit 17711d8

Browse files
authored
Merge pull request #172 from arangodb-helper/documentation/security
Doc - Securing Starter Deployments
2 parents 807e834 + d786337 commit 17711d8

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Securing Starter Deployments
2+
============================
3+
4+
The password that is set for the _root_ user during the installation of the ArangoDB
5+
package has no effect in case of deployments done with the tool _ArangoDB Starter_,
6+
as this tool creates new database directories and configuration files that are
7+
separate from those created by the stand-alone installation.
8+
9+
Assuming you have enabled authentication in your _Starter_ deployment (using `--auth.jwt-secret=<secret-file>`), by default
10+
the _root_ user will be created with an _empty_ password.
11+
12+
In order to the change the password of the _root_ user, you can:
13+
14+
- Open the ArangoDB web UI and change the password from there. [More information](../Programs/WebInterface/Users.md).
15+
- Open an ArangoSH shell and use the function _users.replace_. [More information](../Administration/ManagingUsers/InArangosh.md#replace).
16+
17+
In case you would like to automate the _root_ password change, you might use the
18+
_--javascript.execute-string_ option of the _arangosh_ binary, e.g.:
19+
20+
```bash
21+
arangosh --server.endpoint your-server-endpoint \
22+
--server.password ""
23+
--javascript.execute-string 'require("org/arangodb/users").update("root", "mypwd");
24+
```
25+
26+
where "mypwd" is the new password you want to set.
27+
28+
If your _Starter_ deployment has authentication turned off, it is suggested to
29+
turn it on using a _JWT secret_ file. For more information on this topic, please
30+
refer to the _Starter_ [Option](../Programs/Starter/Options.md#authentication-options) page.
31+
32+
Note that you cannot easily turn authentication on/off once your deployment
33+
has started for the first time. It is possible to stop all _Starters_ and then
34+
manually modify all the `arangod.conf` files in yor data directory, but this is not recommended.

0 commit comments

Comments
 (0)