Skip to content

Commit

Permalink
docs: update missing images (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
DVKunion authored Jan 16, 2024
1 parent ae49ee0 commit 6aa6502
Show file tree
Hide file tree
Showing 11 changed files with 189 additions and 78 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@

## 🔥 使用展示

![client](https://seamoon.oss-cn-hangzhou.aliyuncs.com/0dd37f5600364e59a9457e38eaf77b1f.png)

## 🕹 快速开始

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
home: true
heroImage: https://cdn.dvkunion.cn/SeaMoon/logo.png
heroImage: https://seamoon.oss-cn-hangzhou.aliyuncs.com/logo.png
heroText: SeaMoon - 月海
tagline: 🌕 月出于云却隐于海
actionText: 快速上手 →
Expand Down
12 changes: 6 additions & 6 deletions docs/guide/00.概述/00.introduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ article: false
## SeaMoon - 月海

![go-report](https://goreportcard.com/badge/github.com/DVKunion/SeaMoon)
![start](https://img.shields.io/github/stars/DVKunion/SeaMoon.svg)
![download](https://img.shields.io/github/downloads/dvkunion/seamoon/total?color=orange)
![language](https://img.shields.io/github/languages/top/DVKunion/SeaMoon.svg?&color=blueviolet)
![download](https://img.shields.io/github/downloads/dvkunion/seamoon/total?color=orange)
![license](https://img.shields.io/badge/LICENSE-MIT-777777.svg)
![start](https://img.shields.io/github/stars/DVKunion/SeaMoon.svg)

## ☁️ 什么是月海

Expand Down Expand Up @@ -66,10 +66,10 @@ article: false

### 其他特性

| 能力名称 | 原理文档 | 服务端支持 | 客户端支持 |
|---------------------|------|:-----:|:-----:|
| 身份认证加强保密性 | | 🐷待开发 | 🐷待开发 |
| 探活机制/心跳检测 | | 🐷待开发 | 🐷待开发 |
| 能力名称 | 原理文档 | 服务端支持 | 客户端支持 |
|-----------|------|:-----:|:-----:|
| 身份认证加强保密性 | | 🐷待开发 | 🐷待开发 |
| 探活机制/心跳检测 | | 🐷待开发 | 🐷待开发 |

更多特性相关请移步: [技术文档](https://seamoon.dvkunion.cn/tech/feature/)

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/01.开始使用/01.start.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,16 +116,16 @@ $ docker run -it -d --net=host dvkunion/seamoon-client

即可开启客户端, 点击配置管理

![](https://cdn.dvkunion.cn/seamoon/04f8a842b0c24c5e93c37c7c20f91d72.png)
![client](https://seamoon.oss-cn-hangzhou.aliyuncs.com/0dd37f5600364e59a9457e38eaf77b1f.png)

添加云端配置

![](https://cdn.dvkunion.cn/seamoon/dfcc22b01c4a4f358bdee59acc5c563b.png)
![client-config](https://seamoon.oss-cn-hangzhou.aliyuncs.com/66b1b150238e400483adf936649b7ed5.png)

> 注意,此处填写的值为 Step.2 中输出的 domain字段,并去除 http:// 协议头,属于对应域名即可。
开启socks5代理,并保持默认`:1080`不改变。

此时,你已经可以通过云函数启动socks5代理访问了。

![speed.png](https://cdn.dvkunion.cn/SeaMoon/speed2.png)
![speed](https://seamoon.oss-cn-hangzhou.aliyuncs.com/7bfff588795a4e41b488694ad4eb5153.png)
19 changes: 9 additions & 10 deletions docs/guide/02.服务部署/01.aliyun.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,38 +13,37 @@ article: false

## 如何部署

如果你了解云函数,可以使用自定义镜像 / 自定义运行时 / 二进制等等方式部署。

下文是基于对完全不了解云函数的同学给出的最简单的部署方式。

### Step.1

+ 阿里云首先要开通函数计算服务。
+ fork 该仓库(https://github.com/DVKunion/SeaMoon.git)到您自己的 github 账户下
+ 进入阿里云控制台,点击应用 -> 创建应用

![创建应用](https://cdn.dvkunion.cn/SeaMoon/deploy-aliyun-1.png)
![aliyun-create-app](https://seamoon.oss-cn-hangzhou.aliyuncs.com/66d81e68e1fa4ef9b8aa3775b4957552.png)

### Step.2

选择 `通过仓库导入应用` , 授权Github账户后,选择fork好的仓库,如果您之前没有使用过阿里云,在角色权限处还需要进行一次授权。

![导入应用](https://cdn.dvkunion.cn/SeaMoon/deploy-aliyun-2.png)
![aliyun-app-import](https://seamoon.oss-cn-hangzhou.aliyuncs.com/d00b5116362d47cdb429f91e48ab2d3a.png)

### Step.3

点击创建,等待服务部署成功,即可获取到代理地址

![img.png](https://cdn.dvkunion.cn/SeaMoon/deploy-aliyun-3.png)
![aliyun-deploy](https://seamoon.oss-cn-hangzhou.aliyuncs.com/a43730eaa80a4885a5eaee853ff3a781.png)

> 注意,socks5代理和http代理是不同的代理地址(因为是不同的云函数服务)。如果您部署了多个代理,请注意代理地址右侧会有一个`+1`,里面展示了您其他代理的地址。
>
> e.g.
> http://socks-proxy.seamon-service.xxx.xxxx.x.xx.x.x..x.x 表示是socks5代理
> http://http-proxy.seamon-service.xxx.xxxx.x.xx.x.x..x.x 表示是http代理

> 其他注意事项:
> 如果您想要修改代理生效的区域,请修改s.yaml内的 vars -> region字段
>
> 目前阿里云支持的字段有: cn-hangzhou, cn-beijing, cn-beijing, cn-hangzhou, cn-shanghai, cn-qingdao, cn-zhangjiakou, cn-huhehaote, cn-shenzhen, cn-chengdu, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1, eu-west-1, us-west-1, us-east-1, ap-south-1
[开启客户端](https://seamoon.dvkunion.cn/guide/client/), 尽情享用
[开启客户端并填入配置](https://seamoon.dvkunion.cn/guide/client/), 尽情享用

## 效果展示
![speed.png](https://cdn.dvkunion.cn/SeaMoon/speed.png)
![speed](https://seamoon.oss-cn-hangzhou.aliyuncs.com/7bfff588795a4e41b488694ad4eb5153.png)
158 changes: 139 additions & 19 deletions docs/guide/02.服务部署/02.sealos.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ permalink: /guide/deploy/sealos
article: false
---

## 部署到Sealos: 拥抱更便宜、更舒适、更优美可控的云服务平台
## 部署到Sealos: 拥抱更便宜、更舒适、更优美可控的云服务平台

[Sealos公有云地址](https://cloud.sealos.io/)

Expand All @@ -16,21 +16,21 @@ article: false
<font style="fontSize:small">操作起来和操作一个os一样,点击、配置、部署,一气呵成。
对比各大厂的balabala一堆限制,sealos的门槛更低,更适合小白上手。 </font>

![](https://cdn.dvkunion.cn/seamoon/df79a91e03a3499198e83e7b2f8c5495.png)
![sealos-dashboard](https://seamoon.oss-cn-hangzhou.aliyuncs.com/b792343632554e7fab560b74d3fb57b7.png)

<font color="pink"><b>简单易懂的计费方式:花费更低,效果不变</b></font>

<font style="fontSize:small">对比各大厂花里胡哨的各项计费指标(尤其是流量也要收费),
sealos的计费方式真正的做到按照计算量计费,费用透明,整体使用下来价格更低。</font>

![](https://cdn.dvkunion.cn/seamoon/6d631335801f424cb522a949ed0fbfe6.png)
![sealos-app](https://seamoon.oss-cn-hangzhou.aliyuncs.com/31c6d9dae9534812b909e1a5f9cf3df8.png)

<font color="pink"><b>配置更加灵活:不用了pause、用的时候start、想要多少的IP自行可控</b></font>

<font style="fontSize:small">sealos支持快速弹性扩容,当需求高时,可以调低扩容触发点,获取到更多IP
当不需要使用时,可以快速的pause停止;下次使用时又能快速的恢复。</font>

![](https://cdn.dvkunion.cn/seamoon/4cfd4e22aa954bc7a19d22a4e9b21035.png)
![sealos-deploy](https://seamoon.oss-cn-hangzhou.aliyuncs.com/a4ae5ecbe22941579a059cee3cd0dbf6.png)

## 如何部署

Expand All @@ -40,48 +40,168 @@ sealos上部署seamoon服务将更加简单,只需要鼠标点击操作:

注册并登陆[cloud.sealos.io](https://cloud.sealos.io/), 点击`App Launchpad`

![](https://cdn.dvkunion.cn/seamoon/d17d6c38e3e2418db9a1545161ebdaca.png)
![sealos-applanch](https://seamoon.oss-cn-hangzhou.aliyuncs.com/4bfbdf9f9ad5440b91ec85831c062b07.png)

### Step.2

### Step.2

点击右上角`create application`, 如下填写参数:

![](https://cdn.dvkunion.cn/seamoon/d03c4da3524d4fbd9acdeae09496d81c.png)
![sealos-setting-1](https://seamoon.oss-cn-hangzhou.aliyuncs.com/cb4a3fe0546b45a99c4944fb4fbb5246.png)

![sealos-setting-2](https://seamoon.oss-cn-hangzhou.aliyuncs.com/3e0ecdaed4d645e8bdf45843e8c3d80f.png)

你也可以直接选择yaml文件,参考如下:

![](https://cdn.dvkunion.cn/seamoon/107d1b99193a4d67aa5a1e5d3c8b3339.png)
service.yaml

```yaml
apiVersion: v1
kind: Service
metadata:
name: seamoon-server
labels:
cloud.sealos.io/app-deploy-manager: seamoon-server
spec:
ports:
- port: 9000
targetPort: 9000
name: ''
selector:
app: seamoon-server
```
deployment.yaml
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: seamoon-server
annotations:
originImageName: dvkunion/seamoon-server:latest
deploy.cloud.sealos.io/minReplicas: '1'
deploy.cloud.sealos.io/maxReplicas: '1'
deploy.cloud.sealos.io/resize: 0Gi
labels:
cloud.sealos.io/app-deploy-manager: seamoon-server
app: seamoon-server
spec:
replicas: 1
revisionHistoryLimit: 1
selector:
matchLabels:
app: seamoon-server
strategy:
type: RollingUpdate
rollingUpdate:
maxUnavailable: 0
maxSurge: 1
template:
metadata:
labels:
app: seamoon-server
spec:
containers:
- name: seamoon-server
image: dvkunion/seamoon-server:latest
env:
- name: serverMod
value: socks5
resources:
requests:
cpu: 10m
memory: 6Mi
limits:
cpu: 100m
memory: 64Mi
ports:
- containerPort: 9000
name: ''
imagePullPolicy: Always
volumeMounts: []
volumes: []
```
ingress.yaml
```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: seamoon-server
labels:
cloud.sealos.io/app-deploy-manager: seamoon-server
cloud.sealos.io/app-deploy-manager-domain: "*****" # 系统自动生成
annotations:
kubernetes.io/ingress.class: nginx
nginx.ingress.kubernetes.io/proxy-body-size: 32m
nginx.ingress.kubernetes.io/ssl-redirect: 'false'
nginx.ingress.kubernetes.io/backend-protocol: HTTP
nginx.ingress.kubernetes.io/client-body-buffer-size: 64k
nginx.ingress.kubernetes.io/proxy-buffer-size: 64k
nginx.ingress.kubernetes.io/proxy-send-timeout: '300'
nginx.ingress.kubernetes.io/proxy-read-timeout: '300'
nginx.ingress.kubernetes.io/server-snippet: |
client_header_buffer_size 64k;
large_client_header_buffers 4 128k;
spec:
rules:
- host: "*****" # 系统自动生成
http:
paths:
- pathType: Prefix
path: /
backend:
service:
name: seamoon-server
port:
number: 9000
tls:
- hosts:
- "*****" # 系统自动生成
secretName: wildcard-cloud-sealos-io-cert
```
下面详细解释每个参数的意思。
主要注意以下参数
```shell
name: "函数名,填写SeaMoon即可"
image: "dvkunion/seamoon-server:latest", # 不要修改
Instance: # 两种模式,fixed/Scaling; 如果固定需要几个实例,可以选择fixed; 如果想要动态扩散,可以选择Scaling,然后通过配置内存指标来控制
# 当前截图配置的意思为,动态扩容,当内存使用超过10%时,自动创建新的副本(最大副本数为5)
Network: #此项不要动任何字段,完全按照截图填写
Advance: 配置环境变量: serverMod=socks5 # 如果需要http代理,填写serverMod=http
```
### Step.3
填写完成后,点击右上角 `Deploy`, 等待部署完成,状态success后,获取到服务地址
填写完成后,点击右上角 `Deploy`, 等待部署完成,状态success后,获取到服务地址。

然后在本地启动客户端,推荐 docker 一键拉起:

```shell
$ docker run -it -d --net=host dvkunion/seamoon-client
```

默认使用`--net=host`模式, 如需要高级设置,如下:

```shell
$ docker run -it -d -p 7777:7777 -p 1080:1080 dvkunion/seamoon-client
```

将此地址填入客户端即可(注意将https:// 换为 wss://)

![](https://cdn.dvkunion.cn/seamoon/444615d4be064ca980e92e2d120beaf3.png)
访问本地控制台 localhost:7777 , 将此地址填入客户端即可(注意将http:// 换为 ws://)

![sealos-config](https://seamoon.oss-cn-hangzhou.aliyuncs.com/a931e0b42c8748649d5156b2b0884fcb.png)

## 效果展示

[旺柴] 谷歌云的IP访问谷歌简直不能再丝滑

![](https://cdn.dvkunion.cn/seamoon/a7d0567cb29140fc8243a68894323aef.png)
![sealos](https://seamoon.oss-cn-hangzhou.aliyuncs.com/ff9eb3ec14fa417daca7a661f9b4ecff.png)

整体带宽在10-30左右,可能和我客户端出口带宽也有关系,应该是普通的带宽。(不过价格也在这里了要啥自行车,反正够用)

![](https://cdn.dvkunion.cn/seamoon/9269f06bdce44056afa1c198af19e583.png)
![speed](https://seamoon.oss-cn-hangzhou.aliyuncs.com/7bfff588795a4e41b488694ad4eb5153.png)

如果不需要多IP,实例副本数目固定为1即可;如果需要多IP,副本越多,获取到的IP就越多。(理性使用)




Loading

0 comments on commit 6aa6502

Please sign in to comment.