From 47ded95b35b77ae3cb3275b96d377e5e2c3b33f7 Mon Sep 17 00:00:00 2001 From: Yaodong Yu <2814461814@qq.com> Date: Mon, 25 Mar 2024 09:45:58 +0800 Subject: [PATCH] docs: improvements to the homepage description --- docs/basic/installation.md | 8 ++++---- docs/basic/try-with-docker.md | 4 ++-- docs/overview.mdx | 20 ++++++++++++++++---- docusaurus.config.js | 16 ++++++++-------- src/components/HomepageFeatures/index.js | 13 +++++++------ src/pages/help.js | 2 +- src/pages/index.js | 4 ++-- 7 files changed, 40 insertions(+), 27 deletions(-) diff --git a/docs/basic/installation.md b/docs/basic/installation.md index c3367b1..d3a9669 100644 --- a/docs/basic/installation.md +++ b/docs/basic/installation.md @@ -50,17 +50,17 @@ docker run -d --name guacd -p 4822:4822 guacamole/guacd ## Download -The source code of Casvisor is hosted on GitHub: . Both the Go backend code and React frontend code are contained in a single repository. +The source code of Casvisor is hosted on GitHub: . Both the Go backend code and React frontend code are contained in a single repository. | Name | Description | Language | Source code | |----------|---------------------------------|-----------------------|------------------------------------------------------| -| Frontend | Web frontend UI for Casdoor | JavaScript + React | | -| Backend | RESTful API backend for Casdoor | Golang + Beego + XORM | | +| Frontend | Web frontend UI for Casdoor | JavaScript + React | | +| Backend | RESTful API backend for Casdoor | Golang + Beego + XORM | | Casvisor supports `Go Modules`. To download the code, simply clone the code using git: ```shell -git clone https://github.com/casbin/casvisor +git clone https://github.com/casvisor/casvisor ``` ## Configuration diff --git a/docs/basic/try-with-docker.md b/docs/basic/try-with-docker.md index b72e515..afaea7f 100644 --- a/docs/basic/try-with-docker.md +++ b/docs/basic/try-with-docker.md @@ -80,7 +80,7 @@ Note: The above command utilizes Linux tools like `curl`, `sed`, `grep`, and `aw ::: -You can use [docker-compose.yml](https://github.com/casbin/casvisor/blob/master/docker-compose.yml) in the official repository. Create a `conf/app.conf` directory in the same directory level as the `docker-compose.yml` file. Then, copy [app.conf](https://github.com/casbin/casvisor/blob/master/conf/app.conf) from Casvisor. For more details about `app.conf`, you can see [configuration](/docs/basic/installation#configuration). +You can use [docker-compose.yml](https://github.com/casvisor/casvisor/blob/master/docker-compose.yml) in the official repository. Create a `conf/app.conf` directory in the same directory level as the `docker-compose.yml` file. Then, copy [app.conf](https://github.com/casvisor/casvisor/blob/master/conf/app.conf) from Casvisor. For more details about `app.conf`, you can see [configuration](/docs/basic/installation#configuration). ```bash docker-compose up @@ -108,7 +108,7 @@ docker run \ #### Run Casvisor -Create `conf/app.conf`. You can copy it from [conf/app.conf](https://github.com/casbin/casvisor/blob/master/conf/app.conf) in Casvisor. For more details about `app.conf`, you can see [configuration](/docs/basic/installation#configuration). +Create `conf/app.conf`. You can copy it from [conf/app.conf](https://github.com/casvisor/casvisor/blob/master/conf/app.conf) in Casvisor. For more details about `app.conf`, you can see [configuration](/docs/basic/installation#configuration). Then run diff --git a/docs/overview.mdx b/docs/overview.mdx index e54fa2f..d46ca8a 100644 --- a/docs/overview.mdx +++ b/docs/overview.mdx @@ -7,11 +7,23 @@ authors: [casbin] ## Overview -An open-source security log auditing & RDP, VNC, SSH bastion platform: +Casvisor is an open-source platform that provides security log auditing and bastion functionality for managing RDP, VNC, SSH, and databases. ## Casvisor Features -1. Asset managment: - Remote connection via RDP, VNC protocols. +### Asset Management -2. Log managment +- Easily manage and connect to assets using RDP, VNC, and SSH protocols. +- Efficiently handle remote connections to machines. + +### Security Log Auditing + +- Track and monitor remote connections with detailed audit logging. +- Record the start time, duration, and other relevant information of each connection. +- Capture and analyze API logs for Casdoor operations. + +### Database Management + +- Connect and manage databases within Casvisor. +- Efficiently organize and control access to databases. +- Simplify user management and authorization for database resources. diff --git a/docusaurus.config.js b/docusaurus.config.js index 68b63f9..4a967e5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -3,20 +3,20 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); /** @type {import('@docusaurus/types').DocusaurusConfig} */ module.exports = { - title: "Casvisor · An open-source security log auditing & RDP, VNC, SSH bastion platform", + title: "Casvisor · An open-source security log auditing & RDP, VNC, SSH and databases management bastion platform", url: "https://casvisor.org", baseUrl: "/", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.png", - organizationName: "casbin", // Usually your GitHub org/user name. + organizationName: "casvisor", // Usually your GitHub org/user name. projectName: "casvisor-website", // Usually your repo name. i18n: { defaultLocale: "en", locales: ["en", "zh", "fr", "de", "ko", "ru", "ja"], }, themeConfig: { - metadata: [{name: "Casvisor", content: "An open-source security log auditing & RDP, VNC, SSH bastion platform"}], + metadata: [{name: "Casvisor", content: "An open-source security log auditing & RDP, VNC, SSH and databases management bastion platform"}], // algolia: { // appId: "", // apiKey: "", @@ -80,7 +80,7 @@ module.exports = { ], }, { - href: "https://github.com/casbin/casvisor", + href: "https://github.com/casvisor/casvisor", position: "right", className: "header-github-link", "aria-label": "GitHub repository", @@ -126,7 +126,7 @@ module.exports = { items: [ { label: "GitHub", - href: "https://github.com/casbin/casvisor", + href: "https://github.com/casvisor/casvisor", }, { label: "Discord", @@ -151,7 +151,7 @@ module.exports = { }, { label: "GitHub", - href: "https://github.com/casbin/casvisor", + href: "https://github.com/casvisor/casvisor", }, { html: ` @@ -215,13 +215,13 @@ var _hmt = _hmt || []; sidebarPath: require.resolve("./sidebars.js"), sidebarCollapsed: false, editUrl: ({docPath}) => { - return `https://github.com/casbin/casvisor-website/edit/master/docs/${docPath}`; + return `https://github.com/casvisor/casvisor-website/edit/master/docs/${docPath}`; }, }, blog: { showReadingTime: true, editUrl: ({blogDirPath, blogPath}) => { - return `https://github.com/casbin/casvisor-website/edit/master/${blogDirPath}/${blogPath}`; + return `https://github.com/casvisor/casvisor-website/edit/master/${blogDirPath}/${blogPath}`; }, }, theme: { diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js index 29cc4a6..2f595ad 100644 --- a/src/components/HomepageFeatures/index.js +++ b/src/components/HomepageFeatures/index.js @@ -7,39 +7,40 @@ import {useColorMode} from "@docusaurus/theme-common"; const FeatureList = [ { title: translate({ - message: "Feature 1", + message: "Single Sign-On & User Asset Authorization", }), path: "/img/model", description: ( <> - detail description + Easily manage user access and control asset permissions with Casdoor. Streamline user management and ensure secure, authorized access to your assets. ), }, { title: translate({ - message: "Feature 2", + message: "Remote Asset Management", }), path: "/img/storage", description: ( <> - detail description + Simplify asset management with Casvisor. Easily connect to machines using RDP, SSH, and VNC protocols for + efficient remote desktop access and establish convenient connections to databases. ), }, { title: translate({ - message: "Feature 3", + message: "Audit Logging & Monitoring", }), path: "/img/language", description: ( <> - detail description + Monitor and log remote connections with comprehensive auditing in Casvisor. Keep track of connection start time, duration, and API logs for Casdoor operations. ), diff --git a/src/pages/help.js b/src/pages/help.js index 666a162..54edf79 100644 --- a/src/pages/help.js +++ b/src/pages/help.js @@ -40,7 +40,7 @@ function Help() {

Github

- At our GitHub repo, browse and submit issues or pull requests for bugs you find or any new features you may want implemented. + At our GitHub repo, browse and submit issues or pull requests for bugs you find or any new features you may want implemented.
diff --git a/src/pages/index.js b/src/pages/index.js index 57076fb..3ff4866 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -17,7 +17,7 @@ function HomepageHeader() {

- An open-source security log auditing & RDP, VNC, SSH bastion platform + An open-source security log auditing & RDP, VNC, SSH and databases management bastion platform


@@ -76,7 +76,7 @@ export default function Home() { return ( + description="An open-source security log auditing & RDP, VNC, SSH and databases management bastion platform">