Docs: add "Add a domain" (labring#4075)

* Docs: improving the "Install Sealos Cluster" part Signed-off-by: Carson Yang <[email protected]> * Docs: add "Add a domain" Signed-off-by: Carson Yang <[email protected]> --------- Signed-off-by: Carson Yang <[email protected]>
sealos-ci-robot · Oct 11, 2023 · ba38e33 · ba38e33
1 parent ed9ffdd
commit ba38e33
Show file tree

Hide file tree

Showing 15 changed files with 123 additions and 26 deletions.
diff --git a/docs/4.0/docs/quick-start/app-deployments/install-db-with-database.md b/docs/4.0/docs/quick-start/app-deployments/install-db-with-database.md
@@ -8,7 +8,7 @@ Databases are fundamental tools for data management, designed for efficient stor
 
 This guide will show you how to install MySQL use Databse app.
 
-# Install MySQL
+## Install MySQL
 
 1. Open Database app in the [Sealos](https://cloud.sealos.io) desktop.
 
@@ -26,7 +26,7 @@ This guide will show you how to install MySQL use Databse app.
 
 ![](./images/database-connect.png)
 
-# Install PostgreSQL and MongoDB
+## Install PostgreSQL and MongoDB
 
 The installation process for PostgreSQL and MongoDB mirrors that of MySQL. Simply choose the respective database type on the basic configuration page.
 

diff --git a/docs/4.0/docs/quick-start/app-deployments/next-steps.md b/docs/4.0/docs/quick-start/app-deployments/next-steps.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 5
+---
+
+# Next Steps
+
+Congratulations on getting started with Sealos! Now, you can continue learning more about Sealos's many features:
+
++ [Set up your own domain](/quick-start/setup-domain.md)
++ Update app settings
++ Expose multiple ports
++ Add CronJob
diff --git a/docs/4.0/docs/quick-start/images/app-launchpad-domain.png b/docs/4.0/docs/quick-start/images/app-launchpad-domain.png
diff --git a/docs/4.0/docs/quick-start/images/app-launchpad-domain2.png b/docs/4.0/docs/quick-start/images/app-launchpad-domain2.png
diff --git a/docs/4.0/docs/quick-start/images/app-launchpad-domain3.png b/docs/4.0/docs/quick-start/images/app-launchpad-domain3.png
diff --git a/docs/4.0/docs/quick-start/setup-domain.md b/docs/4.0/docs/quick-start/setup-domain.md
@@ -0,0 +1,29 @@
+---
+sidebar_position: 1
+---
+
+# Add a domain
+
+Assigning a custom domain to your project guarantees that visitors to your application will have a tailored experience that aligns with your brand.
+
+## When Deploying
+
+Just enable "Public Access" when you're deploying, and Sealos will sorts you out with a domain.
+
+![](./images/app-launchpad-domain.png)
+
+Now, on your domain provider's end, link the 'CNAME' to the one Sealos provided.
+
+Once it's active, jump back to Sealos, click on "Custom Domain" to the side:
+
+![](./images/app-launchpad-domain2.png)
+
+Enter your custom domain in the pop-up box and click confirm.
+
+![](./images/app-launchpad-domain3.png)
+
+To wrap up, click the "Deploy" button. Once your app's live, click on the external address to access the app via the custom domain.
+
+## Post Deployment
+
+For the apps you've deployed, just click "Update" top-right on the app details page. Then, follow the earlier steps to integrate your custom domain.
diff --git a/docs/4.0/docs/self-hosting/installation.md b/docs/4.0/docs/self-hosting/installation.md
@@ -2,37 +2,46 @@
 sidebar_position: 1
 ---
 
-# 安装 Sealos 集群
+# Install Sealos Cluster
 
-## 准备工作
+## Before You Begin
 
-### 服务器
-奇数台的master服务器及任意的node服务器，推荐使用ubuntu 22.04 LTS linux发行版，操作系统内核在5.4以上；
+### Hardware
 
-配置推荐4c8g，存储100g以上，i.e. 最少一台的服务器配置如下：
++ Opt for an odd number of Master servers and a bunch of Node servers.
++ OS: Stick with Ubuntu 22.04 LTS.
++ Make sure your Kernel's at least 5.4.
++ Recommended Configuration: 4-core CPU, 8GB RAM, and over 100GB storage.
++ Minimum Configuration: 2-core CPU, 4GB RAM, and 60GB storage.
 
-| | cpu | memory | disk |
-|-----------|-----|--------|------|
-| recommend | 4 | 8G | 100G |
-| minimum | 2 | 4G | 60G |
+### Networking
 
-### 网络
-服务器之间的网络互通，其中`master0`（执行sealos cli的master节点）可以通过ssh免密登陆到其他节点；所有节点间可以互相通信。
++ All servers should be interconnected. 
++ master0 (that runs the sealos cli) should have SSH access to the others without needing a password. 
++ All servers should be able to communicate with each other.
 
-### 域名
-你需要一个域名，用于访问 Sealos 及你将部署的各种服务。如果您没有域名，可以使用`nip.io`提供的免费域名服务。
 
-### 证书
-Sealos 需要使用证书来保证通信安全，默认在您不提供证书的情况下我们会使用 [cert-manager](https://cert-manager.io/docs/) 来自动签发证书。
 
-如果您能提供证书，证书需要解析下列域名（假设您提供的域名为：cloud.example.io）：
+### Domain
+
+You’ll need a domain to access Sealos and any other services you launch. If you don't own one, just pick up a freebie from nip.io.
+
+### Certificates
+
+Sealos prioritizes security using certificates. If you don't provide your own, the system defaults to [cert-manager](https://cert-manager.io/docs/) to handle it for you. If you’ve got your own certificate, ensure it recognizes:
+
 - `*.cloud.example.io`
 - `cloud.example.io`
 
-## 安装步骤
+## Installation
+
+Just run this command and follow the prompts:
+
+```bash
+curl -sfL https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh
+```
 
-执行命令，并根据提示输入参数：
+Your default login details are:
 
-```bash 
-curl -sfL https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/install.sh -o /tmp/install.sh && bash /tmp/install.sh 
-```
++ Username: `admin`
++ Password: `sealos2023`
diff --git a/docs/4.0/i18n/zh-Hans/quick-start/app-deployments/install-db-with-database.md b/docs/4.0/i18n/zh-Hans/quick-start/app-deployments/install-db-with-database.md
@@ -8,7 +8,7 @@ sidebar_position: 4
 
 下面将通过示例来演示 Sealos 如何快速安装 MySQL。
 
-# 快速安装 MySQL
+## 快速安装 MySQL
 
 1. 在 [Sealos](https://cloud.sealos.top) 桌面环境中打开数据库。
 
@@ -26,7 +26,7 @@ sidebar_position: 4
 
 ![](./images/database-connect.png)
 
-# 快速安装 PostgreSQL 和 MongoDB
+## 快速安装 PostgreSQL 和 MongoDB
 
 PostgreSQL 和 MongoDB 数据库的安装和 MySQL 类似，需要在基础配置界面选择相应的数据库类型。
 

diff --git a/docs/4.0/i18n/zh-Hans/quick-start/app-deployments/next-steps.md b/docs/4.0/i18n/zh-Hans/quick-start/app-deployments/next-steps.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 5
+---
+
+# 下一步
+
+恭喜您成功进入了 Sealos 的世界，现在您可以选择深入了解 Sealos 的更多功能：
+
++ [自定义域名](/quick-start/setup-domain.md)
++ 修改应用配置
++ 多端口暴露
++ 添加定时任务
diff --git a/docs/4.0/i18n/zh-Hans/quick-start/images/aliyun-cname.png b/docs/4.0/i18n/zh-Hans/quick-start/images/aliyun-cname.png
diff --git a/docs/4.0/i18n/zh-Hans/quick-start/images/app-launchpad-domain.png b/docs/4.0/i18n/zh-Hans/quick-start/images/app-launchpad-domain.png
diff --git a/docs/4.0/i18n/zh-Hans/quick-start/images/app-launchpad-domain2.png b/docs/4.0/i18n/zh-Hans/quick-start/images/app-launchpad-domain2.png
diff --git a/docs/4.0/i18n/zh-Hans/quick-start/images/app-launchpad-domain3.png b/docs/4.0/i18n/zh-Hans/quick-start/images/app-launchpad-domain3.png
diff --git a/docs/4.0/i18n/zh-Hans/quick-start/setup-domain.md b/docs/4.0/i18n/zh-Hans/quick-start/setup-domain.md
@@ -0,0 +1,31 @@
+---
+sidebar_position: 1
+---
+
+# 自定义域名
+
+想让您的用户能够享受与您的品牌一致的专属体验？只需要在 Sealos 中为你的项目指定一个自定义域名。
+
+## 部署时接入
+
+如果您在部署应用时接入自定义域名，只需要在部署应用时打开「外网访问」，Sealos 会给您的应用自动分配一个外网域名。
+
+![](./images/app-launchpad-domain.png)
+
+然后需要到您的域名服务商处，添加该域名的 `CNAME` 解析到上面分配的外网域名。以阿里云为例：
+
+![](./images/aliyun-cname.png)
+
+等待解析生效后即可回到 Sealos 中绑定自定义域名，直接点击右侧的「自定义域名」：
+
+![](./images/app-launchpad-domain2.png)
+
+在弹出的界面中输入您的自定义域名，然后点击确认即可。
+
+![](./images/app-launchpad-domain3.png)
+
+最终点击右上角的「部署」开始部署应用，部署完成后点击外网地址即可通过自定义域名访问应用。
+
+## 部署完成后接入
+
+已经部署完成的应用可以在应用详情页面的右上角点击「变更」，然后参考之前的步骤接入自定义域名即可。
diff --git a/docs/4.0/i18n/zh-Hans/self-hosting/installation.md b/docs/4.0/i18n/zh-Hans/self-hosting/installation.md
@@ -7,6 +7,7 @@ sidebar_position: 1
 ## 准备工作
 
 ### 服务器
+
 奇数台的master服务器及任意的node服务器，推荐使用ubuntu 22.04 LTS linux发行版，操作系统内核在5.4以上；
 
 配置推荐4c8g，存储100g以上，i.e. 最少一台的服务器配置如下：
@@ -17,12 +18,15 @@ sidebar_position: 1
 | minimum | 2 | 4G | 60G |
 
 ### 网络
+
 服务器之间的网络互通，其中`master0`（执行sealos cli的master节点）可以通过ssh免密登陆到其他节点；所有节点间可以互相通信。
 
 ### 域名
+
 你需要一个域名，用于访问 Sealos 及你将部署的各种服务。如果您没有域名，可以使用`nip.io`提供的免费域名服务。
 
 ### 证书
+
 Sealos 需要使用证书来保证通信安全，默认在您不提供证书的情况下我们会使用 [cert-manager](https://cert-manager.io/docs/) 来自动签发证书。
 
 如果您能提供证书，证书需要解析下列域名（假设您提供的域名为：cloud.example.io）：
@@ -39,5 +43,5 @@ curl -sfL https://raw.githubusercontent.com/labring/sealos/main/scripts/cloud/in
 
 默认的用户名密码：
 
-+ 用户名：`root`
++ 用户名：`admin`
 + 密码：`sealos2023`