Skip to content

Commit f27c212

Browse files
wan92henwan92hen
committed
init
0 parents  commit f27c212

22 files changed

+1384
-0
lines changed

‎LICENSE

+339
Large diffs are not rendered by default.

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# MeterSphere Docs

‎docs/about/changelog.md

+750
Large diffs are not rendered by default.

‎docs/about/contact.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# 联系方式
2+
3+
## 商业支持
4+
5+
6+
[阿里云市场购买][aliyun]
7+
8+
## QQ群
9+
10+
- 群1: 390139816 (满)
11+
- 群2: 399218702 (满)
12+
- 群3: 552054376 (满)
13+
- 群4: 794442067 (满)
14+
- 群5: 773866691 (满)
15+
- [群6: 908100817 (新)][6群]
16+
17+
## 项目地址
18+
19+
- [jumpserver][jumpserver] ![jumpserver stars][jumpserver stars]
20+
21+
---
22+
23+
- http://www.jumpserver.org
24+
- [email protected]
25+
- 400-052-0755
26+
27+
[aliyun]: https://market.aliyun.com/products/53690006/cmgj026011.html
28+
[6群]: https://shang.qq.com/wpa/qunwpa?idkey=7156e710f7087c5f20e29bcdb5951743956837c71bc7ed8557a5215daab2725b
29+
[jumpserver]: https://github.com/jumpserver/jumpserver
30+
[jumpserver stars]: https://img.shields.io/github/stars/jumpserver/jumpserver.svg

‎docs/css/extra.css

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
.progress-label {
2+
position: absolute;
3+
text-align: center;
4+
font-weight: 700;
5+
width: 100%;
6+
margin: 0;
7+
line-height: 1.2rem;
8+
white-space: nowrap;
9+
overflow: hidden;
10+
}
11+
12+
.progress-bar {
13+
height: 1.2rem;
14+
float: left;
15+
background-color: #2979ff;
16+
}
17+
18+
.progress {
19+
display: block;
20+
width: 100%;
21+
margin: 0.5rem 0;
22+
height: 1.2rem;
23+
background-color: #eeeeee;
24+
position: relative;
25+
}
26+
27+
.progress.thin {
28+
margin-top: 0.9rem;
29+
height: 0.4rem;
30+
}
31+
32+
.progress.thin .progress-label {
33+
margin-top: -0.4rem;
34+
}
35+
36+
.progress.thin .progress-bar {
37+
height: 0.4rem;
38+
}
39+
40+
.progress-100plus .progress-bar {
41+
background-color: #00e676;
42+
}
43+
44+
.progress-80plus .progress-bar {
45+
background-color: #fbc02d;
46+
}
47+
48+
.progress-60plus .progress-bar {
49+
background-color: #ff9100;
50+
}
51+
52+
.progress-40plus .progress-bar {
53+
background-color: #ff5252;
54+
}
55+
56+
.progress-20plus .progress-bar {
57+
background-color: #ff1744;
58+
}
59+
60+
.progress-0plus .progress-bar {
61+
background-color: #f50057;
62+
}

‎docs/dev_manual.md

Whitespace-only changes.

‎docs/faq.md

Whitespace-only changes.

‎docs/img/facio.ico

1.59 KB
Binary file not shown.

‎docs/img/layout.png

206 KB
Loading

‎docs/img/logo-white.png

34.7 KB
Loading

‎docs/img/ms-logo-default.png

2.85 KB
Loading

‎docs/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 总体介绍
2+
3+
欢迎使用 MeterSphere。
4+
5+
MeterSphere 是一站式的开源企业级持续测试平台，涵盖测试用例管理、接口测试、性能测试、Mock 服务等功能，兼容JMeter 等开源标准，有效助力开发和测试团队充分利用云弹性进行高度可扩展的自动化测试，加速高质量软件的交付。

‎docs/quick_start.md

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
我们为用户准备了可以快速部署 MeterSphere 所有组件及所需的中间件的安装包。安装包分为包含 docker 镜像及不包含 docker 镜像两个版本，你可以根据自己的网络情况选择不同的安装包进行下载，快速部署并体验 MeterSphere 所提供的功能。
2+
3+
* 包含 docker 镜像的安装包：该安装包中附带了 MeterSphere 所需的所有 docker 镜像。如果你的部署环境无法访问外网，可以选择下载该离线包并上传到目标服务器上进行完全离线的部署。
4+
* 不包含 docker 镜像的安装包：该安装包只包含了必要的安装脚本、配置文件及其他必要软件。如果你的部署环境可以访问外网，可以选择下载该离线包并上传到目标服务器，通过在线拉取 docker 镜像的方式进行部署。
5+
6+
## 部署服务器要求
7+
8+
!!! info "部署服务器要求"
9+
* 操作系统: 任何支持 Docker 的 Linux x64
10+
* CPU/内存: 2核4G（最小）
11+
* 磁盘空间: 20G
12+
13+
## 安装步骤
14+
15+
### 下载安装包
16+
17+
从安装包下载地址下载最新的安装包，上传至目标服务器任意目录并解压
18+
```sh
19+
tar zxvf metersphere-release.tar.gz
20+
```
21+
22+
### 修改安装配置（可选）
23+
24+
进入安装包解压后的目录，编辑修改安装参数
25+
26+
```sh
27+
cd metersphere-release
28+
vim install.conf
29+
```
30+
31+
??? info "安装配置文件说明, 如果无特殊需求可以不进行修改采用默认参数安装"
32+
```vim
33+
# MeterSphere 安装目录的上级目录, MeterSphere 将安装在 ${base_dir}/metersphere 目录中
34+
#base_dir=/opt
35+
# MeterSphere 相关组件所使用 Docker 镜像的镜像标签
36+
#metersphere_image_tag
37+
# 安装模式, 支持的安装模式有 allinone | server | node_controller 三种
38+
#install_mode=allinone
39+
# MeterSphere Server 组件的服务端口
40+
#metersphere_server_port=8081
41+
# 是否使用外部 MySQL 数据库
42+
#external_mysql=false
43+
# MySQL 数据库地址, 仅在 external_mysql=true 时有效
44+
#mysql_host=mysql
45+
# MySQL 数据库端口, 仅在 external_mysql=true 时有效
46+
#mysql_port=3306
47+
# MySQL 数据库名称, 仅在 external_mysql=true 时有效
48+
#mysql_dbname=metersphere
49+
# MySQL 数据库用户名, 仅在 external_mysql=true 时有效
50+
#mysql_username=root
51+
# MySQL 数据库密码, 仅在 external_mysql=true 时有效
52+
#mysql_password=Password123@mysql
53+
# 是否使用外部 Kafka
54+
#external_kafka=false
55+
# 用于接收性能测试结果数据的 Kafka Topic 名称, 仅在 external_kafka=true 时有效
56+
#kafka_topic=JMETER_METRICS
57+
# Kafka 连接地址, 仅在 external_kafka=true 时有效
58+
#kafka_host=本机IP地址
59+
# Kafka 连接端口, 仅在 external_kafka=true 时有效
60+
#kafka_port=19092
61+
# 用于接收性能测试日志数据的 Kafka Topic 名称, 仅在 external_kafka=true 时有效
62+
#kafka_log_topic=JMETER_LOGS
63+
```
64+
65+
在安装包解压后所在目录，执行如下命令
66+
67+
```sh
68+
./msctl.sh install
69+
```
70+
71+
安装脚本默认使用 /opt/metersphere 目录作为安装目录，MeterSphere 的配置文件、数据及日志等均存放在该安装目录
72+
73+
## 登录并使用
74+
75+
### 登录
76+
77+
安装成功后，通过浏览器访问如下页面登录 MeterSphere
78+
79+
```
80+
地址: http://目标服务器IP地址
81+
用户名: admin
82+
密码: metersphere
83+
```
84+
85+
### 界面说明
86+
87+
![界面说明](./img/layout.png)
88+
89+
### 维护项目信息
90+
91+
1. 点击页面最上方的「测试跟踪」菜单，在下方的项目下拉列表中选择「创建」项目
92+
2. 输入项目基本信息，点击「确定」按钮，完成项目创建
93+
94+
### 跟踪测试计划
95+
96+
#### 测试用例管理
97+
98+
1. 在「测试跟踪」功能下的「测试用例」下拉列表中，选择「显示全部」，弹出项目中的所有测试用例
99+
2. 点击左侧用例模块树的「新建模块」按钮，创建一个新的用例模块
100+
3. 点击右侧列表中的「新建用例」按钮，在弹出的用例信息编辑页面中填写用例基本信息，点击「确定」完成用例创建
101+
102+
#### 测试计划管理
103+
104+
1. 在「测试跟踪」功能下的「测试计划」下拉列表中，选择「创建测试计划」，弹出测试计划编辑页面
105+
2. 填写测试计划的基本信息，并选择测试计划的所属项目及测试阶段，点击「确定」按钮完成测试计划创建
106+
3. 在测试计划列表中点击某一测试计划，进入测试计划详情页面
107+
4. 点击右侧测试用例列表中的关联测试用例按钮，在弹出的测试用例列表中，选择项目中的测试用例添加至该测试计划
108+
5. 添加成功后即可在测试用例列表查看到已添加的测试用例
109+
6. 点击某个测试用例所在行的编辑按钮，进行测试用例结果更新
110+
7. 当所有测试用例结果均更新后，即可点击用例列表中的查看测试报告按钮，查看此次测试计划的测试报告
111+
112+
### 执行接口测试
113+
114+
### 执行性能测试
115+

‎docs/user_manual/api_test.md

Whitespace-only changes.

‎docs/user_manual/installation.md

Whitespace-only changes.

‎docs/user_manual/performance_test.md

Whitespace-only changes.

‎docs/user_manual/system_arch.md

Whitespace-only changes.

‎docs/user_manual/system_management.md

Whitespace-only changes.

‎docs/user_manual/test_track.md

Whitespace-only changes.

‎mkdocs.yml

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
site_name: 'MeterSphere 文档'
2+
site_url: 'https://metersphere.io'
3+
site_description: 'Document'
4+
site_author: 'wangzhen'
5+
6+
repo_name: 'MeterSphere Docs'
7+
repo_url: 'https://github.com/metersphere/docs'
8+
9+
theme:
10+
name: 'material'
11+
logo: 'img/logo-white.png'
12+
favicon: 'img/facio.ico'
13+
language: 'zh'
14+
highlightjs: true
15+
hljs_languages:
16+
- yaml
17+
- django
18+
19+
nav:
20+
- 介绍: index.md
21+
- 快速开始: quick_start.md
22+
- 用户手册:
23+
- 系统架构: user_manual/system_arch.md
24+
- 安装部署: user_manual/installation.md
25+
- 系统管理: user_manual/system_management.md
26+
- 测试跟踪: user_manual/test_track.md
27+
- 接口测试: user_manual/api_test.md
28+
- 性能测试: user_manual/performance_test.md
29+
- 常见问题: faq.md
30+
- 开发文档: dev_manual.md
31+
- 关于:
32+
- 更新说明: about/changelog.md
33+
- 联系我们: about/contact.md
34+
35+
markdown_extensions:
36+
- admonition
37+
- codehilite:
38+
guess_lang: True
39+
linenums: False
40+
- toc:
41+
permalink: True
42+
- footnotes
43+
- attr_list
44+
- def_list
45+
- tables
46+
- abbr
47+
- md_in_html
48+
- pymdownx.extra
49+
- pymdownx.arithmatex
50+
- pymdownx.betterem:
51+
smart_enable: all
52+
- pymdownx.caret
53+
- pymdownx.critic
54+
- pymdownx.details
55+
- pymdownx.emoji:
56+
emoji_generator: !!python/name:pymdownx.emoji.to_png
57+
- pymdownx.inlinehilite
58+
- pymdownx.magiclink
59+
- pymdownx.mark
60+
- pymdownx.smartsymbols
61+
- pymdownx.superfences
62+
- pymdownx.tasklist
63+
- pymdownx.tilde
64+
- pymdownx.betterem
65+
- pymdownx.superfences
66+
- pymdownx.progressbar
67+
68+
extra_css:
69+
- css/extra.css
70+
71+
copyright: Copyright &copy; 2014-2020 <a href="https://www.fit2cloud.com">杭州飞致云信息科技有限公司</a>, All Rights Reserved. <a href="http://www.beian.miit.gov.cn" target="_blank">京ICP备15023818号</a>
72+
73+
plugins:
74+
- search

‎readthedocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
build:
2+
image: latest
3+
4+
requirements_file: requirements/requirements.txt

‎requirements/requirements.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
mkdocs >= 1.1
2+
mkdocs-material
3+
mdx_gh_links
4+
markdown

0 commit comments

Comments
 (0)