Skip to content

Commit

Permalink
docs: improve Intranet.md (#17)
Browse files Browse the repository at this point in the history
* docs: improve Intranet.md

* docs: improve Intranet.md
  • Loading branch information
leo220yuyaodog authored Aug 3, 2024
1 parent c99cea7 commit 544b6e2
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions docs/asset/intranet.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,18 @@ If you want start the NAT traversal service, you need to add `gatewayEndpoint` i
- The host is your Casvisor server public IP or domain.
- The port is the port that listens to the Casvisor agent connection request.

For example:

```ini
gatewayEndpoint = "<host>:<port>"
gatewayEndpoint = door.casvisor.com:19100
```

## Config intranet asset

Fill in the required fields that connect to your intranet asset.

- Name: The **hostname** of the intranet machine.
- Name: The **hostname** of the intranet machine. When the casvisor starts, it connects to the database to check whether
the current hostname is the name of an asset, and if so, it starts in agent mode. So, make sure to fill in the correct hostname.
- Category: The category of the asset, select `Machine`.
- Protocol: The protocol of the asset, select `RDP`.
- Gateway port: The port in the Casvisor server that listens to the user's connection request.
Expand All @@ -35,13 +38,27 @@ For example, fill in Gateway port with `7000`. Then the user can connect to the
ssh <Username>@<Casvisor server public IP> -p 7000
```

- Endpoint: The host or IP of the intranet machine.
- Port: The port of the application in the intranet machine.
- Endpoint: Unlike public assets, the endpoint needs to be filled in with the application address of the private network.
If you want to use SSH or RDP to connect to the host, enter 127.0.0.1
- Port: The port of the application in the intranet machine. Port 3389 is used by RDP and 22 by SSH by default. If you
have a custom port, fill in your custom port.
- Username: The username of the application.
- Password: The password of the application.

![config](/img/asset/intranet/asset_intranet_config.png)

## Deploy Casvisor agent

Casvisor agent is the same as Casvisor server, just deploy Casvisor in your intranet machine and start it with the same `conf/app.conf` as the server.
You need to deploy a Casvisor on the host to which you are connected in the intranet. As mentioned in the previous chapter,
when the casvisor starts, it connects to the database to check whether the current hostname is the name of an asset, and
if so, it starts in agent mode. So the must configurations in the agent Casvisor `conf/app.conf` are below:

```ini
httpport = 19000
driverName =
dataSourceName =
dbName =
gatewayEndpoint = door.casvisor.com:19100
```

It is **recommended** that you can copy the same configuration file `conf/app.conf` in the server Casvisor directly.

0 comments on commit 544b6e2

Please sign in to comment.