jinmeiliao commented on a change in pull request #6844:
URL: https://github.com/apache/geode/pull/6844#discussion_r705566385
##########
File path: geode-apis-compatible-with-redis/README.md
##########
@@ -56,14 +53,40 @@ Your Geode instance should now be up and running (1 locator
and 1 server) and re
To confirm the server is listening, in a separate terminal run:
```console
-redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> -a
<compatibleWithRedisPassword> ping
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort> ping
```
- Replace `<compatibleWithRedisBindAddress>`, `<compatibleWithRedisPort>`, and
`<compatibleWithRedisPassword>` with the same values as the server.
If the server is functioning properly, you should see a response of `PONG`.
-### <a name="adding-a-server"></a>Optional - Adding an additional Geode server
with compatible with Redis APIS
+## <a name="security"></a>Security
+
+Security is implemented slightly differently to Redis. To enable security, a
Security Manager needs to be configured. This Security Manager will
authenticate `AUTH username password` commands. Instead of a default,
system-wide password, a default username can be set using the
`geode-compatible-with-redis-username` parameter. This username is used when
`AUTH` commands are sent with only a password.
+
+For example, the following gfsh command will configure a
`SimpleSecurityManager`:
+
+```console
+start server \
+ --name=<serverName> \
+ --locators=<locatorPort> \
+ --compatible-with-redis-port=<compatibleWithRedisPort> \
+ --compatible-with-redis-bind-address=<compatibleWithRedisBindAddress> \
+ --compatible-with-redis-username=<compatibleWithRedisUsername> \
+
--J=-Dgemfire.security-manager=org.apache.geode.examples.SimpleSecurityManager
+```
+
+To confirm that the server is working, in a separate terminal run:
+
+```console
+redis-cli -h <compatibleWithRedisBindAddress> -p <compatibleWithRedisPort>
--user <compatibleWithRedisUsername> -a <compatibleWithRedisUsername> ping
Review comment:
but for documentation, shouldn't it point out -a takes password? The
fact that it uses the username here is only for a specific security manager.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
