Skip to content

Commit 1f9617b

Browse files
committed
Made note about mlAdminUsername in sample project
1 parent 4794c8b commit 1f9617b

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

examples/sample-project/gradle.properties

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,58 +8,53 @@ mlAppName=sample-project
88
mlRestPort=8100
99

1010
# If specified, then a test database with app servers for that database will be created, which can then be used for
11-
# automated tests.
11+
# automated tests.
1212
mlTestRestPort=8101
1313

1414
# You can define just mlUsername and mlPassword, and that user will be used for all deployment operations, but that's
1515
# generally not a good practice, as this user will need the admin role in order to create security resources. Generally,
16-
# you want to use an admin user just for mlAdminUsername, as that username will only be used for creating security
16+
# you want to use an admin user just for mlAdminUsername, as that username will only be used for creating security
1717
# resources such as users and roles. You can then use app-specific users for mlRestAdminUsername, mlManageUsername, etc.
1818
#
1919
# Otherwise, this is typically an application user. In sample-project, this user is used for running JUnit tests.
2020
mlUsername=sample-project-rest-admin
2121
mlPassword=password
2222

2323

24-
# This username/password combo is for the "REST admin" user, which is used for loading modules via the REST API as well
25-
# as via XCC. The user must have the rest-admin role. And in order to load modules via XCC, the user must have a role
26-
# that grants xdbc:insert-in and any-uri (or some other set of URI privileges).
27-
#
28-
# If not specified, then mlUsername/mlPassword must be used.
24+
# This username/password combo is for the "REST admin" user, which is used for loading modules via the REST API.
25+
# The user must have the rest-admin role. Non-REST API modules are loaded by default via port 8000, and this requires
26+
# the xdmp-eval-in privilege as well.
27+
#
28+
# If not specified, these properties default to the values of mlUsername and mlPassword.
2929
mlRestAdminUsername=sample-project-rest-admin
3030
mlRestAdminPassword=password
3131

3232

33-
# If specified, the manage username/password combo is used with the ML Management REST API for managing application
34-
# resources; this user must have the manage-admin and rest-admin roles.
35-
#
33+
# If specified, the manage username/password combo is used with the ML Management REST API for managing application
34+
# resources; this user must have the manage-admin and rest-admin roles.
35+
#
3636
# If these are not set, then mlUsername/mlPassword is used for managing application resources.
3737
mlManageUsername=sample-project-manager
3838
mlManagePassword=password
3939

4040

41-
# If specified, the admin username/password combo is used with the ML Management REST API for creating users and roles. This
42-
# user must have the manage-admin or admin role. A good practice is to use your admin account here to create app-specific
43-
# users and roles, which can then be used as mlManageUsername/mlManagePassword and mlUsername/mlPassword. This practice
44-
# is used in this sample project; see src/main/ml-config/security to see how the app-specific users and roles are
45-
# created.
46-
#
47-
# These properties are also used for connecting to the admin application on port 8001 - e.g. for initializing ML and for
48-
# waiting for ML to restart.
41+
# If specified, the admin username/password combo is used for operations that require connecting to the Admin server
42+
# on port 8001. In addition, as of version 3.2.1, this username/password combo is also used for operations on the
43+
# Manage server on port 8002 that require the "security" role. This may be modified in a future version of ml-gradle.
4944
#
50-
# If these properties are not set, then mlUsername/mlPassword will be used.
45+
# If these properties are not set, then mlUsername/mlPassword will be used.
5146
mlAdminUsername=admin
5247
mlAdminPassword=admin
5348

5449

5550
# Configuring the number of forests for the content database (and optional test database) is a common requirement, and
56-
# thus there's a specific property for doing so. This is optional - if you leave it out, the content database defaults
51+
# thus there's a specific property for doing so. This is optional - if you leave it out, the content database defaults
5752
# to 3 forests per host.
5853
mlContentForestsPerHost=4
5954

6055

61-
# By default, modules under /ext and /root are loaded with the default REST API asset permissions of
62-
# rest-admin,read,rest-admin,update,rest-extension-user,execute. You can easily override those by setting the
56+
# By default, modules under /ext and /root are loaded with the default REST API asset permissions of
57+
# rest-admin,read,rest-admin,update,rest-extension-user,execute. You can easily override those by setting the
6358
# mlModulePermissions property, as shown below. This example simply adds rest-reader/read to the set of permissions,
6459
# but you can customize these to be whatever you would like.
6560
mlModulePermissions=rest-admin,read,rest-admin,update,rest-extension-user,execute,rest-reader,read

0 commit comments

Comments
 (0)