Skip to content

Commit

Permalink
docs: add database.md (#12)
Browse files Browse the repository at this point in the history
* docs: add database.md

* docs: add database.md
  • Loading branch information
leo220yuyaodog authored Mar 16, 2024
1 parent 2922c11 commit 52ff009
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 5 deletions.
22 changes: 22 additions & 0 deletions docs/asset/database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Database
description: Connect to your databases
keywords: [Casvisor, database, mysql, redis]
authors: [leo220yuyaodog]
---

The section will tell you how to add a database asset and connect to your database.

## Config database asset

1. In asset list page, click `Add` button to add a new asset.
2. Select `Database` in the `Category` dropdown list.
3. Select the database type in the `Database type` dropdown list, such as `MySQL`, `MariaDB`, `PostgreSQL`, `Microsoft SQL Server`, `Redis`, `MongoDB`.
4. Fill in the required fields that connect to your database.

![config database](/img/asset/database/config_databse.png)

## Connect to database

- In asset list page, click the `Connect` button to connect to your database.
- In the workbench, click the database asset to connect to your database.
31 changes: 28 additions & 3 deletions docs/asset/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,35 @@ keywords: [assets]
authors: [leoil]
---

Casvisor helps you to manage assets, and connect to your assets remotely, it currently supports the following protocols:
Casvisor helps you to manage assets, and connect to your assets remotely, including remote desktop via RDP, VNC, SSH, and databases.

* RDP
* VNC
**Machine**:

- SSH
- RDP
- VNC

**Database**:

- MySQL
- MariaDB
- PostgreSQL
- Microsoft SQL Server
- Redis
- MongoDB

Every asset has the following basic properties:

- `Organization`: The organization that the asset belongs to.
- `Name`: The unique asset name.
- `Display name`: The display name of the asset.
- `Category`: The category of the asset, including `Machine` and `Database`.
- `Endpoint`: Domain name or IP address.
- `Port`: The port number of the asset.
- `Username`: The username to connect to the asset, such as `root`, `administrator`, `sa`, etc.
- `Password`: The password to connect to the asset.
- `OS`: The operating system of the asset, including `Windows` and `Linux`, used to classify the asset.
- `Tag`: The tag of the asset, used to classify the asset.

In this chapter, you will learn how to start connecting to your assets.

Expand Down
4 changes: 2 additions & 2 deletions docs/basic/try-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@ Create `conf/app.conf`. You can copy it from [conf/app.conf](https://github.com/
Then run

```bash
docker run -p 19000:19000 -v /folder/of/app.conf:/conf casbin/casvisor:latest
docker run -p 19000:19000 -v /folder/of/app.conf:/home/casvisor/conf casbin/casvisor:latest
```

Anyway, just **mount the app.conf to /conf/app.conf** and start the container.
Anyway, just **mount the folder of app.conf to /home/casvisor/conf** and start the container.

:::tip

Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ module.exports = {
"asset/overview",
"asset/rdp",
"asset/vnc",
"asset/database",
],
},
],
Expand Down
Binary file added static/img/asset/database/config_databse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 52ff009

Please sign in to comment.