docs: update docs for release 0.4.3

Signed-off-by: Starnop <[email protected]>
dragonflyoss · Aug 16, 2019 · 9d7894b · 9d7894b
1 parent bb790fa
commit 9d7894b
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 21 deletions.
diff --git a/docs/quick_start/README.md b/docs/quick_start/README.md
@@ -11,24 +11,20 @@ All steps in this document are done on the same machine using the docker contain
 ## Step 1: Deploy Dragonfly Server (SuperNode)
 
 ```bash
-docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.2
+docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.3
 ```
 
-**NOTE**:
-
-- If dfclient cannot connect to supernode directly, you can specify parameter `--advertise-ip` when supernode starts. This ip address must be accessible from dfclient. If this parameter is not specified, supernode will advertise its first non-loop address.
-
 ## Step 2：Deploy Dragonfly Client (dfclient)
 
 ```bash
 SUPERNODE_IP=`docker inspect supernode -f '{{.NetworkSettings.Networks.bridge.IPAddress}}'`
-docker run -d --name dfclient --restart=always -p 65001:65001 -v $HOME/.small-dragonfly:/root/.small-dragonfly dragonflyoss/dfclient:0.4.2 --registry https://index.docker.io --node $SUPERNODE_IP
+docker run -d --name dfclient --restart=always -p 65001:65001 -v $HOME/.small-dragonfly:/root/.small-dragonfly dragonflyoss/dfclient:0.4.3 --registry https://index.docker.io --node $SUPERNODE_IP
 ```
 
 **NOTE**:
 
 - The `--registry` parameter specifies the mirrored image registry address, and `https://index.docker.io` is the address of official image registry, you can also set it to the other **non-https image registries**.
-- The `--node` parameter specifies the supernode's ip address. Here we use `docker inspect` to get the ip of supernode container. Since the supernode container exposes its ports, you can specify this parameter to node ip address as well.
+- The `--node` parameter specifies the supernode's address in the format of **HOST:IP**. And the default value `8002` will be used if the port is not specified. Here we use `docker inspect` to get the ip of supernode container as the host value. Since the supernode container exposes its ports, you can specify this parameter to node ip address as well.
 
 ## Step 3. Configure Docker Daemon
 

diff --git a/docs/user_guide/install_client.md b/docs/user_guide/install_client.md
@@ -16,15 +16,15 @@ You can install from the latest packages we provided.
 
     Available packages:
 
-    - [Linux 64-bit](https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.2/df-client_0.4.2_linux_amd64.tar.gz): `https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.2/df-client_0.4.2_linux_amd64.tar.gz`
+    - [Linux 64-bit](https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.3/df-client_0.4.3_linux_amd64.tar.gz): `https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.3/df-client_0.4.3_linux_amd64.tar.gz`
 
-    - [MacOS 64-bit](https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.2/df-client_0.4.2_darwin_amd64.tar.gz): `https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.2/df-client_0.4.2_darwin_amd64.tar.gz`
+    - [MacOS 64-bit](https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.3/df-client_0.4.3_darwin_amd64.tar.gz): `https://github.com/dragonflyoss/Dragonfly/releases/download/v0.4.3/df-client_0.4.3_darwin_amd64.tar.gz`
 
 2. Unzip the package.
 
     ```bash
     # Replace `xxx` with the installation directory.
-    tar -zxf df-client_0.4.2_linux_amd64.tar.gz -C xxx
+    tar -zxf df-client_0.4.3_linux_amd64.tar.gz -C xxx
     ```
 
 3. Add the directory of `df-client` to your `PATH` environment variable to make sure you can directly use `dfget` and `dfdaemon` command.

diff --git a/docs/user_guide/install_server.md b/docs/user_guide/install_server.md
@@ -37,7 +37,7 @@ You can get it from [DockerHub](https://hub.docker.com/) directly.
 1. Obtain the latest Docker image ID of the SuperNode.
 
     ```sh
-    docker pull dragonflyoss/supernode:0.4.2
+    docker pull dragonflyoss/supernode:0.4.3
     ```
 
 Or you can build your own supernode image.
@@ -57,7 +57,7 @@ Or you can build your own supernode image.
 3. Build the Docker image.
 
     ```sh
-    TAG="0.4.2"
+    TAG="0.4.3"
     make docker-build-supernode DF_VERSION=$TAG
     ```
 
@@ -72,7 +72,7 @@ Or you can build your own supernode image.
 **NOTE**: Replace ${supernodeDockerImageId} with the ID obtained at the previous step.
 
 ```sh
-docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.2 --download-port=8001
+docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.3 --download-port=8001
 
 or
 
@@ -102,11 +102,9 @@ docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /ho
 4. Start the SuperNode.
 
     ```sh
-    supernode --home-dir=/home/admin/supernode --port=8002 --download-port=8001 --advertise-ip=127.0.0.1
+    supernode --home-dir=/home/admin/supernode --port=8002 --download-port=8001
     ```
 
-    **NOTE**: `advertise-ip` should be the ip that clients can connect to, `127.0.0.1` here is an example for testing, and it can only be used if the server and client are in the same machine.
-
 5. Add the following configuration items to the Nginx configuration file.
 
     ```conf

diff --git a/docs/user_guide/monitoring.md b/docs/user_guide/monitoring.md
@@ -13,7 +13,7 @@ First, please ensure you know how to setup Dragonfly environment. If you don't,
 ``` bash
 make build
 # start supernode and dfdaemon
-bin/linux_amd64/supernode --advertise-ip 127.0.0.1
+bin/linux_amd64/supernode
 bin/linux_amd64/dfdaemon
 ```
 

diff --git a/docs/user_guide/multi_machines_deployment.md b/docs/user_guide/multi_machines_deployment.md
@@ -25,11 +25,9 @@ Then, we must provice:
 Deploy the Dragonfly server (Supernode) on the machine `dfsupernode`.
 
 ```bash
-docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.2 --download-port=8001 --advertise-ip=dfsupernode
+docker run -d --name supernode --restart=always -p 8001:8001 -p 8002:8002 -v /home/admin/supernode:/home/admin/supernode dragonflyoss/supernode:0.4.3 --download-port=8001
 ```
 
-> **NOTE**: `advertise-ip` should be the ip that clients can connect to.
-
 ## Step 2：Deploy Dragonfly Client (dfclient)
 
 The following operations should be performed both on the client machine `dfclient0`, `dfclient1`.
@@ -53,7 +51,7 @@ EOD
 docker run -d --name dfclient --restart=always -p 65001:65001 \
     -v /etc/dragonfly:/etc/dragonfly \
     -v $HOME/.small-dragonfly:/root/.small-dragonfly \
-    dragonflyoss/dfclient:0.4.2 --registry https://index.docker.io
+    dragonflyoss/dfclient:0.4.3 --registry https://index.docker.io
 ```
 
 **NOTE**: The `--registry` parameter specifies the mirrored image registry address, and `https://index.docker.io` is the address of official image registry, you can also set it to the others.