Skip to content

Commit

Permalink
Merge pull request #1365 from cies/patch-1
Browse files Browse the repository at this point in the history
Fix docs for `play status`
  • Loading branch information
xael-fry committed Nov 1, 2021
2 parents a0832fb + 6f3b8ed commit 0ecac3b
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions documentation/commands/cmd-status.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
~
~ Synopsis:
~ ~~~~~~~~~
~ play status [app_path] [--url=http://...] [--status-key=...]
~ play status [app_path] [--url=http://...] [--secret=...]
~
~ Description:
~ ~~~~~~~~~~~~
Expand All @@ -20,13 +20,14 @@
~ Options:
~ ~~~~~~~~
~ --url:
~ The script try to connect to the application at the localhost domain. If you want to monitor an application running on
~ a remote server, specify the application URL using this option (eg. play status --url=http://myapp.com)
~ By default this command connects to the application running on the localhost domain. If you want to monitor an
~ application running on a remote server, specify the application URL using this option
~ (eg. play status --url=http://myapp.com)
~
~ --status-key:
~ The script uses the status key to generate an authorization token. It assumes that the status key available from the
~ app_path/conf/application.conf is valid (see setting `application.statusKey`).
~ If not you can provide your own status key using this option (eg. play status --status-key=bghjT7ZG7ZGCO8)
~ --secret:
~ This command uses the secret status key as authorization token. By default this command uses the status key
~ found in `app_path/conf/application.conf` (see setting `application.statusKey`).
~ With this option you can provide your own status key from the command line (eg. play status --secret=bghjT7ZG7ZGCO8).
~
~ If you provide both options, you can run this command without a local application directory (app_path is not required).
~
~

0 comments on commit 0ecac3b

Please sign in to comment.