From cb7459d281a49a8c109997137c7b251464e9caae Mon Sep 17 00:00:00 2001
From: fxiang21
Date: Fri, 2 Feb 2024 14:09:28 +0800
Subject: [PATCH] doc: change readme
---
README.md | 13 +++++++++----
README_cn.md | 22 ++++++++++++----------
img.png => docs/images/img.png | Bin
img_1.png => docs/images/img_1.png | Bin
docs/images/img_2.png | Bin 0 -> 9096 bytes
docs/images/img_3.png | Bin 0 -> 9096 bytes
{backend/docs => docs}/images/wechat.jpg | Bin
7 files changed, 21 insertions(+), 14 deletions(-)
rename img.png => docs/images/img.png (100%)
rename img_1.png => docs/images/img_1.png (100%)
create mode 100644 docs/images/img_2.png
create mode 100644 docs/images/img_3.png
rename {backend/docs => docs}/images/wechat.jpg (100%)
diff --git a/README.md b/README.md
index 656e313..0e662c4 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,12 @@
-oneterm Provide secure access and control over all infrastructure
+
+**`OneTerm`** Bastion Host, based on the 4A concept, i.e., Authentication, Authorization, Account, and Audit, is designed and developed.
+
+`Main use`: It is mainly used for products that enhance IT internal control and compliance security by implementing control and audit of IT personnel's operating behaviors in enterprises.
+
+`Main functions`: role management, authorization approval, resource access control, session audit, etc.
---
@@ -15,7 +20,7 @@ oneterm Provide secure access and control over all infrastructure
```bash
git clone https://github.com/veops/oneterm.git
cd oneterm
-docker compose up -d
+docker-compose up -d
```
## ✅ Validation
@@ -40,10 +45,10 @@ ssh-keygen -t ed25519 # Generate the key following the prompts
cat /root/.ssh/id_ed25519.pub # Copy the public key. The public key address is obtained from the generation process as shown in the previous step
ifconfig | grep -B1 "xxx.xxx.xxx.xxx" | awk '/ether/{print $2}' # Get the MAC address, replace xxx.xxx.xxx.xxx with your local IP
```
-
+
2. Place the public key and MAC on the platform
- 
+ 
### More Streamlined Login Method
```shell
diff --git a/README_cn.md b/README_cn.md
index e55c47e..7816434 100644
--- a/README_cn.md
+++ b/README_cn.md
@@ -4,7 +4,12 @@
-oneterm 简单、轻量、安全的跳板机服务
+
+**`OneTerm`** 堡垒机,基于4A理念,即认证(Authen)、授权(Authorize)、账号(Account)、审计(Audit)设计开发。
+
+`主要用途`:主要用于企业通过实现对IT人员操作行为的控制和审计来提升IT内部控制、合规安全性的产品。
+
+`主要功能`:角色管理、授权审批、资源访问控制、会话审计等。
---
@@ -15,7 +20,7 @@ oneterm 简单、轻量、安全的跳板机服务
```bash
git clone https://github.com/veops/oneterm.git
cd oneterm
-docker compose up -d
+docker-compose up -d
```
## ✅验证
@@ -38,10 +43,11 @@ ssh-keygen -t ed25519 # 根据提示生成key
cat /root/.ssh/id_ed25519.pub # 拷贝公钥, 公钥地址从上一步生成的过程中获取,如下图所示
ifconfig | grep -B1 "xxx.xxx.xxx.xxx" | awk '/ether/{print $2}' # 获取mac地址, 其中xxx.xxx.xxx.xxx换成您本机的IP
```
-
+
+
2. 将公钥和mac放在平台上
-
+
### 更精简的的登录方式
```shell
@@ -60,10 +66,6 @@ Host oneterm
User admin # 此处替换为您oneterm上的平台用户
```
-
-
-
-
## 📚产品文档
文档地址:https://veops.cn/docs/docs/oneterm/onterm_design
@@ -75,10 +77,10 @@ Host oneterm
## 🔗相关项目
-[go-ansiterm](https://github.com/veops/go-ansiterm):linux终端仿真器
+[go-ansiterm](https://github.com/veops/go-ansiterm):linux终端仿真器,主要是根据终端输入和服务器回显解析命令
## 🤝社区交流
**欢迎关注公众号(维易科技OneOps),关注后可加入微信群,进行产品和技术交流。**
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/img.png b/docs/images/img.png
similarity index 100%
rename from img.png
rename to docs/images/img.png
diff --git a/img_1.png b/docs/images/img_1.png
similarity index 100%
rename from img_1.png
rename to docs/images/img_1.png
diff --git a/docs/images/img_2.png b/docs/images/img_2.png
new file mode 100644
index 0000000000000000000000000000000000000000..675ab3a378e4b7c1dd898d924254f7557a120370
GIT binary patch
literal 9096
zcma*NRZtvX)b1S;f``G~ZE$yY2A7Z!90CLg?(PJb;0&$-hTsqg&fppX!GgPG7#s%I
z!~cEj`>xK#Sr@xj*Y4`B?p3{eujl!Jb+lC8U{PSbc=6(mDo9c9#S4_e=UfB>?RhL&
zzhHgwf>B#lQBL32>@d$K_1#R$U{+S+>b=0vPqU-hhR0Gt${N~4f!~{R`H~~HbBQri
z1Y%;sL3ld9KuJ{07_6*nc*%4u?kRNSj@f_0w1h4yr{V5mSKcosX%MCkL4rZ!VgYkn
z7w=|P;ojgC;Lm}c|Dupp=i?mM(arV0V8u!WsgnNxIUZ0eSJZ728q=SgMEGCM#_z_o
z-4A}wziLonin(p}gCPurD)Rq(+VFN;lFs}02__@MDX9$_s%pQIBBAO81-t9(u3n&w
zmcNc*?UAHyT5r(anNmuVYZR2ry+t?a_LN_B(MNVjOl4EA-f@%>E_d211kv%ra8^y(KI(uJXU?+iAu5!HLh%mkl&
zN;!YbW4gRH1gnlV)FoyD1~8bzxAl@(uRz%;+9u&Dl07e}si=W0t&1%y5<-Q
zB#4{EmXjgB;oospz~r`K1nxm#tQu=1@nFhvfq#+XBLs_R^*pjD5GK{K
z%8JTzN>o%|IV1_PU9%$5yuFw_i+e%4Db|8Ka1bl$O$uJJI`8YD8E(2jN4?Jp9e7kQG=jIH!cR*|X}e+4yTs3jDL;w24p|&N
zsx{3}-rrw^SJD@*`NN*N=(zb9*SuVXVzfu<#R%{3GZ>^>@pi-szRKn^p^8PSu-zAQ
z+o(SQR|dSUE8V
zOf=Ho6;!3wc6CT^JvfkW?Z5fAkpG~v-A7!xbKZJwF4)ZdxvP5mrqywPeSduY!r}GS
z>CEi0^+oCa+1&W^n=4AeLo`{a46^h8WSDl%5phY^D^dGZ-Mq>kaywmMeX`y|v9Uc|
zqMpIT#dU}UEiGMY{Kmwh^8JBI5)d+YaHCi0?Ih;C85lYFBqpr1H(LpG=@L-xPz3uv
z`o9XA4XHC6$>8BxJDe}YK2}SldN4bhGjH?Ww?qO(qiaN1X^ZtsolVIloKu)e9@>KN
zC__|*oo?RG20kkFH=2j{CgBAI9Bhy4H5v(JiG!QBnByx&Cp9$$~t{yQ)Z
zCqvO=l#}Y)D6L_Qt?%p5^86>D$FV9jGS<4elGK7~%G+_L)@5MUc*hD@2?CH5&$p-&
zl1qJ(kBOX^(_U}|T%mcLO&i?f`1b}cM!+NNMUL`rA35z88?w09MceTYhcMLDbW
z7WEB&5Y;O86Vf^_#08g}+i9_3dR#!k#@yNJ)6uo!EMk9a{M}RVT~>*M#lLMlOdHsw
z>ACPU(%tyyb}Ub`y>TU6`~|r|Ds|PI=LogRG0mcXs|$}!EKZ0+>YswaUefQ%O#_sW
zlN-VSC1Wz|TCNR`DO#(M!jOlxJ}(X&)};_`&AV_`4BM^sM4*BPe_-4M{k>nv;Q|@_
zGUDonSuF58?m)_w^DpVf7CaGu{DiQbNLt3pdAn(@7CR_`N`k{{?{At?Y=$v;&t;@+
z9%e#hFMe92Xe)^pmLglAg0~;vkBjw{#U7~Y;>J#F`1X!%sJEiL)^pbiqXHJGnQJs|$Q%WbqN`bECIzqUEK
zh-E$19RI_>ptb4EsqLBC)7+cqk6zN+E<(JRHhJX!i+YJcL9o#pui?*2b!6tmPR{Y=
zaR1e6hSQSI$ixQYOvD~fY(@>v%qvijkmEe)`*@~<;y`1fj3Ec3a%W{*2XO6po<}oB
z2#}2DpTeEf8+UKD%k-QJC`$K7K6bce-`-bLeNy
z67VUcx>rS10s{Qs>m&KDnGPQqmJ_iop)jXls-4jcDp_o75`k2SOE1p!kPis
zEx
zWV4v7!Q*B`+w*=c*=H!OnTW98WnVL1#Kw8yGD736t#wgTbQ6zhr<${yeFchsUnK}h3{M7dF8MadwN*+fMiKSoU+7D~ZH-+4oqO(hd-l0VIRlWy#s
ze0SVs{_js7C9Fi2USX)b{hPZqFL#a?-*O;wOuQ!}>lEcDoI54QxlI*4xH-2giFGVn
zhUaSK%0Ot8YiDwZCIeUysCHSVYvYzDNzD;YDFO*NYE`LiPAbh0USw!!+!s-=K=a%0
znr8^P`E9<9u+2}yBIZ!-Q`X$RTyimBaI%6B9iuUJBf0WjN@%PF+Mn_!@noT-Xl6l9
zNz2|#PHnyvpdI#^gD0!OE+F~dm!i9Z$7>Zf@&E`(*g;K(@$ZSJ87Sf
z#|`8Eb_HyHr@zyNReK)%HC&q1sL(I}XdRIe{4Wp&TRwhQZqk~9?-ZLpzT|bO5m9;S%clAUd3FQ<@WENsbTpm0p|^E
zTDxQ(Au|;-aTwtF7^==?*a|4ut~@+_O#|Hi7GCpyO<-KIm`QvUhc;8lCk!!P_m