Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improvements to the homepage description #13

Merged
merged 1 commit into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/basic/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,17 @@ docker run -d --name guacd -p 4822:4822 guacamole/guacd

## Download

The source code of Casvisor is hosted on GitHub: <https://github.com/casbin/casvisor>. Both the Go backend code and React frontend code are contained in a single repository.
The source code of Casvisor is hosted on GitHub: <https://github.com/casvisor/casvisor>. 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 | <https://github.com/casbin/casvisor/tree/master/web> |
| Backend | RESTful API backend for Casdoor | Golang + Beego + XORM | <https://github.com/casbin/casvisor> |
| Frontend | Web frontend UI for Casdoor | JavaScript + React | <https://github.com/casvisor/casvisor/tree/master/web> |
| Backend | RESTful API backend for Casdoor | Golang + Beego + XORM | <https://github.com/casvisor/casvisor> |

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
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 @@ -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
Expand Down Expand 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

Expand Down
20 changes: 16 additions & 4 deletions docs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
16 changes: 8 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: "",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -126,7 +126,7 @@ module.exports = {
items: [
{
label: "GitHub",
href: "https://github.com/casbin/casvisor",
href: "https://github.com/casvisor/casvisor",
},
{
label: "Discord",
Expand All @@ -151,7 +151,7 @@ module.exports = {
},
{
label: "GitHub",
href: "https://github.com/casbin/casvisor",
href: "https://github.com/casvisor/casvisor",
},
{
html: `
Expand Down Expand Up @@ -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: {
Expand Down
13 changes: 7 additions & 6 deletions src/components/HomepageFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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: (
<>
<Translate>
detail description
Easily manage user access and control asset permissions with Casdoor. Streamline user management and ensure secure, authorized access to your assets.
</Translate>
</>
),
},
{
title: translate({
message: "Feature 2",
message: "Remote Asset Management",
}),
path: "/img/storage",
description: (
<>
<Translate>
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.
</Translate>
</>
),
},
{
title: translate({
message: "Feature 3",
message: "Audit Logging & Monitoring",
}),
path: "/img/language",
description: (
<>
<Translate>
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.
</Translate>
</>
),
Expand Down
2 changes: 1 addition & 1 deletion src/pages/help.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ function Help() {
</div>
<div className="col">
<h2>Github</h2>
<Translate>At our</Translate> <a href="https://github.com/casbin/casvisor"><Translate>GitHub repo</Translate></a><Translate>, browse and submit</Translate> <a href="https://github.com/casbin/casvisor/issues">issues</a> or <a href="https://github.com/casbin/casvisor/pulls">pull requests</a> <Translate>for bugs you find or any new features you may want implemented.</Translate>
<Translate>At our</Translate> <a href="https://github.com/casvisor/casvisor"><Translate>GitHub repo</Translate></a><Translate>, browse and submit</Translate> <a href="https://github.com/casvisor/casvisor/issues">issues</a> or <a href="https://github.com/casvisor/casvisor/pulls">pull requests</a> <Translate>for bugs you find or any new features you may want implemented.</Translate>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function HomepageHeader() {
<br />
<p className="hero__subtitle" style={{margin: "0 auto", maxWidth: 700}}>
<Translate>
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
</Translate>
</p>
<br />
Expand Down Expand Up @@ -76,7 +76,7 @@ export default function Home() {
return (
<Layout
title={"Casvisor"}
description="An open-source security log auditing & RDP, VNC, SSH bastion platform">
description="An open-source security log auditing & RDP, VNC, SSH and databases management bastion platform">
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
Loading