diff --git a/en/.buildinfo b/en/.buildinfo
index da2145160..5bd253040 100644
--- a/en/.buildinfo
+++ b/en/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 70c5abd44e0a44a2e46cdd796f2fb499
+config: c412f8b78ac73ff175c959e5748e006c
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/en/README.html b/en/README.html
index 532e5c35b..26d765200 100644
--- a/en/README.html
+++ b/en/README.html
@@ -8,7 +8,7 @@
- <no title> — Arthas 3.4.8 documentation
+ <no title> — Arthas 3.5.0 documentation
@@ -71,7 +71,7 @@
- 3.4.8
+ 3.5.0
diff --git a/en/_sources/advanced-use.md.txt b/en/_sources/advanced-use.md.txt
index 6464c02c0..608e181c1 100644
--- a/en/_sources/advanced-use.md.txt
+++ b/en/_sources/advanced-use.md.txt
@@ -55,6 +55,10 @@ Advanced Usage
* [stack](stack.md) - display the stack trace for the specified class and method
* [tt](tt.md) - time tunnel, record the arguments and returned value for the methods and replay
+## authentication
+
+* [auth](auth.md) - authentication
+
## options
* [options](options.md) - check/set Arthas global options
diff --git a/en/_sources/auth.md.txt b/en/_sources/auth.md.txt
new file mode 100644
index 000000000..937e3aa9e
--- /dev/null
+++ b/en/_sources/auth.md.txt
@@ -0,0 +1,69 @@
+auth
+===
+
+> Authenticates the current session
+
+### Configure username and password
+
+When attaching, you can specify a password on the command line. such as:
+
+```
+java -jar arthas-boot.jar --password ppp
+```
+
+* The user can be specified by the `--username` option, the default value is `arthas`.
+* You can also configure username/password in `arthas.properties`. The priority of the command line is higher than that of the configuration file.
+* If only `username` is configured and no `password` is configured, a random password will be generated and printed in `~/logs/arthas/arthas.log`
+
+ ```
+ Using generated security password: 0vUBJpRIppkKuZ7dYzYqOKtranj4unGh
+ ```
+
+### Authenticate in the telnet console
+
+After connecting to arthas, directly executing the command will prompt for authentication:
+
+```bash
+[arthas@37430]$ help
+Error! command not permitted, try to use 'auth' command to authenticates.
+```
+
+Use the `auth` command to authenticate, and you can execute other commands after success.
+
+```
+[arthas@37430]$ auth ppp
+Authentication result: true
+```
+
+* The user can be specified by the `--username` option, the default value is `arthas`.
+
+### Web console Authentication
+
+Open the browser, there will be a pop-up window prompting you to enter your username and password.
+
+After success, you can directly connect to the web console.
+
+### HTTP API Authentication
+
+#### HTTP Authorization Header(recommended)
+
+Arthas uses the HTTP standard Basic Authorization.
+
+* Reference: [https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)
+
+For example, if the user name is: `admin` and the password is `admin`, the combination is a string: `admin:admin`, the base64 result is: `YWRtaW46YWRtaW4=`, then the HTTP request adds the `Authorization` header:
+
+```bash
+curl 'http://localhost:8563/api' \
+ -H 'Authorization: Basic YWRtaW46YWRtaW4=' \
+ --data-raw '{"action":"exec","command":"version"}'
+```
+
+#### URL parameters
+
+It supports passing username and password in parameters. such as:
+
+```bash
+curl 'http://localhost:8563/api?password=admin' \
+ --data-raw '{"action":"exec","command":"version"}'
+```
\ No newline at end of file
diff --git a/en/_sources/commands.md.txt b/en/_sources/commands.md.txt
index 13a35189c..e997ca785 100644
--- a/en/_sources/commands.md.txt
+++ b/en/_sources/commands.md.txt
@@ -39,6 +39,7 @@ All Commands
* [base64](base64.md)
* [tee](tee.md)
* [pwd](pwd.md)
+* [auth](auth.md)
* [options](options.md)
diff --git a/en/_sources/faq.md.txt b/en/_sources/faq.md.txt
index 68d1bc48d..04d0c7c4e 100644
--- a/en/_sources/faq.md.txt
+++ b/en/_sources/faq.md.txt
@@ -3,6 +3,10 @@
> For questions that are not in this list, please search in issues. [https://github.com/alibaba/arthas/issues](https://github.com/alibaba/arthas/issues)
+
+##### Where is the log file?
+
+Log file path: `~/logs/arthas/arthas.log`
##### How much impact does Arthas attach have on the performance of the original process?
[https://github.com/alibaba/arthas/issues/44](https://github.com/alibaba/arthas/issues/44)
@@ -15,6 +19,7 @@ com.sun.tools.attach.AttachNotSupportedException: Unable to open socket file: ta
1. Check whether the current user and the target java process are consistent. If they are inconsistent, switch to the same user. JVM can only attach java processes under the same user.
2. Try to use `jstack -l $pid`. If the process does not respond, it means that the process may freeze and fail to respond to the JVM attach signal. So Arthas based on the attach mechanism cannot work. Try to use `jmap` heapdump to analyze.
3. Try to attach arthas-demo in [quick-start](quick-start.md).
+4. For more information: [https://github.com/alibaba/arthas/issues/347](https://github.com/alibaba/arthas/issues/347)
##### Can commands such as trace/watch enhance the classes in jdk?
@@ -74,4 +79,8 @@ For example: use skywalking V8.1.0 below [cannot trace, watch classes enhanced b
##### Can I use arthas offline?
-Yes. Just download the full size package and unzip it, refer to: [Download](download.md).
\ No newline at end of file
+Yes. Just download the full size package and unzip it, refer to: [Download](download.md).
+
+##### Attach the process with pid 1 in docker/k8s failed
+
+Reference: [https://github.com/alibaba/arthas/issues/362#issuecomment-448185416](https://github.com/alibaba/arthas/issues/362#issuecomment-448185416)
\ No newline at end of file
diff --git a/en/_sources/http-api.md.txt b/en/_sources/http-api.md.txt
index 4c95844b7..af386f35c 100644
--- a/en/_sources/http-api.md.txt
+++ b/en/_sources/http-api.md.txt
@@ -492,6 +492,10 @@ curl -Ss -XPOST http://localhost:8563/api -d '''
}
```
+### Authentication
+
+* Reference: [auth](auth.md)
+
### Web UI
diff --git a/en/_sources/tunnel.md.txt b/en/_sources/tunnel.md.txt
index 8d3277ebd..3318cea7b 100644
--- a/en/_sources/tunnel.md.txt
+++ b/en/_sources/tunnel.md.txt
@@ -90,6 +90,8 @@ For the above example, go to [http://47.75.156.201/arthas/?port=80](http://47.75
### Best practices
+> Note that the agentId must be unique, otherwise it will conflict on the tunnel server and not work properly.
+
If the arthas agent is configured with `appName`, the generated agentId will be prefixed with `appName`.
For example, if you add the startup parameter `as.sh --tunnel-server 'ws://127.0.0.1:7777/ws' --app-name demoapp`, the generated agentId might be `demoapp_URJZ5L48RPBR2ALI5K4V`.
diff --git a/en/_static/documentation_options.js b/en/_static/documentation_options.js
index 41346a423..be8f90d86 100644
--- a/en/_static/documentation_options.js
+++ b/en/_static/documentation_options.js
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: '3.4.8',
+ VERSION: '3.5.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
diff --git a/en/advanced-use.html b/en/advanced-use.html
index 598e8bc03..41b6c1f70 100644
--- a/en/advanced-use.html
+++ b/en/advanced-use.html
@@ -8,7 +8,7 @@
- Advanced Usage — Arthas 3.4.8 documentation
+ Advanced Usage — Arthas 3.5.0 documentation
@@ -73,7 +73,7 @@
For example, if the user name is: admin and the password is admin, the combination is a string: admin:admin, the base64 result is: YWRtaW46YWRtaW4=, then the HTTP request adds the Authorization header:
Check whether the current user and the target java process are consistent. If they are inconsistent, switch to the same user. JVM can only attach java processes under the same user.
Try to use jstack-l$pid. If the process does not respond, it means that the process may freeze and fail to respond to the JVM attach signal. So Arthas based on the attach mechanism cannot work. Try to use jmap heapdump to analyze.
