This page is incomplete and must be updated
+ This chapter will cover topics related to how to deploy Blocklet Server in a production environment. -- [Production Best Practice](./best-practice) +- [Server CLI](./server-cli) - [Deploy with AWS AMI](./from-aws-ami) -- [Bind domain with reverse proxy server](./behind-reverse-proxy) +- [Deploy with Launcher](./from-launcher) +- [Behind Reverse Proxy](./behind-reverse-proxy) +- [Backup and Restore](./backup-restore) +- [Best Practices](./best-practice) diff --git a/src/developer/abtnode-cli/images/abtnode-cli-1.png b/src/deployment/server-cli/images/abtnode-cli-1.png similarity index 100% rename from src/developer/abtnode-cli/images/abtnode-cli-1.png rename to src/deployment/server-cli/images/abtnode-cli-1.png diff --git a/src/developer/abtnode-cli/images/abtnode-cli-2.png b/src/deployment/server-cli/images/abtnode-cli-2.png similarity index 100% rename from src/developer/abtnode-cli/images/abtnode-cli-2.png rename to src/deployment/server-cli/images/abtnode-cli-2.png diff --git a/src/developer/abtnode-cli/images/abtnode-cli-3.png b/src/deployment/server-cli/images/abtnode-cli-3.png similarity index 100% rename from src/developer/abtnode-cli/images/abtnode-cli-3.png rename to src/deployment/server-cli/images/abtnode-cli-3.png diff --git a/src/developer/abtnode-cli/images/abtnode-cli-4.png b/src/deployment/server-cli/images/abtnode-cli-4.png similarity index 100% rename from src/developer/abtnode-cli/images/abtnode-cli-4.png rename to src/deployment/server-cli/images/abtnode-cli-4.png diff --git a/src/developer/abtnode-cli/images/abtnode-cli-5.png b/src/deployment/server-cli/images/abtnode-cli-5.png similarity index 100% rename from src/developer/abtnode-cli/images/abtnode-cli-5.png rename to src/deployment/server-cli/images/abtnode-cli-5.png diff --git a/src/developer/abtnode-cli/images/docs-help.png b/src/deployment/server-cli/images/docs-help.png similarity index 100% rename from src/developer/abtnode-cli/images/docs-help.png rename to src/deployment/server-cli/images/docs-help.png diff --git a/src/developer/abtnode-cli/index.md b/src/deployment/server-cli/index.md similarity index 98% rename from src/developer/abtnode-cli/index.md rename to src/deployment/server-cli/index.md index bd43c7f..01d4e2c 100644 --- a/src/developer/abtnode-cli/index.md +++ b/src/deployment/server-cli/index.md @@ -9,6 +9,8 @@ tags: - 'blocklet server' --- +>This page is outdated and must be updated
+ Blocklet Server provides `blocklet server` command-line tool for controlling and administering the node. Use the following syntax to run `blocklet server` commands from your terminal: ```bash diff --git a/src/developer/abtnode-cli/index.zh.md b/src/deployment/server-cli/index.zh.md similarity index 100% rename from src/developer/abtnode-cli/index.zh.md rename to src/deployment/server-cli/index.zh.md diff --git a/src/developer/blocklet-cli/index.md b/src/developer/blocklet-cli/index.md index 43b4ae4..4fcc154 100644 --- a/src/developer/blocklet-cli/index.md +++ b/src/developer/blocklet-cli/index.md @@ -9,6 +9,8 @@ tags: - 'blocklet' --- +>This page is outdated and must be updated
+ Blocklet Server provides `blocklet` command-line tool for controlling and administering Blocklets. Use the following syntax to run `blocklet` commands from your terminal: ```bash @@ -67,7 +69,7 @@ $ blocklet meta ### Development -Often you would like to deploy Blocklets to validate their behaviours. The command provides support to _install_, _start_ and _remove_ blocklets under development. +Often you would like to deploy Blocklets to validate their behaviours. The command provides support to _Launch_, _start_ and _remove_ blocklets under development. ```bash $ blocklet dev install diff --git a/src/developer/blocklet-hooks/index.md b/src/developer/blocklet-scripts/index.md similarity index 93% rename from src/developer/blocklet-hooks/index.md rename to src/developer/blocklet-scripts/index.md index 05a62a9..aa1d170 100644 --- a/src/developer/blocklet-hooks/index.md +++ b/src/developer/blocklet-scripts/index.md @@ -1,6 +1,6 @@ --- -title: 'Blocklet Hooks' -description: 'Blocklet Hooks' +title: 'Blocklet Scripts' +description: 'Blocklet Scripts' keywords: 'blocklet server, blocklet' author: 'wangshijun' category: '' @@ -9,6 +9,8 @@ tags: - 'blocklet server' --- +>This page is outdated and must be updated
+ Currently Blocklet Server supports the following hooks: - `pre-deploy`: Usually execute various builds locally, when deploying from local to Blocklet Server Daemon. If the exit code is non-zero, quit deployment diff --git a/src/developer/blocklet-hooks/index.zh.md b/src/developer/blocklet-scripts/index.zh.md similarity index 100% rename from src/developer/blocklet-hooks/index.zh.md rename to src/developer/blocklet-scripts/index.zh.md diff --git a/src/developer/blocklet-spec/index.md b/src/developer/blocklet-spec/index.md index 14f03f9..faf172c 100644 --- a/src/developer/blocklet-spec/index.md +++ b/src/developer/blocklet-spec/index.md @@ -2,7 +2,7 @@ title: Blocklet Specification description: 'Blocklet Specification' keywords: 'blocklet server,blocklet,specification' -author: 'zhenqiang, tigeryu8900' +author: 'zhenqiang, wangshijun' category: '' layout: documentation tags: @@ -11,6 +11,8 @@ tags: - specification --- +>This page is outdated and must be updated
+ ## What is Blocklet? Blocklet is an application protocol and software architecture. As a protocol, it describes the way to build the Blocklet Server platform; as software architecture, an independent blocklet is a reusable software module, which may be an HTTP service or a function library, etc.; when multiple When blocklets run together, they need a platform to combine them to form an independent service, such as Blocklet Server. @@ -86,7 +88,7 @@ Here are other configuration items. For a blocklet, these fields are optional. L  -In Blocklet Server, the complete life cycle of a blocklet includes four stages: installation (or deployment), start, stop, and uninstall. Blocklets can be installed in two ways: one is to download and install it from the marketplace, and the other is to deploy and install it directly with Blocklet Server CLI. The CLI is mainly for development and testing. Therefore, in the first phase of the life cycle, there are two installation and deployment situations. +In Blocklet Server, the complete life cycle of a blocklet includes four stages: installation (or deployment), start, stop, and uninstall. Blocklets can be installed in two ways: one is to download and install it from the Store, and the other is to deploy and install it directly with Blocklet Server CLI. The CLI is mainly for development and testing. Therefore, in the first phase of the life cycle, there are two installation and deployment situations. ## Hooks diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-1.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-1.png deleted file mode 100644 index 07ef7cf..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-1.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-2.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-2.png deleted file mode 100644 index 64b0854..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-2.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-3.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-3.png deleted file mode 100644 index 3cb1ddc..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-3.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-4.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-4.png deleted file mode 100644 index 7b07bda..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-4.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-5.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-5.png deleted file mode 100644 index 25ae075..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-5.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-6-en.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-6-en.png deleted file mode 100644 index c43b4a6..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-6-en.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-6-zh.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-6-zh.png deleted file mode 100644 index 2a0bca4..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-6-zh.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-7-en.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-7-en.png deleted file mode 100644 index 9ab3c44..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-7-en.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-7-zh.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-7-zh.png deleted file mode 100644 index 5359e47..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-7-zh.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-8-en.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-8-en.png deleted file mode 100644 index ff9821b..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-8-en.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-8-zh.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-8-zh.png deleted file mode 100644 index 5873b68..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-8-zh.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/images/create-dapp-blocklet-9.png b/src/developer/dapp-blocklets/images/create-dapp-blocklet-9.png deleted file mode 100644 index 595e6fe..0000000 Binary files a/src/developer/dapp-blocklets/images/create-dapp-blocklet-9.png and /dev/null differ diff --git a/src/developer/dapp-blocklets/index.md b/src/developer/dapp-blocklets/index.md deleted file mode 100644 index fd6dee7..0000000 --- a/src/developer/dapp-blocklets/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: 'Create DApp Blocklets' -description: 'Create DApp Blocklets' -keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -The previous section [Create Static Blocklets](static-blocklets) introduced in detail how to create a static blocklet -that can be deployed and run in Blocklet Server from scratch. This section is about creating and deploying a DApp blocklet from -scratch in Blocklet Server. - -## Step 1: Preparing the Environment - -1. First, set up Node.js development environment. - - - -2. Then, install Forge CLI. - - - -3. Next, initialize and run Blocklet Server. - - - -4. Finally, install MongoDB and run it locally. - -## Step 2: Create DApp Blocklet - -We will use the `forge blocklet:use forge-react-starter` command in `forge cli` to generate a Dapp Blocklet template -project. - -1. First, create a project directory and enter it. `forge blocklet:use forge-react-starter` will be run from this -directory - -```terminal -mkdir dapp-blocklet-demo -cd dapp-blocklet-demo -``` - -2. Next, run `forge blocklet:use forge-react-starter` to complete the creation of the template project. - -For the steps here, please refer to the document: [Use Starter Blocklet]( -/handbook/7-working-with-blocklets/starter-blocklets) - -3. Then, run the project. - -Execute `yarn start` in the project's main directory to run the project. - - - -After the generated template project is successfully configured, it can run locally. - - -## Step 3: Deploy DApp Blocklet - -First, press `Ctrl+C` to stop the local test process, and then execute the `blocklet deploy .` command. - - - -After the deployment succeeded, take a look at the Blocklet Server `Corner Program` page. - - - -## Step 4: Configure DApp Blocklet - -If we directly click on the More menu on the far right of `dapp blocklet demo`, the gray button cannot be clicked when -the `Start` button will appear. The appearance of the `Start` button indicates that our DApp needs some configure. Click -on the details page. - - - -Let's configure `MONGO_URI` as local: `mongodb://127.0.0.1:27017/dapp-blocklet-demo`. - -## Step 5: Run DApp Blocklet - -Click to open the three dots on the right side of the just deployed `dapp blocklet demo`, and select `Start`: - - - -The blocklet should now be in the `running` state. Click on the `public interface` to verify that it's running: - - - -We have now successfully created a DApp blocklet in Blocklet Server. diff --git a/src/developer/dapp-blocklets/index.zh.md b/src/developer/dapp-blocklets/index.zh.md deleted file mode 100644 index 514101e..0000000 --- a/src/developer/dapp-blocklets/index.zh.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: '创建 DApp Blocklets' -description: '创建 DApp Blocklets' -keywords: 'blocklet server, blocklet' -author: 'nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -上一个章节：[创建静态 Blocklet](/zh/developer/static-blocklets) 详细介绍了如果从 0 到 1 创建一个可以部署运行在 Blocklet Server 里面的静态 Blocklet， 这个章节我们将继续带领大家，从 0 到 1 创建并部署一个更加复杂的 Dapp Blocklet 到 Blocklet Server 中。 - -## 第一步，环境准备 - -1. Node.js 开发环境搭建完毕 - - - -2. Forge CLI 已经安装完毕 - - - -3. Blocklet Server 已经初始化完毕, 并且已经处于运行状态 - - - -4. 本地已经安装好 MongoDB 并成功运行 - -## 第二步，创建 Dapp Blocklet - -这里我们会使用到 `forge cli` 里面的 `forge blocklet:use forge-react-starter` 命令生成一个 Dapp Blocklet 模板项目. - -1. 创建一个项目目录并进入目录，将会在这个目录下执行 `forge blocklet:use forge-react-starter` - -```terminal -mkdir dapp-blocklet-demo -cd dapp-blocklet-demo -``` - -2. 执行 `forge blocklet:use forge-react-starter` 完成模板项目创建 - -这里的步骤请参考文档：[使用 Starter Blocklet](https://docs.arcblockio.cn/zh/handbook/7-working-with-blocklets/starter-blocklets) - -3. 尝试运行项目 - -在根目录下执行 `yarn start` 启动项目，进行预览 - - - -可以看到，生成的模板项目成功配置之后，可以正常本地运行。 - -## 第三步，部署 Dapp Blocklet - -首先让我们 `Ctrl+C` 停掉刚刚的本地测试进程，然后执行 `blocklet deploy .` 命令，看看会发生什么: - - - -deploy 成功！我们看看 Blocklet Server `基石程序` 页面： - - - -## 第四步，配置 Dapp Blocklet - -可以看到如果我们直接点开 `dapp blocklet demo` 最右侧的更多菜单，`启动` 按钮时灰色不可点击的，是因为我们这个 Dapp 有一些必须配置的项目，可以点开详情页面查看： - - - -我们配置一下 `MONGO_URI` 为本地的：`mongodb://127.0.0.1:27017/dapp-blocklet-demo`，成功配置之后，即可进入下一步。 - -## 第五步，运行 Dapp Blocklet - -点击打开刚刚部署好的 `dapp blocklet demo` 最右侧的更多菜单，并 `启动`： - - - -成功启动之后，Blocklet 进入 `running` 状态，我们点击 `公开界面` 进行验证： - - - -Blocklet 已经成功运行起来了。到这儿，我们就已经成功的在 Blocklet Server 里面部署了一个 Dapp Blocklet，你也快来试试吧！ diff --git a/src/developer/docker-registry/index.md b/src/developer/docker-registry/index.md deleted file mode 100644 index 89942d6..0000000 --- a/src/developer/docker-registry/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 'Docker Registry List' -description: 'Docker registry list' -keywords: 'docker, registry' -author: 'zhenqiang' -category: '' -layout: 'documentation' -tags: - - 'docker' - - 'registry' ---- - -Currently our Docker images are published to 3 registries: - -- Docker Hub: https://hub.docker.com/r/arcblock/abtnode -- Github Package Registry: https://github.com/orgs/ArcBlock/packages/container/package/abtnode -- Amazon ECR: https://gallery.ecr.aws/i0s0w0c9/abtnode diff --git a/src/developer/docker-registry/index.zh.md b/src/developer/docker-registry/index.zh.md deleted file mode 100644 index 4f7f225..0000000 --- a/src/developer/docker-registry/index.zh.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: 'Docker 镜像源列表' -description: '当前的镜像源列表' -keywords: 'docker, registry' -author: 'zhenqiang' -category: '' -layout: 'documentation' -tags: - - 'docker' - - 'registry' ---- - -当前我们的 Docker 镜像发布到了 3 个源: - -- Docker Hub: https://hub.docker.com/r/arcblock/abtnode -- Github Package Registry: https://github.com/orgs/ArcBlock/packages/container/package/abtnode -- Amazon ECR: https://gallery.ecr.aws/i0s0w0c9/abtnode diff --git a/src/developer/index.md b/src/developer/index.md index 79dfc8b..a686510 100644 --- a/src/developer/index.md +++ b/src/developer/index.md @@ -9,22 +9,22 @@ tags: - 'blocklet server' --- +>This page is incomplete and must be updated
+ If you are a developer and want to do something with Blocklet Server ,this chapter is for you: -- [Download Resources](./resources) -- [Configuring the development environment](./config-dev-env) -- [Blocklet Server CLI](./abtnode-cli) - [Blocklet CLI](./blocklet-cli) -- [Create Static Blocklets](./static-blocklets) -- [Create DApp Blocklets](./dapp-blocklets) -- [Blocklet Specification](./blocklet-spec) +- [Blocklet Spec](./blocklet-spec) - [Blocklet SDK](./blocklet-sdk) -- [Auth Service](./auth-service) -- [Send notification to DID Wallet](./send-notification) +- [Blocklet Services](./blocklet-services) + - [Auth Service](./service-auth) + - [Notification Service](./service-notification) +- [Blocklet Scripts](./blocklet-scripts) +- [Blocklet Composition](./composable-blocklet) +- [Blocklet Bundling](./bundle-blocklets) +- [Blocklet Publish](./publish-blocklets) + +Other topics: + - [Use DID Connect](./did-connect) -- [Composable blocklet](./composable-blocklet) -- [Blocklet Hooks](./blocklet-hooks) -- [Bundle Blocklets](./bundle-blocklets) -- [Publish Blocklets](./publish-blocklets) -- [Developing Blocklets with Codespaces](./blocklet-codespaces) -- [Docker Registry](./docker-registry) +- [Use Chain SDK](./chain-sdk) diff --git a/src/developer/auth-service/images/permissions.png b/src/developer/service-auth/images/permissions.png similarity index 100% rename from src/developer/auth-service/images/permissions.png rename to src/developer/service-auth/images/permissions.png diff --git a/src/developer/auth-service/images/static-demo-1.png b/src/developer/service-auth/images/static-demo-1.png similarity index 100% rename from src/developer/auth-service/images/static-demo-1.png rename to src/developer/service-auth/images/static-demo-1.png diff --git a/src/developer/auth-service/images/static-demo-2.png b/src/developer/service-auth/images/static-demo-2.png similarity index 100% rename from src/developer/auth-service/images/static-demo-2.png rename to src/developer/service-auth/images/static-demo-2.png diff --git a/src/developer/auth-service/images/static-demo-3.png b/src/developer/service-auth/images/static-demo-3.png similarity index 100% rename from src/developer/auth-service/images/static-demo-3.png rename to src/developer/service-auth/images/static-demo-3.png diff --git a/src/developer/auth-service/index.md b/src/developer/service-auth/index.md similarity index 98% rename from src/developer/auth-service/index.md rename to src/developer/service-auth/index.md index d675d2f..f7eb189 100644 --- a/src/developer/auth-service/index.md +++ b/src/developer/service-auth/index.md @@ -12,6 +12,8 @@ tags: - 'auth' --- +>This page is outdated and must be updated
+ Blocklet Server provides generic auth service for Blocklets. Auth service provides the following capabilities @@ -173,4 +175,4 @@ interfaces: - invitedUserOnly - no: Open login (default) - - yes: Only log in via invitation link \ No newline at end of file + - yes: Only log in via invitation link diff --git a/src/developer/auth-service/index.zh.md b/src/developer/service-auth/index.zh.md similarity index 100% rename from src/developer/auth-service/index.zh.md rename to src/developer/service-auth/index.zh.md diff --git a/src/developer/send-notification/index.md b/src/developer/service-notification/index.md similarity index 90% rename from src/developer/send-notification/index.md rename to src/developer/service-notification/index.md index 8407dff..12d4e3f 100644 --- a/src/developer/send-notification/index.md +++ b/src/developer/service-notification/index.md @@ -1,5 +1,5 @@ --- -title: 'Send notification to DID Wallet' +title: 'Notification Service' description: 'How to send notification to DID Wallet' keywords: 'blocklet server, blocklet, notification, DID Wallet' author: 'linchen' diff --git a/src/developer/send-notification/index.zh.md b/src/developer/service-notification/index.zh.md similarity index 100% rename from src/developer/send-notification/index.zh.md rename to src/developer/service-notification/index.zh.md diff --git a/src/developer/static-blocklets/images/create-static-blocklet-1.png b/src/developer/static-blocklets/images/create-static-blocklet-1.png deleted file mode 100644 index 7b3ad84..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-1.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-2.png b/src/developer/static-blocklets/images/create-static-blocklet-2.png deleted file mode 100644 index 77d31e9..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-2.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-3.png b/src/developer/static-blocklets/images/create-static-blocklet-3.png deleted file mode 100644 index 2a05db9..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-3.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-4.png b/src/developer/static-blocklets/images/create-static-blocklet-4.png deleted file mode 100644 index b18e7c0..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-4.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-5.png b/src/developer/static-blocklets/images/create-static-blocklet-5.png deleted file mode 100644 index c215d33..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-5.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-6-en.png b/src/developer/static-blocklets/images/create-static-blocklet-6-en.png deleted file mode 100644 index 53bd64f..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-6-en.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-6-zh.png b/src/developer/static-blocklets/images/create-static-blocklet-6-zh.png deleted file mode 100644 index 354e4b3..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-6-zh.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-7-en.png b/src/developer/static-blocklets/images/create-static-blocklet-7-en.png deleted file mode 100644 index 38428d6..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-7-en.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-7-zh.png b/src/developer/static-blocklets/images/create-static-blocklet-7-zh.png deleted file mode 100644 index ff20840..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-7-zh.png and /dev/null differ diff --git a/src/developer/static-blocklets/images/create-static-blocklet-8.png b/src/developer/static-blocklets/images/create-static-blocklet-8.png deleted file mode 100644 index 5290d92..0000000 Binary files a/src/developer/static-blocklets/images/create-static-blocklet-8.png and /dev/null differ diff --git a/src/developer/static-blocklets/index.md b/src/developer/static-blocklets/index.md deleted file mode 100644 index 076ed39..0000000 --- a/src/developer/static-blocklets/index.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -title: 'Create Static Blocklets' -description: 'Create Static Blocklets' -keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -## Step 1: Preparing the Environment - -First, initialize and run Blocklet Server. - -## Step 2: Prepare the Front-End Static Code - -Next, prepare a simple static page `index.html`. - - - -Code: - -```html - - - - - -This page is incomplete and must be updated
+ Blocklet Server downloads some resources, such as HTTPS certificates, when it starts up, and the Blocklet Server CLI sets these download addresses by default during initialization, but in some cases the default addresses may not be accessible. Some other optional download addresses are given in this document. -## HTTPS Certificate download address +## HTTPS Certificate download mirrors - Default Address: https://releases.arcblock.io/ - Ali Cloud Address: https://releases.arcblockio.cn/ @@ -22,3 +24,7 @@ The download address can be set via the `ABT_NODE_WILDCARD_CERT_HOST` environmen ```bash ABT_NODE_WILDCARD_CERT_HOST=https://releases.arcblockio.cn blocklet server start ``` + +## DID Registry Alternative + +## Blocklet Store Alternative diff --git a/src/developer/resources/index.zh.md b/src/faq/resources/index.zh.md similarity index 100% rename from src/developer/resources/index.zh.md rename to src/faq/resources/index.zh.md diff --git a/src/developer/config-dev-env/index.md b/src/faq/setup-env/index.md similarity index 91% rename from src/developer/config-dev-env/index.md rename to src/faq/setup-env/index.md index 00b8fc0..f02b8e2 100644 --- a/src/developer/config-dev-env/index.md +++ b/src/faq/setup-env/index.md @@ -1,7 +1,7 @@ --- -title: 'Configuring the development environment' -description: 'Configuring the development environment' -keywords: 'blocklet server, development' +title: 'Setup blocklet dev environment' +description: 'Instructions on how setup blocklet development environment' +keywords: 'development' author: 'polunzh' category: '' layout: 'documentation' @@ -52,6 +52,8 @@ After completing the installation of Node.js, you can install Blocklet Server: $ npm install -g @blocklet/cli ``` +> You can also install `@blocklet/cli` globally with yarn or pnpm. + After installation, you can run `blocklet --version` to see the current version. ## Install VSCode diff --git a/src/developer/config-dev-env/index.zh.md b/src/faq/setup-env/index.zh.md similarity index 100% rename from src/developer/config-dev-env/index.zh.md rename to src/faq/setup-env/index.zh.md diff --git a/src/developer/storage-structure/index.md b/src/faq/storage-structure/index.md similarity index 100% rename from src/developer/storage-structure/index.md rename to src/faq/storage-structure/index.md diff --git a/src/developer/storage-structure/index.zh.md b/src/faq/storage-structure/index.zh.md similarity index 100% rename from src/developer/storage-structure/index.zh.md rename to src/faq/storage-structure/index.zh.md diff --git a/src/developer/blocklet-codespaces/index.md b/src/faq/with-codespaces/index.md similarity index 92% rename from src/developer/blocklet-codespaces/index.md rename to src/faq/with-codespaces/index.md index 8b46f95..57f2cb5 100644 --- a/src/developer/blocklet-codespaces/index.md +++ b/src/faq/with-codespaces/index.md @@ -46,7 +46,7 @@ In your codespaces: ### Unable to log in to Blocklet Server -Currently, the service in Codespaces does not support public access, so the mobile ABT Wallet cannot communicate with the Blocklet Server in your codespace. A temporary solution is to use [ngrok](https://ngrok.com/) to establish a channel to bypass Codespaces. +Currently, the service in Codespaces does not support public access, so the mobile DID Wallet cannot communicate with the Blocklet Server in your codespace. A temporary solution is to use [ngrok](https://ngrok.com/) to establish a channel to bypass Codespaces. 1. Install ngrok @@ -75,7 +75,7 @@ After the access channel is successfully established, you can access the Blockle ngrok by @inconshreveable Session Status online -Account linchen1987 (Plan: Free) +Account linchen1987 (Plan: Free) Version 2.3.35 Region United States (us) Web Interface http://127.0.0.1:4040 @@ -83,5 +83,5 @@ Forwarding http://xxxxxxxxxxxx.ngrok.io -> http://localhost:8 Forwarding https://xxxxxxxxxxxx.ngrok.io -> http://localhost:80 Connections ttl opn rt1 rt5 p50 p90 - 0 0 0.00 0.00 0.00 0.00 -``` \ No newline at end of file + 0 0 0.00 0.00 0.00 0.00 +``` diff --git a/src/developer/blocklet-codespaces/index.zh.md b/src/faq/with-codespaces/index.zh.md similarity index 91% rename from src/developer/blocklet-codespaces/index.zh.md rename to src/faq/with-codespaces/index.zh.md index 988163b..a435657 100644 --- a/src/developer/blocklet-codespaces/index.zh.md +++ b/src/faq/with-codespaces/index.zh.md @@ -46,7 +46,7 @@ tags: ### 无法登录 Blocklet Server -目前，Codespaces 中的服务尚未支持公开访问，所以移动端的 ABT Wallet 无法与 Codespace 中的 Blocklet Server 通信。一个临时解决方案是使用 [ngrok](https://ngrok.com/) 建立一个通道，绕过 Codespaces. +目前，Codespaces 中的服务尚未支持公开访问，所以移动端的 DID Wallet 无法与 Codespace 中的 Blocklet Server 通信。一个临时解决方案是使用 [ngrok](https://ngrok.com/) 建立一个通道，绕过 Codespaces. 1. 安装 ngrok @@ -75,7 +75,7 @@ unzip ./ngrok.zip ngrok by @inconshreveable Session Status online -Account linchen1987 (Plan: Free) +Account linchen1987 (Plan: Free) Version 2.3.35 Region United States (us) Web Interface http://127.0.0.1:4040 @@ -83,5 +83,5 @@ Forwarding http://xxxxxxxxxxxx.ngrok.io -> http://localhost:8 Forwarding https://xxxxxxxxxxxx.ngrok.io -> http://localhost:80 Connections ttl opn rt1 rt5 p50 p90 - 0 0 0.00 0.00 0.00 0.00 -``` \ No newline at end of file + 0 0 0.00 0.00 0.00 0.00 +``` diff --git a/src/deployment/run-in-docker/index.md b/src/faq/with-docker/index.md similarity index 63% rename from src/deployment/run-in-docker/index.md rename to src/faq/with-docker/index.md index 873ccce..a4f5e1f 100644 --- a/src/deployment/run-in-docker/index.md +++ b/src/faq/with-docker/index.md @@ -1,6 +1,6 @@ --- -title: 'Run In Docker' -description: 'Run In Docker' +title: 'Run with Docker' +description: 'Fetch blocklet server docker image from various registries' keywords: 'docker, registry' author: 'zhenqiang' category: '' @@ -10,10 +10,6 @@ tags: - 'registry' --- - - -You can use Blocklet Server with docker: - ## 1. Pull Image ```shell @@ -28,4 +24,12 @@ docker run -d -p 80:80 -p 443:443 -vThis page is outdated and must be updated
+ Welcome to Blocklet Server documentation - [Introduction](./introduction) - [Blocklet Server Overview](./introduction/abtnode-overview) - [Blocklet Server Setup](./introduction/abtnode-setup) - [Blocklet Server Access](./introduction/abtnode-access) -- [Blocklet Marketplace](./marketplace) - - [Find and install blocklet](./marketplace/find-and-install) - - [Upgrade/downgrade blocklet](./marketplace/upgrade-downgrade) +- [Blocklet Store](./Store) + - [Find and install blocklet](./Store/find-and-install) + - [Upgrade/downgrade blocklet](./Store/upgrade-downgrade) - [Blocklet Management](./blocklet) - [Basic Operations](./blocklet/basic-operations) - [Blocklet Environments](./blocklet/environments) @@ -32,7 +34,7 @@ Welcome to Blocklet Server documentation - [Runtime Logs](./logs/blocklet-logs) - [Lifecycle Logs](./logs/abtnode-logs) - [Settings](./node-settings) - - [Basic Setting](./node-settings/node-attributes) + - [Basic Setting](./node-settings/basic) - [Access Keys](./ode-settings/access-keys) - [Integrations](./ode-settings/integrations) - [Production Deployment](./deployment) diff --git a/src/index.zh.md b/src/index.zh.md index f0e6545..efb88ae 100644 --- a/src/index.zh.md +++ b/src/index.zh.md @@ -12,15 +12,17 @@ tags: - abtnode --- +>This page is outdated and must be updated
+ 欢迎访问 Blocklet Server 的文档 - [介绍](./introduction) - [节点功能概览](./introduction/abtnode-overview) - [如何获取 Blocklet Server ](./introduction/abtnode-setup) - [配置并启动 Blocklet Server ](./introduction/abtnode-access) -- [Blocklet 市场](./marketplace) - - [查找和安装 Blocklet](./marketplace/find-and-install) - - [升级或降级 Blocklet](./marketplace/upgrade-downgrade) +- [Blocklet 市场](./Store) + - [查找和安装 Blocklet](./Store/find-and-install) + - [升级或降级 Blocklet](./Store/upgrade-downgrade) - [Blocklet 管理](./blocklet) - [基本管理操作](./blocklet/basic-operations) - [环境变量管理](./blocklet/environments) @@ -56,4 +58,3 @@ tags: - [Blocklet 商店](./developer/blocklet-store) - [在 Codespaces 中开发 Blocklets](./developer/blocklet-codespaces) - [Docker Registry](./developer/docker-registry) - diff --git a/src/introduction/abtnode-access/images/initialize_abtnode.gif b/src/introduction/access/images/initialize_abtnode.gif similarity index 100% rename from src/introduction/abtnode-access/images/initialize_abtnode.gif rename to src/introduction/access/images/initialize_abtnode.gif diff --git a/src/introduction/abtnode-access/images/initialize_abtnode.yml b/src/introduction/access/images/initialize_abtnode.yml similarity index 100% rename from src/introduction/abtnode-access/images/initialize_abtnode.yml rename to src/introduction/access/images/initialize_abtnode.yml diff --git a/src/introduction/abtnode-access/images/ready-to-use.png b/src/introduction/access/images/ready-to-use.png similarity index 100% rename from src/introduction/abtnode-access/images/ready-to-use.png rename to src/introduction/access/images/ready-to-use.png diff --git a/src/introduction/abtnode-access/images/scan-abt-node.png b/src/introduction/access/images/scan-abt-node.png similarity index 100% rename from src/introduction/abtnode-access/images/scan-abt-node.png rename to src/introduction/access/images/scan-abt-node.png diff --git a/src/introduction/abtnode-access/images/setup-abt-node.png b/src/introduction/access/images/setup-abt-node.png similarity index 100% rename from src/introduction/abtnode-access/images/setup-abt-node.png rename to src/introduction/access/images/setup-abt-node.png diff --git a/src/introduction/abtnode-access/index.md b/src/introduction/access/index.md similarity index 72% rename from src/introduction/abtnode-access/index.md rename to src/introduction/access/index.md index dfe4714..1c0b6ea 100644 --- a/src/introduction/abtnode-access/index.md +++ b/src/introduction/access/index.md @@ -2,7 +2,7 @@ title: 'Blocklet Server Access' description: 'Blocklet Server Access' keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' +author: 'wangshijun' category: '' layout: 'documentation' tags: @@ -12,25 +12,25 @@ tags: Once Blocklet Server has started you need to access the node dashboard to work with it. To do so, please make sure you are connected to the network of the deployed Blocklet Server. -## Install ABT Wallet +## Install DID Wallet -Access to Blocklet Server is authorized using ABT wallet, ArcBlock’s decentralized identity solution. You can access [ABT Wallet](https://abtwallet.io) in either of the following ways : -- Install the iOS / Android mobile app from [ABT Wallet](https://abtwallet.io). -- Create your ABT wallet on https://web.abtwallet.io/ +Access to Blocklet Server is authorized using DID Wallet, ArcBlock’s decentralized identity solution. You can access [DID Wallet](https://abtwallet.io) in either of the following ways : +- Install the iOS / Android mobile app from [DID Wallet](https://abtwallet.io). +- Create your DID Wallet on https://web.abtwallet.io/ ## Access Blocklet Server -Access the Blocklet Server from your browser; as a first step, you must accept ArcBlock's End-User Agreement. +Access the Blocklet Server from your browser; as a first step, you must accept ArcBlock's End-User Agreement.  -Next, scan the generated QRCode using your ArcBlock ABT Wallet. It will authorize access to the Blocklet Server from your wallet. +Next, scan the generated QRCode using your ArcBlock DID Wallet. It will authorize access to the Blocklet Server from your wallet.  After authorization you will have ownership of the Blocklet Server. You will have full access to all components of the respective Blocklet Server. You can perform administration tasks not limiting to the following : - Monitor Blocklet Server KPIs (CPU, memory, storage) -- Use the Marketplace to install Blocklets +- Use the Store to install Blocklets - Update and remove Blocklets - Configure routing to the different apps - Add and remove team member diff --git a/src/introduction/abtnode-access/index.zh.md b/src/introduction/access/index.zh.md similarity index 98% rename from src/introduction/abtnode-access/index.zh.md rename to src/introduction/access/index.zh.md index 7e692d6..b03edfc 100644 --- a/src/introduction/abtnode-access/index.zh.md +++ b/src/introduction/access/index.zh.md @@ -2,7 +2,7 @@ title: '配置并启动 Blocklet Server ' description: '配置并启动 Blocklet Server ' keywords: 'blocklet server, blocklet' -author: 'tigeryu8900, nate' +author: 'wangshijun, nate' category: '' layout: 'documentation' tags: diff --git a/src/introduction/index.md b/src/introduction/index.md index 239879b..03567ab 100644 --- a/src/introduction/index.md +++ b/src/introduction/index.md @@ -13,6 +13,6 @@ The ArcBlock platform is deployed using Blocklet Server Service. The following s ## Contents -- [Blocklet Server Overview](./abtnode-overview): An overview of Blocklet Server's capabilities. -- [Blocklet Server Setup](./abtnode-setup): Detailed instructions for Blocklet Server installation. -- [Blocklet Server Access](./abtnode-access): Instructions for Blocklet Server Dashboard access. +- [Blocklet Server Overview](./overview): An overview of Blocklet Server's capabilities. +- [Blocklet Server Setup](./setup): Detailed instructions for Blocklet Server installation. +- [Blocklet Server Access](./access): Instructions for Blocklet Server Dashboard access. diff --git a/src/introduction/index.zh.md b/src/introduction/index.zh.md index 45ee9bc..76256a2 100644 --- a/src/introduction/index.zh.md +++ b/src/introduction/index.zh.md @@ -11,7 +11,6 @@ tags: 这个章节，从什么是 Blocklet Server ，到一步步配置启动 Blocklet Server ，完整的带大家熟悉并使用 Blocklet Server 。 -- [节点功能概览](./abtnode-overview)：Blocklet Server 功能概览 -- [如何获取 Blocklet Server ](./abtnode-setup)：从 0 到 1 安装 Blocklet Server 的详细教程 -- [配置并启动 Blocklet Server ](./abtnode-access)：一步一步详细的介绍如何配置，启动和停止 Blocklet Server - +- [节点功能概览](./overview)：Blocklet Server 功能概览 +- [如何获取 Blocklet Server ](./setup)：从 0 到 1 安装 Blocklet Server 的详细教程 +- [配置并启动 Blocklet Server ](./access)：一步一步详细的介绍如何配置，启动和停止 Blocklet Server diff --git a/src/introduction/abtnode-overview/images/abtnode-arch-overview-en.png b/src/introduction/overview/images/abtnode-arch-overview-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-arch-overview-en.png rename to src/introduction/overview/images/abtnode-arch-overview-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-blocklets-en.png b/src/introduction/overview/images/abtnode-blocklets-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-blocklets-en.png rename to src/introduction/overview/images/abtnode-blocklets-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-dashboard-en.png b/src/introduction/overview/images/abtnode-dashboard-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-dashboard-en.png rename to src/introduction/overview/images/abtnode-dashboard-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-marketplace-en.png b/src/introduction/overview/images/abtnode-marketplace-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-marketplace-en.png rename to src/introduction/overview/images/abtnode-marketplace-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-1-en.png b/src/introduction/overview/images/abtnode-overview-1-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-1-en.png rename to src/introduction/overview/images/abtnode-overview-1-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-1-zh.png b/src/introduction/overview/images/abtnode-overview-1-zh.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-1-zh.png rename to src/introduction/overview/images/abtnode-overview-1-zh.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-2-en.png b/src/introduction/overview/images/abtnode-overview-2-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-2-en.png rename to src/introduction/overview/images/abtnode-overview-2-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-2-zh.png b/src/introduction/overview/images/abtnode-overview-2-zh.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-2-zh.png rename to src/introduction/overview/images/abtnode-overview-2-zh.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-3-en.png b/src/introduction/overview/images/abtnode-overview-3-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-3-en.png rename to src/introduction/overview/images/abtnode-overview-3-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-3-zh.png b/src/introduction/overview/images/abtnode-overview-3-zh.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-3-zh.png rename to src/introduction/overview/images/abtnode-overview-3-zh.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-4-en.png b/src/introduction/overview/images/abtnode-overview-4-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-4-en.png rename to src/introduction/overview/images/abtnode-overview-4-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-4-zh.png b/src/introduction/overview/images/abtnode-overview-4-zh.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-4-zh.png rename to src/introduction/overview/images/abtnode-overview-4-zh.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-5-en.png b/src/introduction/overview/images/abtnode-overview-5-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-5-en.png rename to src/introduction/overview/images/abtnode-overview-5-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-5-zh.png b/src/introduction/overview/images/abtnode-overview-5-zh.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-5-zh.png rename to src/introduction/overview/images/abtnode-overview-5-zh.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-6-en.png b/src/introduction/overview/images/abtnode-overview-6-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-6-en.png rename to src/introduction/overview/images/abtnode-overview-6-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-overview-6-zh.png b/src/introduction/overview/images/abtnode-overview-6-zh.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-overview-6-zh.png rename to src/introduction/overview/images/abtnode-overview-6-zh.png diff --git a/src/introduction/abtnode-overview/images/abtnode-servicegateway-en.png b/src/introduction/overview/images/abtnode-servicegateway-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-servicegateway-en.png rename to src/introduction/overview/images/abtnode-servicegateway-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-settings-en.png b/src/introduction/overview/images/abtnode-settings-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-settings-en.png rename to src/introduction/overview/images/abtnode-settings-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-team-en.png b/src/introduction/overview/images/abtnode-team-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-team-en.png rename to src/introduction/overview/images/abtnode-team-en.png diff --git a/src/introduction/abtnode-overview/images/abtnode-viewlogs-en.png b/src/introduction/overview/images/abtnode-viewlogs-en.png similarity index 100% rename from src/introduction/abtnode-overview/images/abtnode-viewlogs-en.png rename to src/introduction/overview/images/abtnode-viewlogs-en.png diff --git a/src/introduction/abtnode-overview/images/login-to-abt-node.png b/src/introduction/overview/images/login-to-abt-node.png similarity index 100% rename from src/introduction/abtnode-overview/images/login-to-abt-node.png rename to src/introduction/overview/images/login-to-abt-node.png diff --git a/src/introduction/abtnode-overview/index.md b/src/introduction/overview/index.md similarity index 88% rename from src/introduction/abtnode-overview/index.md rename to src/introduction/overview/index.md index aaac5de..86289e8 100644 --- a/src/introduction/abtnode-overview/index.md +++ b/src/introduction/overview/index.md @@ -9,13 +9,13 @@ tags: - 'blocklet server' --- -An ArcBlock instance is composed of one or more Blocklet Servers. Each Blocklet Server offers the ability to create decentralized applications (DApps). The Blocklet Servers offer a fully integrated blockchain framework with decentralized identity while having a small footprint. It can be deployed on diverse platforms like a public or private clouds, bare metal machines, or developer desktops. Blocklet Servers offers intuitive UI to build blockchain nodes, smart contracts, application logic, and more with zero hassle. Users with ABT Wallet can access the DApps deployed on the Blocklet Servers. +An ArcBlock instance is composed of one or more Blocklet Servers. Each Blocklet Server offers the ability to create decentralized applications (DApps). The Blocklet Servers offer a fully integrated blockchain framework with decentralized identity while having a small footprint. It can be deployed on diverse platforms like a public or private clouds, bare metal machines, or developer desktops. Blocklet Servers offers intuitive UI to build blockchain nodes, smart contracts, application logic, and more with zero hassle. Users with DID Wallet can access the DApps deployed on the Blocklet Servers.  In the following actions, we will go over all the capabilities offered by the Blocklet Server in detail. -## ABT Dashboard +## Dashboard The dashboard offers a unified view of the underlying infrastructure available with the Blocklet Server. It lists down different tenets of Blocklet Server, not limited to the following : @@ -28,11 +28,11 @@ The dashboard offers a unified view of the underlying infrastructure available w  -## Marketplace +## Store -Blocklets are the foundation block for your application. They can deliver various behaviours like DApps, smart contracts, blockchain etc. The Marketplace is a digital catalog of Blocklets from ArcBlock, ecosystem partners, and software vendors that make it easy to find, install, manage and one-click deploy Blocklets on your Blocklet Server. +Blocklets are the foundation block for your application. They can deliver various behaviours like DApps, smart contracts, blockchain etc. The Store is a digital catalog of Blocklets from ArcBlock, ecosystem partners, and software vendors that make it easy to find, install, manage and one-click deploy Blocklets on your Blocklet Server. - + ## Blocklets diff --git a/src/introduction/abtnode-overview/index.zh.md b/src/introduction/overview/index.zh.md similarity index 100% rename from src/introduction/abtnode-overview/index.zh.md rename to src/introduction/overview/index.zh.md diff --git a/src/introduction/abtnode-setup/images/aws_acceptterms.png b/src/introduction/setup/images/aws_acceptterms.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_acceptterms.png rename to src/introduction/setup/images/aws_acceptterms.png diff --git a/src/introduction/abtnode-setup/images/aws_ec2_http_access.png b/src/introduction/setup/images/aws_ec2_http_access.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_ec2_http_access.png rename to src/introduction/setup/images/aws_ec2_http_access.png diff --git a/src/introduction/abtnode-setup/images/aws_ec2_https_access.png b/src/introduction/setup/images/aws_ec2_https_access.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_ec2_https_access.png rename to src/introduction/setup/images/aws_ec2_https_access.png diff --git a/src/introduction/abtnode-setup/images/aws_ec2_view.png b/src/introduction/setup/images/aws_ec2_view.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_ec2_view.png rename to src/introduction/setup/images/aws_ec2_view.png diff --git a/src/introduction/abtnode-setup/images/aws_launch.png b/src/introduction/setup/images/aws_launch.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_launch.png rename to src/introduction/setup/images/aws_launch.png diff --git a/src/introduction/abtnode-setup/images/aws_marketplace.png b/src/introduction/setup/images/aws_marketplace.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_marketplace.png rename to src/introduction/setup/images/aws_marketplace.png diff --git a/src/introduction/abtnode-setup/images/aws_product_config.png b/src/introduction/setup/images/aws_product_config.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_product_config.png rename to src/introduction/setup/images/aws_product_config.png diff --git a/src/introduction/abtnode-setup/images/aws_subscription_auth.png b/src/introduction/setup/images/aws_subscription_auth.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_subscription_auth.png rename to src/introduction/setup/images/aws_subscription_auth.png diff --git a/src/introduction/abtnode-setup/images/aws_terms.png b/src/introduction/setup/images/aws_terms.png similarity index 100% rename from src/introduction/abtnode-setup/images/aws_terms.png rename to src/introduction/setup/images/aws_terms.png diff --git a/src/introduction/abtnode-setup/images/install_node.gif b/src/introduction/setup/images/install_node.gif similarity index 100% rename from src/introduction/abtnode-setup/images/install_node.gif rename to src/introduction/setup/images/install_node.gif diff --git a/src/introduction/abtnode-setup/images/install_node.yml b/src/introduction/setup/images/install_node.yml similarity index 100% rename from src/introduction/abtnode-setup/images/install_node.yml rename to src/introduction/setup/images/install_node.yml diff --git a/src/introduction/abtnode-setup/images/install_nodejs_lts.gif b/src/introduction/setup/images/install_nodejs_lts.gif similarity index 100% rename from src/introduction/abtnode-setup/images/install_nodejs_lts.gif rename to src/introduction/setup/images/install_nodejs_lts.gif diff --git a/src/introduction/abtnode-setup/images/install_nvm.gif b/src/introduction/setup/images/install_nvm.gif similarity index 100% rename from src/introduction/abtnode-setup/images/install_nvm.gif rename to src/introduction/setup/images/install_nvm.gif diff --git a/src/introduction/abtnode-setup/images/install_nvm.yml b/src/introduction/setup/images/install_nvm.yml similarity index 100% rename from src/introduction/abtnode-setup/images/install_nvm.yml rename to src/introduction/setup/images/install_nvm.yml diff --git a/src/introduction/abtnode-setup/images/list_node_versions.gif b/src/introduction/setup/images/list_node_versions.gif similarity index 100% rename from src/introduction/abtnode-setup/images/list_node_versions.gif rename to src/introduction/setup/images/list_node_versions.gif diff --git a/src/introduction/abtnode-setup/images/list_node_versions.yml b/src/introduction/setup/images/list_node_versions.yml similarity index 100% rename from src/introduction/abtnode-setup/images/list_node_versions.yml rename to src/introduction/setup/images/list_node_versions.yml diff --git a/src/introduction/abtnode-setup/images/list_node_versions_2.gif b/src/introduction/setup/images/list_node_versions_2.gif similarity index 100% rename from src/introduction/abtnode-setup/images/list_node_versions_2.gif rename to src/introduction/setup/images/list_node_versions_2.gif diff --git a/src/introduction/abtnode-setup/images/server_acceptterms.png b/src/introduction/setup/images/server_acceptterms.png similarity index 100% rename from src/introduction/abtnode-setup/images/server_acceptterms.png rename to src/introduction/setup/images/server_acceptterms.png diff --git a/src/introduction/abtnode-setup/images/server_welcome.png b/src/introduction/setup/images/server_welcome.png similarity index 100% rename from src/introduction/abtnode-setup/images/server_welcome.png rename to src/introduction/setup/images/server_welcome.png diff --git a/src/introduction/abtnode-setup/index.md b/src/introduction/setup/index.md similarity index 94% rename from src/introduction/abtnode-setup/index.md rename to src/introduction/setup/index.md index 7bce2bb..2b4da79 100644 --- a/src/introduction/abtnode-setup/index.md +++ b/src/introduction/setup/index.md @@ -2,7 +2,7 @@ title: 'Blocklet Server Setup' description: 'Blocklet Server Setup' keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' +author: 'wangshijun' category: '' layout: 'documentation' tags: @@ -12,11 +12,11 @@ Blocklet Server can be installed in the following ways : - [Use the binary distribution](#use-the-binary-distribution) - [Use the official Docker image](#use-the-official-docker-image) - - [Use AWS Marketplace](#use-aws-marketplace) + - [Use AWS Store](#use-aws-Store) You can use either of the above ways to deploy it on any infrastructure like Cloud, Virtual machines, workstations, etc. -*If you are interested in running Blocklet Server locally on your device, we currently support [Linux] and [macOS]. If you are using another OS like Windows, we recommend using Windows Subsystem Linux (WSL), or you can use a virtual machine and make sure your ABT Wallet can access your VM's IP address.* +*If you are interested in running Blocklet Server locally on your device, we currently support [Linux] and [macOS]. If you are using another OS like Windows, we recommend using Windows Subsystem Linux (WSL), or you can use a virtual machine and make sure your DID Wallet can access your VM's IP address.* ## Use the binary distribution @@ -176,7 +176,7 @@ The above command will start the Blocklet Server. You can access the Blocklet Se  -*Please do not access the Blocklet Server using localhost / 127.0.0.1 address. You will not be able to connect it using ABT wallet.* +*Please do not access the Blocklet Server using localhost / 127.0.0.1 address. You will not be able to connect it using DID Wallet.* ## Use the official Docker image @@ -190,7 +190,7 @@ Docker images are based on the Debian Linux platform. ### Access Blocklet Server -The above command will start the Blocklet Server container and bind it to port 80 / 443 on the Host machine. You should access it using the IP address of the Host machine (`http://192.168.1.5/`). *Please do not access the Blocklet Server using localhost / 127.0.0.1 address. You will not be able to connect it using ABT wallet.* +The above command will start the Blocklet Server container and bind it to port 80 / 443 on the Host machine. You should access it using the IP address of the Host machine (`http://192.168.1.5/`). *Please do not access the Blocklet Server using localhost / 127.0.0.1 address. You will not be able to connect it using DID Wallet.*  @@ -198,12 +198,12 @@ After this, you must agree to License terms before accessing the Blocklet Server  -## Use AWS Marketplace +## Use AWS Store -You can run Blocklet Server on AWS using [AWS Marketplace](https://aws.amazon.com/marketplace/pp/B089KM6SFR?qid=1620381487343&sr=0-1&ref_=srh_res_product_title) +You can run Blocklet Server on AWS using [AWS Store](https://aws.amazon.com/Store/pp/B089KM6SFR?qid=1620381487343&sr=0-1&ref_=srh_res_product_title) 1. You must select **Continue to subscribe** from the overview tab, -  +  2. You are presented with *Terms and Conditions*, to which you must agree by clicking **Accept Terms**.  @@ -255,4 +255,4 @@ ArcBlock recommends using the secured approach over the non-secured approach. Th [macOS]: https://www.apple.com/macos [NVM]: https://github.com/nvm-sh/nvm [Node.js]: https://nodejs.org -[npm]: https://www.npmjs.com \ No newline at end of file +[npm]: https://www.npmjs.com diff --git a/src/introduction/abtnode-setup/index.zh.md b/src/introduction/setup/index.zh.md similarity index 99% rename from src/introduction/abtnode-setup/index.zh.md rename to src/introduction/setup/index.zh.md index 9329b51..f02bdb2 100644 --- a/src/introduction/abtnode-setup/index.zh.md +++ b/src/introduction/setup/index.zh.md @@ -2,7 +2,7 @@ title: '如何获取 Blocklet Server ' description: '如何获取 Blocklet Server ?' keywords: 'blocklet server, blocklet' -author: 'tigeryu8900, nate' +author: 'wangshijun, nate' category: '' layout: 'documentation' tags: @@ -69,7 +69,7 @@ Blocklet Server 的网关依赖于 Nginx, 所以我们需要安装 Nginx. 从 [ABT 钱包官网](http://abtwallet.io) 找到下载入口完成 ABT 钱包的安装。然后打开钱包跟随钱包指引完成钱包的初始化。 -### 安装 Blocklet CLI +### 安装 Blocklet CLI 现在，使用 [npm] 执行下面命令即可安装 Blocklet CLI ： diff --git a/src/logs/blocklet-logs/index.md b/src/logs/blocklet-logs/index.md index dbaa73b..23d77aa 100644 --- a/src/logs/blocklet-logs/index.md +++ b/src/logs/blocklet-logs/index.md @@ -1,24 +1,25 @@ --- -title: 'Runtime Logs' +title: 'Blocklet Logs' description: 'Blocklet Logs' -keywords: 'blocklet server, logs, blocklet' +keywords: 'logs, blocklet' category: '' layout: 'documentation' tags: - 'blocklet server' --- -The logs console shows log lines read from the logs files created by Blocklets, Service discovery, and the Blocklet Server. Log source information is displayed at the top right of the logs panel. +The logs console also shows log lines read from the logs files created by blocklets, log source information is displayed at the top right of the logs panel.  -The logs console is segmented into multiple tabs(error, info etc.). These tabs are corresponding to the different log files created by each Blocklet. The ERROR tab displays logs generated from `error.log`, and INFO is shown from `output.log`.Additionally, the service discovery component has `access.log`, which is captured under the ACCESS tab of the log console.You can scroll through each view to determine all logs statements from the latest log file. +The logs console is segmented into multiple tabs(error, info etc.). These tabs are corresponding to the different log files created by each blocklet. The ERROR tab displays logs generated from `error.log`, and INFO is shown from `output.log`. You can scroll through each view to determine all logs statements from the latest log file. -The View Logs console also provides a search function to quickly lookup the required Blocklet using its name. +The logs console also provides a search function to quickly lookup the required log producer using its name.  ### Archived Logs -Blocklet Server archived logs file on day rollover. The archived files are available at path specified by `BLOCKLET_LOGS_DIR` environment variable. You can determine the path for a specific Blocklet from [Block management > Environment](/en/blocklet/environments) console. + +Blocklet Server archived logs file on day rollover. The archived files for blocklets are available at path specified by `BLOCKLET_LOGS_DIR` environment variable. You can determine the path for a specific blocklet from [Blocklet management > Overview](/en/blocklet/configuration) console.  diff --git a/src/logs/index.md b/src/logs/index.md index 1e2822d..0eec345 100644 --- a/src/logs/index.md +++ b/src/logs/index.md @@ -1,7 +1,7 @@ --- -title: 'Logs' -description: 'Logs' -keywords: 'blocklet server, logs, blocklet' +title: 'Logs Viewer' +description: 'Logs Viewer' +keywords: 'logs, blocklet' category: '' layout: 'documentation' tags: @@ -10,7 +10,8 @@ tags: Application Logging is a vital practice that serves various operational needs like monitoring, root-cause analysis, journaling, etc. An Blocklet Server usually consists of multiple components, each of which generates logs of its own. -The **View Logs** feature provides a console to quickly look up the log generated by the various deployed components. The console can serve application development day-to-day development and operational needs while reducing associated time and effort. In this section, let's learn how to look up the different logs. +The **Logs Viewer** provides a console to quickly look up the log generated by the various deployed components. The console can serve application development day-to-day development and operational needs while reducing associated time and effort. In this section, let's learn how to look up the different logs. -- [Runtime Logs](./blocklet-logs) -- [Lifecycle Logs](./abtnode-logs) +- [Server Logs](./server-logs) +- [Router Logs](./router-logs) +- [Blocklet Logs](./blocklet-logs) diff --git a/src/logs/abtnode-logs/images/abtnode-logs.png b/src/logs/server-logs/images/abtnode-logs.png similarity index 100% rename from src/logs/abtnode-logs/images/abtnode-logs.png rename to src/logs/server-logs/images/abtnode-logs.png diff --git a/src/logs/abtnode-logs/index.md b/src/logs/server-logs/index.md similarity index 81% rename from src/logs/abtnode-logs/index.md rename to src/logs/server-logs/index.md index f951d6d..32a9b20 100644 --- a/src/logs/abtnode-logs/index.md +++ b/src/logs/server-logs/index.md @@ -1,14 +1,14 @@ --- -title: 'Lifecycle Logs' +title: 'Server Logs' description: 'Blocklet Server Logs' -keywords: 'blocklet server, logs, blocklet' +keywords: 'logs' category: '' layout: 'documentation' tags: - 'blocklet server' --- -Blocklet Server is responsible for executing all components like Service gateway, Blocklets, etc. Additionally, Blocklet management allows you to control the lifecycle of each Blocklet. You can install, start, stop, reload, upgrade and remove each Blocket. All these events are handles by Blocklet Server and thus logged under the corresponding logs. +Blocklet Server is responsible for executing all components like Service gateway, Blocklets, etc. Additionally, Blocklet management allows you to control the lifecycle of each Blocklet. You can install, start, stop, reload, upgrade and remove each blocklet. All these events are handles by Blocklet Server and thus logged under the corresponding logs. ```bash [2021-07-13 10:04:57] [info] [@abtnode/timemachine] "dry-run" {"dryRun":true} @@ -18,10 +18,10 @@ Blocklet Server is responsible for executing all components like Service gateway [2021-07-13 10:04:58] [info] [@abtnode/webapp] "log stream: add" {"name":"abtnode"} ``` -Blocklet Server generates the following 3 log files +Blocklet Server generates the following 3 log files + - `error.log`, contains all errors generated by Blocklet Server. -- `output.log`, contains information about the various events handled by Blocklet Server. It has Blocklet lifecycle logs, node metrics, etc. +- `output.log`, contains information about the various events handled by Blocklet Server. It has Blocklet lifecycle logs, node metrics, etc. - `access.log`, contains logs for all handled user requests -  diff --git a/src/marketplace/find-and-install/images/registries.png b/src/marketplace/find-and-install/images/registries.png deleted file mode 100644 index 2db2e8e..0000000 Binary files a/src/marketplace/find-and-install/images/registries.png and /dev/null differ diff --git a/src/marketplace/find-and-install/index.md b/src/marketplace/find-and-install/index.md deleted file mode 100644 index b06453e..0000000 --- a/src/marketplace/find-and-install/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: 'Find and Install Blocklets' -description: 'Find and Install Blocklets' -keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -The marketplace is a digital catalog of Blocklets created by ArcBlock, ecosystem partners, and third-party vendors. These Blocklet are fetched from different Blocklet registries, analogous to development package registries like `npm registry`. Each of these Blocklets can offer out-of-box capabilities by using ArcBlock Platform. The marketplace allows you to filter and install Blocklets based on your selection criteria. The Blocklet details page servers as a product guide which shows all provided information. - - - -## Find a Blocklet - -To get started, go to the left-hand action bar and click on **marketplace**. It will display a catalog of Blocklets created by the Blocklet Server community. Blocklets are shown with details like the latest release version, release date, install count, and project tags. You can sort the catalog by _popularity_ or by _name_. Additionally, a _search_ box is also provided to filter Blocklets based on their name and description. - - - -## Blocklet Overview - -The marketplace dashboard shows Blocklet summary, which can serve your selection criteria. But while working with a Blocklet you must determine its setup guide, environment configurations, license, etc. All these details are provided on the Blocklet details page. Click on a particular Blocklet on the marketplace dashboard to reach its details page. - - - -## Install a Blocklet - -Installing a Blocklets is quite easy. Find a Blocklet you want to add to your Blocklet Server and click on the _Install_ button. It will take sometime to complete the installation. - - - -Once the installation is complete, the marketplace dashboard will confirm this with a notification message.The Blocklet _Install_ button will also change to _Open_ button. - -The installation process does not start the Blocklet. You have to access the [Blocklet Management console](/en/blocklet) for starting / stopping / configuring the Blocklet. Please refer to the Blocklet details page for associated instructions. - - - -\_Note, some Blocklets may require additional configuration to work correctly, so be sure to check your configuration details if additional steps are required. - -## Blocklet Store - -Blocklet Server marketplace is configured to use Blocklets from the following Blocklet registries : - -1. Official Store: It provides hosting for production-ready Blocklets for the end-user. -2. Dev Store: It provides sample Blocklets for developers to know the possibilities with the ArcBlock platform. - - - -However, if you develop Blocklets for internal use only, you can set up a custom store by clicking **Add Blocklet Store**. You will need to provide a URL for the custom store. diff --git a/src/marketplace/find-and-install/index.zh.md b/src/marketplace/find-and-install/index.zh.md deleted file mode 100644 index 37d3c1a..0000000 --- a/src/marketplace/find-and-install/index.zh.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: '查找和安装 Blocklet' -description: '查找和安装 Blocklet' -keywords: 'blocklet server, blocklet' -author: 'tigeryu8900, nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -打开 `市场` 页面，在市场页面上寻找您想要安装的 Blocklet 点击 `安装` 按钮即可完成安装。 - - diff --git a/src/marketplace/index.md b/src/marketplace/index.md deleted file mode 100644 index 33c3998..0000000 --- a/src/marketplace/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'Blocklet Marketplace' -description: 'Blocklet Marketplace' -keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklets provide pluggable components for various user-oriented features by using the capabilities of the ArcBlock Platform.ArcBlock ecosystem partners have created numerous Blocklets to offer various features. Blocklet Marketplace allows you to discover and install Blocklets for your needs. It also serves as a product details document for an available Blocklet. - -## Contents - -- [Marketplace Dashboard](./find-and-install) : An guide for all Marketplace Features. diff --git a/src/marketplace/index.zh.md b/src/marketplace/index.zh.md deleted file mode 100644 index 21468ab..0000000 --- a/src/marketplace/index.zh.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 'Blocklet Marketplace' -description: 'Blocklet Marketplace' -keywords: 'blocklet server, blocklet' -author: 'nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklet Marketplace 是一个方便大家寻找、升/降级管理 Blocklet 的功能平台，类似手机的应用市场。 - -- [查找和安装 Blocklet](./find-and-install) -- [升级或降级 Blocklet](./upgrade-downgrade) diff --git a/src/misc/graphql-console/images/gql-console-1-en.png b/src/misc/graphql-console/images/gql-console-1-en.png deleted file mode 100644 index 65ebc60..0000000 Binary files a/src/misc/graphql-console/images/gql-console-1-en.png and /dev/null differ diff --git a/src/misc/graphql-console/images/gql-console-1-zh.png b/src/misc/graphql-console/images/gql-console-1-zh.png deleted file mode 100644 index 569f23f..0000000 Binary files a/src/misc/graphql-console/images/gql-console-1-zh.png and /dev/null differ diff --git a/src/misc/graphql-console/index.md b/src/misc/graphql-console/index.md deleted file mode 100644 index 3abbc89..0000000 --- a/src/misc/graphql-console/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'GraphQL Console' -description: 'GraphQL Console' -keywords: 'blocklet server, blocklet' -author: 'wangshijun' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklet Server's API is based on QraphQL. In the GraphQL console shown below, a list of all possible query keys is on the left, and an editable request is in the middle. The request can be sent via the triangle button, and the response appears on the right - -> To learn more about GraphQL, please visit [GraphQL official website](https://graphql.org/). - - diff --git a/src/misc/graphql-console/index.zh.md b/src/misc/graphql-console/index.zh.md deleted file mode 100644 index 529ba16..0000000 --- a/src/misc/graphql-console/index.zh.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'GraphQL 试验台' -description: 'GraphQL 试验台' -keywords: 'blocklet server, blocklet' -author: 'nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklet Server 的请求都是基于 GraphQL 的，在这个 `GraphQL 试验台` 可以看到整个节点所使用的接口，并且可以在控制台自由试验自定义的请求并进行验证。 - -> 想了解更多 GraphQL 知识可以访问 [GraphQL 官方网站](https://graphql.org/) 了解更多 - - diff --git a/src/misc/index.md b/src/misc/index.md deleted file mode 100644 index 595c232..0000000 --- a/src/misc/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: 'Misc' -description: 'Misc' -keywords: 'blocklet server, blocklet' -author: 'nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklet Server support some other features: - -- [Member Management](./member-management) -- [GraphQL Console](./graphql-console) -- [Generate wildcard HTTPS certificate](./generate-wildcard-https-certificate) diff --git a/src/misc/index.zh.md b/src/misc/index.zh.md deleted file mode 100644 index a05e0b9..0000000 --- a/src/misc/index.zh.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: '其他功能' -description: '其他功能' -keywords: 'blocklet server, blocklet' -author: 'nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklet Server 支持的其他功能: - -- [成员管理](./member-management) -- [GraphQL 试验台](./graphql-console) -- [生成通配符 HTTPS 证书](./generate-wildcard-https-certificate) diff --git a/src/misc/member-management/index.zh.md b/src/misc/member-management/index.zh.md deleted file mode 100644 index d7b788c..0000000 --- a/src/misc/member-management/index.zh.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: '成员管理' -description: '成员管理' -keywords: 'blocklet server, blocklet' -author: 'nate' -category: '' -layout: 'documentation' -tags: - - 'blocklet server' ---- - -Blocklet Server 可以自由添加成员，并且节点的拥有者可以在 `配置-团队` 页面自由管理成员权限。 - -首先，新成员需要准备好初始化完成的 [ABT 钱包](https://abtwallet.io/zh/)。 - -然后，你只需将当前 Blocklet Server 的访问地址发送给他，让对方用钱包做一次扫码操作即可： - - - -对方扫码之后，会得到这个结果，提示他没有权限登录该节点： - - - -此时，当前节点的拥有者即可在 `配置-团队` 页面看到刚刚的新成员加入申请了： - - - -可以看到多了一个角色为 `member` 的成员，并且目前的 approved 状态为 `No`。此时点击 `同意` 按钮即可完成新成员加入操作，同意之后，让对方再次扫码即可登录当前节点。 - - - -> 以后，你也可以到此页面通过点击 `拒绝` 按钮取消成员的访问权限。 diff --git a/src/node-settings/images/node-settings-upgrade-en.png b/src/settings/about/images/node-settings-upgrade-en.png similarity index 100% rename from src/node-settings/images/node-settings-upgrade-en.png rename to src/settings/about/images/node-settings-upgrade-en.png diff --git a/src/settings/about/index.md b/src/settings/about/index.md new file mode 100644 index 0000000..2288f25 --- /dev/null +++ b/src/settings/about/index.md @@ -0,0 +1,22 @@ +--- +title: 'About Page' +description: 'Upgrade your blocklet server' +keywords: 'server, upgrade, launcher' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +>This page is incomplete and must be updated
+ +### Update Check + +Blocklet Server can perform a daily check for an available newer version. Optionally, there is a _check for updates_ button to verify manually if a newer version is available. + +Blocklet Server does not perform auto-upgrade. An admin user must confirm the upgrade process. + + + +### Add to Blocklet Launcher diff --git a/src/node-settings/access-keys/images/node-settings-accesskeys-en.png b/src/settings/access-keys/images/node-settings-accesskeys-en.png similarity index 100% rename from src/node-settings/access-keys/images/node-settings-accesskeys-en.png rename to src/settings/access-keys/images/node-settings-accesskeys-en.png diff --git a/src/node-settings/access-keys/images/node-settings-secret-en.png b/src/settings/access-keys/images/node-settings-secret-en.png similarity index 100% rename from src/node-settings/access-keys/images/node-settings-secret-en.png rename to src/settings/access-keys/images/node-settings-secret-en.png diff --git a/src/node-settings/access-keys/index.md b/src/settings/access-keys/index.md similarity index 61% rename from src/node-settings/access-keys/index.md rename to src/settings/access-keys/index.md index 73aa753..2a415a9 100644 --- a/src/node-settings/access-keys/index.md +++ b/src/settings/access-keys/index.md @@ -1,6 +1,6 @@ --- title: 'Access Keys' -description: 'Access Keys' +description: 'Access and control your blocklet server through CI or program' keywords: 'blocklet server, blocklet' author: 'wangshijun' category: '' @@ -9,20 +9,24 @@ tags: - 'blocklet server' --- -Access keys are credentials for an Blocklet Server user. The *Access Keys* view allows you to create and delete access keys. +>This page is outdated and must be updated
-  +Access keys are credentials for an Blocklet Server user. The _Access Keys_ view allows you to create and delete access keys. + + You can use access keys to access Blocklet Server API and perform various actions. Access keys consist of two parts: -- an access key ID (for example, z1WcsR61T7CMkFtEuMqdj3skQr3BBPumJ6b) -- a secret access key (for example, z3riGmHPsJiM6mNtmGCvLX7H1KGjY6QBLxHpc8AetarTquqyvD7vtN3c18388pqKiyKG65HjA77jCLqK2oNN3zmBB). + +- access key ID (for example, z1WcsR61T7CMkFtEuMqdj3skQr3BBPumJ6b) +- access key secret (for example, z3riGmHPsJiM6mNtmGCvLX7H1KGjY6QBLxHpc8AetarTquqyvD7vtN3c18388pqKiyKG65HjA77jCLqK2oNN3zmBB). Authenticating your requests requires you to use your access key ID and secret access key together. Ensure you handle your access keys as securely as you do your user name and password. -  + > The secret access key can only be accessed at the time it is created. In the event that you lose your secret access key, you must delete it and create a new one. The Access keys can be used to support the following user cases : + - To perform continuous deployment of a Blocklet by using `blocklet deploy` command in CI. - To programatically configure the Blocklet Server by using `@abtnode/client` package. diff --git a/src/node-settings/node-attributes/images/Screen Shot 2021-07-22 at 4.32.01 PM.png b/src/settings/basic/images/Screen Shot 2021-07-22 at 4.32.01 PM.png similarity index 100% rename from src/node-settings/node-attributes/images/Screen Shot 2021-07-22 at 4.32.01 PM.png rename to src/settings/basic/images/Screen Shot 2021-07-22 at 4.32.01 PM.png diff --git a/src/node-settings/node-attributes/images/Screen Shot 2021-07-22 at 4.32.18 PM.png b/src/settings/basic/images/Screen Shot 2021-07-22 at 4.32.18 PM.png similarity index 100% rename from src/node-settings/node-attributes/images/Screen Shot 2021-07-22 at 4.32.18 PM.png rename to src/settings/basic/images/Screen Shot 2021-07-22 at 4.32.18 PM.png diff --git a/src/node-settings/node-attributes/images/Screen Shot 2021-07-22 at 4.32.44 PM.png b/src/settings/basic/images/Screen Shot 2021-07-22 at 4.32.44 PM.png similarity index 100% rename from src/node-settings/node-attributes/images/Screen Shot 2021-07-22 at 4.32.44 PM.png rename to src/settings/basic/images/Screen Shot 2021-07-22 at 4.32.44 PM.png diff --git a/src/node-settings/images/node-settings-1-en.png b/src/settings/basic/images/node-settings-1-en.png similarity index 100% rename from src/node-settings/images/node-settings-1-en.png rename to src/settings/basic/images/node-settings-1-en.png diff --git a/src/node-settings/images/node-settings-1-zh.png b/src/settings/basic/images/node-settings-1-zh.png similarity index 100% rename from src/node-settings/images/node-settings-1-zh.png rename to src/settings/basic/images/node-settings-1-zh.png diff --git a/src/node-settings/images/node-settings-2-en.png b/src/settings/basic/images/node-settings-2-en.png similarity index 100% rename from src/node-settings/images/node-settings-2-en.png rename to src/settings/basic/images/node-settings-2-en.png diff --git a/src/node-settings/images/node-settings-accesskeys-en.png b/src/settings/basic/images/node-settings-accesskeys-en.png similarity index 100% rename from src/node-settings/images/node-settings-accesskeys-en.png rename to src/settings/basic/images/node-settings-accesskeys-en.png diff --git a/src/node-settings/images/node-settings-secret-en.png b/src/settings/basic/images/node-settings-secret-en.png similarity index 100% rename from src/node-settings/images/node-settings-secret-en.png rename to src/settings/basic/images/node-settings-secret-en.png diff --git a/src/node-settings/node-attributes/index.md b/src/settings/basic/index.md similarity index 71% rename from src/node-settings/node-attributes/index.md rename to src/settings/basic/index.md index ab8fa64..d7069ff 100644 --- a/src/node-settings/node-attributes/index.md +++ b/src/settings/basic/index.md @@ -9,6 +9,8 @@ tags: - 'blocklet server' --- +>This page is outdated and must be updated
+ The _Basic Settings_ view configured the below described attributes about the Blocklet Server.  @@ -25,20 +27,12 @@ It is displayed at the top of the node console page. ### DID Wallet Location -Provides the location of a deployed [DID wallet Blocklet](https://store.blocklet.dev/blocklet/z8iZpnScvjjeeyYZQoHSdXm4GQTqcfTTGkyPP). +Provides the location of a deployed [DID Wallet Blocklet](https://store.blocklet.dev/blocklet/z8iZpnScvjjeeyYZQoHSdXm4GQTqcfTTGkyPP). ### Alerts Blocklet Server monitors the disk usage and can raise notifications when the usage goes above the specified limit. -### Automatic Update Check - -Blocklet Server can perform a daily check for an available newer version. Optionally, there is a _check for updates_ button to verify manually if a newer version is available. - -Blocklet Server does not perform auto-upgrade. An admin user must confirm the upgrade process. - - - ### Welcome Page Blocklet Server displays a welcome page to help users navigate to the Blocklet Server login and the Blocklet Server documentation pages. diff --git a/src/node-settings/node-attributes/images/node-settings-upgrade-en.png b/src/settings/certificates/images/node-settings-upgrade-en.png similarity index 100% rename from src/node-settings/node-attributes/images/node-settings-upgrade-en.png rename to src/settings/certificates/images/node-settings-upgrade-en.png diff --git a/src/settings/certificates/index.md b/src/settings/certificates/index.md new file mode 100644 index 0000000..52cc39c --- /dev/null +++ b/src/settings/certificates/index.md @@ -0,0 +1,17 @@ +--- +title: 'Certificates' +description: 'Manage Certificates used/managed by blocklet server' +keywords: 'https' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +>This page is incomplete and must be updated
+ +## Server Managed Certificates + + +## Upload SSL Certificate diff --git a/src/node-settings/node-attributes/images/node-settings-1-en.png b/src/settings/images/node-settings-1-en.png similarity index 100% rename from src/node-settings/node-attributes/images/node-settings-1-en.png rename to src/settings/images/node-settings-1-en.png diff --git a/src/node-settings/node-attributes/images/node-settings-1-zh.png b/src/settings/images/node-settings-1-zh.png similarity index 100% rename from src/node-settings/node-attributes/images/node-settings-1-zh.png rename to src/settings/images/node-settings-1-zh.png diff --git a/src/node-settings/node-attributes/images/node-settings-2-en.png b/src/settings/images/node-settings-2-en.png similarity index 100% rename from src/node-settings/node-attributes/images/node-settings-2-en.png rename to src/settings/images/node-settings-2-en.png diff --git a/src/node-settings/node-attributes/images/node-settings-accesskeys-en.png b/src/settings/images/node-settings-accesskeys-en.png similarity index 100% rename from src/node-settings/node-attributes/images/node-settings-accesskeys-en.png rename to src/settings/images/node-settings-accesskeys-en.png diff --git a/src/node-settings/node-attributes/images/node-settings-secret-en.png b/src/settings/images/node-settings-secret-en.png similarity index 100% rename from src/node-settings/node-attributes/images/node-settings-secret-en.png rename to src/settings/images/node-settings-secret-en.png diff --git a/src/settings/images/node-settings-upgrade-en.png b/src/settings/images/node-settings-upgrade-en.png new file mode 100644 index 0000000..1493126 Binary files /dev/null and b/src/settings/images/node-settings-upgrade-en.png differ diff --git a/src/node-settings/index.md b/src/settings/index.md similarity index 62% rename from src/node-settings/index.md rename to src/settings/index.md index 8a1a485..dc149f2 100644 --- a/src/node-settings/index.md +++ b/src/settings/index.md @@ -1,6 +1,6 @@ --- -title: 'Node Settings' -description: 'Node Settings' +title: 'Server Settings' +description: 'Server Settings' keywords: 'blocklet server, blocklet' author: 'wangshijun' category: '' @@ -9,10 +9,15 @@ tags: - 'blocklet server' --- +>This page is incomplete and must be updated
+ The Settings console allows configuring attributes specific to the Blocklet Server. Additionally, it provides views to manage third-party integrations and Blocklet Server access keys. ## Contents -- [Basic Setting](./node-attributes) +- [Basic Setting](./basic) - [Access Keys](./access-keys) +- [Domain & URLS](./router) +- [Certificates](./Certificates) - [Integrations](./integrations) +- [About](./about) diff --git a/src/node-settings/index.zh.md b/src/settings/index.zh.md similarity index 100% rename from src/node-settings/index.zh.md rename to src/settings/index.zh.md diff --git a/src/node-settings/integrations/images/node-settings-integration-en.png b/src/settings/integrations/images/node-settings-integration-en.png similarity index 100% rename from src/node-settings/integrations/images/node-settings-integration-en.png rename to src/settings/integrations/images/node-settings-integration-en.png diff --git a/src/node-settings/integrations/index.md b/src/settings/integrations/index.md similarity index 89% rename from src/node-settings/integrations/index.md rename to src/settings/integrations/index.md index b51bf95..045e079 100644 --- a/src/node-settings/integrations/index.md +++ b/src/settings/integrations/index.md @@ -1,6 +1,6 @@ --- title: 'Integrations' -description: 'Integrations' +description: 'Connect your blocklet server with outside world' keywords: 'blocklet server, blocklet' author: 'wangshijun' category: '' @@ -11,9 +11,10 @@ tags: Integrations allow outgoing messages from Blocklet Server. These messages are related to Blocket updates, Blocklet Server configuration changes, and Alerts. You can integrate Blocklet Server with Slack and custom webhooks to receive the notifications. -  + Perform the following steps for Slack integration : + 1. Log into your Slack team and [set up incoming WebHooks](https://my.slack.com/services/new/incoming-webhook). 2. Identify the Slack channel where notifications should be sent to by default. Select Add Incoming WebHooks integration to add the configuration. 3. Copy the URL of the Webhook. It will be used to configure the Blocklet Server. diff --git a/src/router/basic-usage/images/router-basic-use-1-en.png b/src/settings/router/basic-usage/images/router-basic-use-1-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-1-en.png rename to src/settings/router/basic-usage/images/router-basic-use-1-en.png diff --git a/src/router/basic-usage/images/router-basic-use-1-zh.png b/src/settings/router/basic-usage/images/router-basic-use-1-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-1-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-1-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-10-en.png b/src/settings/router/basic-usage/images/router-basic-use-10-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-10-en.png rename to src/settings/router/basic-usage/images/router-basic-use-10-en.png diff --git a/src/router/basic-usage/images/router-basic-use-10-zh.png b/src/settings/router/basic-usage/images/router-basic-use-10-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-10-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-10-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-11-en.png b/src/settings/router/basic-usage/images/router-basic-use-11-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-11-en.png rename to src/settings/router/basic-usage/images/router-basic-use-11-en.png diff --git a/src/router/basic-usage/images/router-basic-use-11-zh.png b/src/settings/router/basic-usage/images/router-basic-use-11-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-11-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-11-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-12.png b/src/settings/router/basic-usage/images/router-basic-use-12.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-12.png rename to src/settings/router/basic-usage/images/router-basic-use-12.png diff --git a/src/router/basic-usage/images/router-basic-use-13-en.png b/src/settings/router/basic-usage/images/router-basic-use-13-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-13-en.png rename to src/settings/router/basic-usage/images/router-basic-use-13-en.png diff --git a/src/router/basic-usage/images/router-basic-use-13-zh.png b/src/settings/router/basic-usage/images/router-basic-use-13-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-13-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-13-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-14.png b/src/settings/router/basic-usage/images/router-basic-use-14.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-14.png rename to src/settings/router/basic-usage/images/router-basic-use-14.png diff --git a/src/router/basic-usage/images/router-basic-use-15-en.png b/src/settings/router/basic-usage/images/router-basic-use-15-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-15-en.png rename to src/settings/router/basic-usage/images/router-basic-use-15-en.png diff --git a/src/router/basic-usage/images/router-basic-use-15-zh.png b/src/settings/router/basic-usage/images/router-basic-use-15-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-15-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-15-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-2-en.png b/src/settings/router/basic-usage/images/router-basic-use-2-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-2-en.png rename to src/settings/router/basic-usage/images/router-basic-use-2-en.png diff --git a/src/router/basic-usage/images/router-basic-use-2-zh.png b/src/settings/router/basic-usage/images/router-basic-use-2-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-2-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-2-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-3-en.png b/src/settings/router/basic-usage/images/router-basic-use-3-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-3-en.png rename to src/settings/router/basic-usage/images/router-basic-use-3-en.png diff --git a/src/router/basic-usage/images/router-basic-use-3-zh.png b/src/settings/router/basic-usage/images/router-basic-use-3-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-3-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-3-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-4-en.png b/src/settings/router/basic-usage/images/router-basic-use-4-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-4-en.png rename to src/settings/router/basic-usage/images/router-basic-use-4-en.png diff --git a/src/router/basic-usage/images/router-basic-use-4-zh.png b/src/settings/router/basic-usage/images/router-basic-use-4-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-4-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-4-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-5-en.png b/src/settings/router/basic-usage/images/router-basic-use-5-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-5-en.png rename to src/settings/router/basic-usage/images/router-basic-use-5-en.png diff --git a/src/router/basic-usage/images/router-basic-use-5-zh.png b/src/settings/router/basic-usage/images/router-basic-use-5-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-5-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-5-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-6-en.png b/src/settings/router/basic-usage/images/router-basic-use-6-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-6-en.png rename to src/settings/router/basic-usage/images/router-basic-use-6-en.png diff --git a/src/router/basic-usage/images/router-basic-use-6-zh.png b/src/settings/router/basic-usage/images/router-basic-use-6-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-6-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-6-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-7-en.png b/src/settings/router/basic-usage/images/router-basic-use-7-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-7-en.png rename to src/settings/router/basic-usage/images/router-basic-use-7-en.png diff --git a/src/router/basic-usage/images/router-basic-use-7-zh.png b/src/settings/router/basic-usage/images/router-basic-use-7-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-7-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-7-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-8-en.png b/src/settings/router/basic-usage/images/router-basic-use-8-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-8-en.png rename to src/settings/router/basic-usage/images/router-basic-use-8-en.png diff --git a/src/router/basic-usage/images/router-basic-use-8-zh.png b/src/settings/router/basic-usage/images/router-basic-use-8-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-8-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-8-zh.png diff --git a/src/router/basic-usage/images/router-basic-use-9-en.png b/src/settings/router/basic-usage/images/router-basic-use-9-en.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-9-en.png rename to src/settings/router/basic-usage/images/router-basic-use-9-en.png diff --git a/src/router/basic-usage/images/router-basic-use-9-zh.png b/src/settings/router/basic-usage/images/router-basic-use-9-zh.png similarity index 100% rename from src/router/basic-usage/images/router-basic-use-9-zh.png rename to src/settings/router/basic-usage/images/router-basic-use-9-zh.png diff --git a/src/router/basic-usage/images/saveapply.png b/src/settings/router/basic-usage/images/saveapply.png similarity index 100% rename from src/router/basic-usage/images/saveapply.png rename to src/settings/router/basic-usage/images/saveapply.png diff --git a/src/router/basic-usage/index.md b/src/settings/router/basic-usage/index.md similarity index 99% rename from src/router/basic-usage/index.md rename to src/settings/router/basic-usage/index.md index 66f457e..57d6b0d 100644 --- a/src/router/basic-usage/index.md +++ b/src/settings/router/basic-usage/index.md @@ -2,7 +2,7 @@ title: 'Service Gateway Usage' description: 'How to setup Service Gateway' keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' +author: 'wangshijun' category: '' layout: 'documentation' tags: @@ -85,4 +85,3 @@ the desired snapshot that you want to apply.  Click on `Use This Snapshot`, and the selected snapshot would be put into effect immediately. - diff --git a/src/router/basic-usage/index.zh.md b/src/settings/router/basic-usage/index.zh.md similarity index 100% rename from src/router/basic-usage/index.zh.md rename to src/settings/router/basic-usage/index.zh.md diff --git a/src/router/bind-domain-and-ssl/images/add-site-en.jpg b/src/settings/router/bind-domain-and-ssl/images/add-site-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/add-site-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/add-site-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/add-site-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/add-site-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/add-site-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/add-site-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/apply-en.jpg b/src/settings/router/bind-domain-and-ssl/images/apply-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/apply-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/apply-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/apply-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/apply-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/apply-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/apply-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/cm-add-domain-en.jpg b/src/settings/router/bind-domain-and-ssl/images/cm-add-domain-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/cm-add-domain-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/cm-add-domain-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/cm-add-domain-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/cm-add-domain-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/cm-add-domain-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/cm-add-domain-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/cm-generated-en.jpg b/src/settings/router/bind-domain-and-ssl/images/cm-generated-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/cm-generated-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/cm-generated-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/cm-generated-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/cm-generated-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/cm-generated-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/cm-generated-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/cm-input-domain-en.jpg b/src/settings/router/bind-domain-and-ssl/images/cm-input-domain-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/cm-input-domain-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/cm-input-domain-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/cm-input-domain-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/cm-input-domain-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/cm-input-domain-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/cm-input-domain-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/config-certificate-manager-en.jpg b/src/settings/router/bind-domain-and-ssl/images/config-certificate-manager-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/config-certificate-manager-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/config-certificate-manager-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/config-certificate-manager-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/config-certificate-manager-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/config-certificate-manager-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/config-certificate-manager-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/https-site.jpg b/src/settings/router/bind-domain-and-ssl/images/https-site.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/https-site.jpg rename to src/settings/router/bind-domain-and-ssl/images/https-site.jpg diff --git a/src/router/bind-domain-and-ssl/images/input-domain-en.jpg b/src/settings/router/bind-domain-and-ssl/images/input-domain-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/input-domain-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/input-domain-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/input-domain-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/input-domain-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/input-domain-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/input-domain-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/input-messages-en.jpg b/src/settings/router/bind-domain-and-ssl/images/input-messages-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/input-messages-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/input-messages-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/input-messages-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/input-messages-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/input-messages-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/input-messages-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/site.jpg b/src/settings/router/bind-domain-and-ssl/images/site.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/site.jpg rename to src/settings/router/bind-domain-and-ssl/images/site.jpg diff --git a/src/router/bind-domain-and-ssl/images/ssl-input-en.jpg b/src/settings/router/bind-domain-and-ssl/images/ssl-input-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/ssl-input-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/ssl-input-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/ssl-input-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/ssl-input-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/ssl-input-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/ssl-input-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/ssl-tag-en.jpg b/src/settings/router/bind-domain-and-ssl/images/ssl-tag-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/ssl-tag-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/ssl-tag-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/ssl-tag-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/ssl-tag-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/ssl-tag-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/ssl-tag-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/visit-certificate-manager-en.jpg b/src/settings/router/bind-domain-and-ssl/images/visit-certificate-manager-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/visit-certificate-manager-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/visit-certificate-manager-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/visit-certificate-manager-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/visit-certificate-manager-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/visit-certificate-manager-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/visit-certificate-manager-zh.jpg diff --git a/src/router/bind-domain-and-ssl/images/visit-en.jpg b/src/settings/router/bind-domain-and-ssl/images/visit-en.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/visit-en.jpg rename to src/settings/router/bind-domain-and-ssl/images/visit-en.jpg diff --git a/src/router/bind-domain-and-ssl/images/visit-zh.jpg b/src/settings/router/bind-domain-and-ssl/images/visit-zh.jpg similarity index 100% rename from src/router/bind-domain-and-ssl/images/visit-zh.jpg rename to src/settings/router/bind-domain-and-ssl/images/visit-zh.jpg diff --git a/src/router/bind-domain-and-ssl/index.md b/src/settings/router/bind-domain-and-ssl/index.md similarity index 100% rename from src/router/bind-domain-and-ssl/index.md rename to src/settings/router/bind-domain-and-ssl/index.md diff --git a/src/router/bind-domain-and-ssl/index.zh.md b/src/settings/router/bind-domain-and-ssl/index.zh.md similarity index 100% rename from src/router/bind-domain-and-ssl/index.zh.md rename to src/settings/router/bind-domain-and-ssl/index.zh.md diff --git a/src/router/bind-domain-to-node/images/add-additional-domain-zh.jpg b/src/settings/router/bind-domain-to-node/images/add-additional-domain-zh.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/add-additional-domain-zh.jpg rename to src/settings/router/bind-domain-to-node/images/add-additional-domain-zh.jpg diff --git a/src/router/bind-domain-to-node/images/add-additional-domain.jpg b/src/settings/router/bind-domain-to-node/images/add-additional-domain.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/add-additional-domain.jpg rename to src/settings/router/bind-domain-to-node/images/add-additional-domain.jpg diff --git a/src/router/bind-domain-to-node/images/additional-domain-zh.jpg b/src/settings/router/bind-domain-to-node/images/additional-domain-zh.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/additional-domain-zh.jpg rename to src/settings/router/bind-domain-to-node/images/additional-domain-zh.jpg diff --git a/src/router/bind-domain-to-node/images/additional-domain.jpg b/src/settings/router/bind-domain-to-node/images/additional-domain.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/additional-domain.jpg rename to src/settings/router/bind-domain-to-node/images/additional-domain.jpg diff --git a/src/router/bind-domain-to-node/images/current-domain-blocklet-zh.jpg b/src/settings/router/bind-domain-to-node/images/current-domain-blocklet-zh.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/current-domain-blocklet-zh.jpg rename to src/settings/router/bind-domain-to-node/images/current-domain-blocklet-zh.jpg diff --git a/src/router/bind-domain-to-node/images/current-domain-blocklet.jpg b/src/settings/router/bind-domain-to-node/images/current-domain-blocklet.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/current-domain-blocklet.jpg rename to src/settings/router/bind-domain-to-node/images/current-domain-blocklet.jpg diff --git a/src/router/bind-domain-to-node/images/current-domain-zh.jpg b/src/settings/router/bind-domain-to-node/images/current-domain-zh.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/current-domain-zh.jpg rename to src/settings/router/bind-domain-to-node/images/current-domain-zh.jpg diff --git a/src/router/bind-domain-to-node/images/current-domain.jpg b/src/settings/router/bind-domain-to-node/images/current-domain.jpg similarity index 100% rename from src/router/bind-domain-to-node/images/current-domain.jpg rename to src/settings/router/bind-domain-to-node/images/current-domain.jpg diff --git a/src/router/bind-domain-to-node/index.md b/src/settings/router/bind-domain-to-node/index.md similarity index 100% rename from src/router/bind-domain-to-node/index.md rename to src/settings/router/bind-domain-to-node/index.md diff --git a/src/router/bind-domain-to-node/index.zh.md b/src/settings/router/bind-domain-to-node/index.zh.md similarity index 100% rename from src/router/bind-domain-to-node/index.zh.md rename to src/settings/router/bind-domain-to-node/index.zh.md diff --git a/src/router/certificates-for-localhost/images/cert-list.png b/src/settings/router/certificates-for-localhost/images/cert-list.png similarity index 100% rename from src/router/certificates-for-localhost/images/cert-list.png rename to src/settings/router/certificates-for-localhost/images/cert-list.png diff --git a/src/router/certificates-for-localhost/images/keychains-localhost-trust.png b/src/settings/router/certificates-for-localhost/images/keychains-localhost-trust.png similarity index 100% rename from src/router/certificates-for-localhost/images/keychains-localhost-trust.png rename to src/settings/router/certificates-for-localhost/images/keychains-localhost-trust.png diff --git a/src/router/certificates-for-localhost/images/keychains-localhost.png b/src/settings/router/certificates-for-localhost/images/keychains-localhost.png similarity index 100% rename from src/router/certificates-for-localhost/images/keychains-localhost.png rename to src/settings/router/certificates-for-localhost/images/keychains-localhost.png diff --git a/src/router/certificates-for-localhost/images/password.png b/src/settings/router/certificates-for-localhost/images/password.png similarity index 100% rename from src/router/certificates-for-localhost/images/password.png rename to src/settings/router/certificates-for-localhost/images/password.png diff --git a/src/router/certificates-for-localhost/images/test-failed.png b/src/settings/router/certificates-for-localhost/images/test-failed.png similarity index 100% rename from src/router/certificates-for-localhost/images/test-failed.png rename to src/settings/router/certificates-for-localhost/images/test-failed.png diff --git a/src/router/certificates-for-localhost/images/test-success.png b/src/settings/router/certificates-for-localhost/images/test-success.png similarity index 100% rename from src/router/certificates-for-localhost/images/test-success.png rename to src/settings/router/certificates-for-localhost/images/test-success.png diff --git a/src/router/certificates-for-localhost/index.md b/src/settings/router/certificates-for-localhost/index.md similarity index 100% rename from src/router/certificates-for-localhost/index.md rename to src/settings/router/certificates-for-localhost/index.md diff --git a/src/router/certificates-for-localhost/index.zh.md b/src/settings/router/certificates-for-localhost/index.zh.md similarity index 100% rename from src/router/certificates-for-localhost/index.zh.md rename to src/settings/router/certificates-for-localhost/index.zh.md diff --git a/src/misc/generate-wildcard-https-certificate/images/agreements.png b/src/settings/router/generate-wildcard-https-certificate/images/agreements.png similarity index 100% rename from src/misc/generate-wildcard-https-certificate/images/agreements.png rename to src/settings/router/generate-wildcard-https-certificate/images/agreements.png diff --git a/src/misc/generate-wildcard-https-certificate/images/certificates.png b/src/settings/router/generate-wildcard-https-certificate/images/certificates.png similarity index 100% rename from src/misc/generate-wildcard-https-certificate/images/certificates.png rename to src/settings/router/generate-wildcard-https-certificate/images/certificates.png diff --git a/src/misc/generate-wildcard-https-certificate/images/dns-txt.png b/src/settings/router/generate-wildcard-https-certificate/images/dns-txt.png similarity index 100% rename from src/misc/generate-wildcard-https-certificate/images/dns-txt.png rename to src/settings/router/generate-wildcard-https-certificate/images/dns-txt.png diff --git a/src/misc/generate-wildcard-https-certificate/images/email.png b/src/settings/router/generate-wildcard-https-certificate/images/email.png similarity index 100% rename from src/misc/generate-wildcard-https-certificate/images/email.png rename to src/settings/router/generate-wildcard-https-certificate/images/email.png diff --git a/src/misc/generate-wildcard-https-certificate/images/verify-dns.png b/src/settings/router/generate-wildcard-https-certificate/images/verify-dns.png similarity index 100% rename from src/misc/generate-wildcard-https-certificate/images/verify-dns.png rename to src/settings/router/generate-wildcard-https-certificate/images/verify-dns.png diff --git a/src/misc/generate-wildcard-https-certificate/index.md b/src/settings/router/generate-wildcard-https-certificate/index.md similarity index 100% rename from src/misc/generate-wildcard-https-certificate/index.md rename to src/settings/router/generate-wildcard-https-certificate/index.md diff --git a/src/misc/generate-wildcard-https-certificate/index.zh.md b/src/settings/router/generate-wildcard-https-certificate/index.zh.md similarity index 100% rename from src/misc/generate-wildcard-https-certificate/index.zh.md rename to src/settings/router/generate-wildcard-https-certificate/index.zh.md diff --git a/src/router/index.md b/src/settings/router/index.md similarity index 74% rename from src/router/index.md rename to src/settings/router/index.md index 962a03b..bd0bd03 100644 --- a/src/router/index.md +++ b/src/settings/router/index.md @@ -1,7 +1,7 @@ --- -title: 'Service Gateway' -description: 'Blocklet Server Service Gateway' -keywords: 'blocklet server, networking, service gateway, url, blocklet' +title: 'Domains and URLS' +description: 'Customize server domain and and access URLs' +keywords: 'server, networking, domain' author: 'nate' category: '' layout: 'documentation' @@ -9,6 +9,8 @@ tags: - 'blocklet server' --- +>This page is outdated and must be updated
+ The Service Gateway enables you to control communications for your Blocklet Server and configure your networking services to support your apps, services and Blocklets. In this section we will learn: - [What is the Service Gateway?](./what-is-router) diff --git a/src/router/index.zh.md b/src/settings/router/index.zh.md similarity index 100% rename from src/router/index.zh.md rename to src/settings/router/index.zh.md diff --git a/src/router/what-is-router/images/nginx.png b/src/settings/router/what-is-router/images/nginx.png similarity index 100% rename from src/router/what-is-router/images/nginx.png rename to src/settings/router/what-is-router/images/nginx.png diff --git a/src/router/what-is-router/images/router-settings-en.png b/src/settings/router/what-is-router/images/router-settings-en.png similarity index 100% rename from src/router/what-is-router/images/router-settings-en.png rename to src/settings/router/what-is-router/images/router-settings-en.png diff --git a/src/router/what-is-router/images/router-settings-zh.png b/src/settings/router/what-is-router/images/router-settings-zh.png similarity index 100% rename from src/router/what-is-router/images/router-settings-zh.png rename to src/settings/router/what-is-router/images/router-settings-zh.png diff --git a/src/router/what-is-router/images/ssl-certificate.png b/src/settings/router/what-is-router/images/ssl-certificate.png similarity index 100% rename from src/router/what-is-router/images/ssl-certificate.png rename to src/settings/router/what-is-router/images/ssl-certificate.png diff --git a/src/router/what-is-router/images/system-url.png b/src/settings/router/what-is-router/images/system-url.png similarity index 100% rename from src/router/what-is-router/images/system-url.png rename to src/settings/router/what-is-router/images/system-url.png diff --git a/src/router/what-is-router/images/url-mapping.png b/src/settings/router/what-is-router/images/url-mapping.png similarity index 100% rename from src/router/what-is-router/images/url-mapping.png rename to src/settings/router/what-is-router/images/url-mapping.png diff --git a/src/router/what-is-router/images/urls.png b/src/settings/router/what-is-router/images/urls.png similarity index 100% rename from src/router/what-is-router/images/urls.png rename to src/settings/router/what-is-router/images/urls.png diff --git a/src/router/what-is-router/index.md b/src/settings/router/what-is-router/index.md similarity index 82% rename from src/router/what-is-router/index.md rename to src/settings/router/what-is-router/index.md index f62715d..9cd83e1 100644 --- a/src/router/what-is-router/index.md +++ b/src/settings/router/what-is-router/index.md @@ -2,7 +2,7 @@ title: 'What is Service Gateway?' description: 'Routing, URL Mapping, SSL and Load Balancing for Blocklet Server?' keywords: 'blocklet server, blocklet' -author: 'tigeryu8900' +author: 'wangshijun' category: '' layout: 'documentation' tags: @@ -27,7 +27,7 @@ You can add new site and rules for specific IP addresses or domains that you own #### System URLs -Each time you install a Blocklet from the marketplace, Blocklet Server will automatically generate a new subdirectory that includes a system URL to ensure the node and the blocklet can communicate. System URLs also give you useful information about each blocklet including any available interfaces, the subdirectory, the current status of the blocklet and a link manage the blocklet. +Each time you install a Blocklet from the Store, Blocklet Server will automatically generate a new subdirectory that includes a system URL to ensure the node and the blocklet can communicate. System URLs also give you useful information about each blocklet including any available interfaces, the subdirectory, the current status of the blocklet and a link manage the blocklet.  @@ -46,4 +46,3 @@ Blocklet Server includes NGINX by default to give you a high performance routing ## Pub/Sub Gateway (coming soon) Blocklet Servers highly scalable pub/sub gateway for asynchronous messsaging. - diff --git a/src/router/what-is-router/index.zh.md b/src/settings/router/what-is-router/index.zh.md similarity index 100% rename from src/router/what-is-router/index.zh.md rename to src/settings/router/what-is-router/index.zh.md diff --git a/src/marketplace/find-and-install/images/marketplace-1-en.png b/src/store/find-and-install/images/marketplace-1-en.png similarity index 100% rename from src/marketplace/find-and-install/images/marketplace-1-en.png rename to src/store/find-and-install/images/marketplace-1-en.png diff --git a/src/marketplace/find-and-install/images/marketplace-1-zh.png b/src/store/find-and-install/images/marketplace-1-zh.png similarity index 100% rename from src/marketplace/find-and-install/images/marketplace-1-zh.png rename to src/store/find-and-install/images/marketplace-1-zh.png diff --git a/src/marketplace/find-and-install/images/marketplace-2-en.png b/src/store/find-and-install/images/marketplace-2-en.png similarity index 100% rename from src/marketplace/find-and-install/images/marketplace-2-en.png rename to src/store/find-and-install/images/marketplace-2-en.png diff --git a/src/marketplace/find-and-install/images/marketplace-blockletdetails-en.png b/src/store/find-and-install/images/marketplace-blockletdetails-en.png similarity index 100% rename from src/marketplace/find-and-install/images/marketplace-blockletdetails-en.png rename to src/store/find-and-install/images/marketplace-blockletdetails-en.png diff --git a/src/marketplace/find-and-install/images/marketplace-installblocklet-en.png b/src/store/find-and-install/images/marketplace-installblocklet-en.png similarity index 100% rename from src/marketplace/find-and-install/images/marketplace-installblocklet-en.png rename to src/store/find-and-install/images/marketplace-installblocklet-en.png diff --git a/src/marketplace/find-and-install/images/marketplace-openblocklet-en.png b/src/store/find-and-install/images/marketplace-openblocklet-en.png similarity index 100% rename from src/marketplace/find-and-install/images/marketplace-openblocklet-en.png rename to src/store/find-and-install/images/marketplace-openblocklet-en.png diff --git a/src/marketplace/find-and-install/images/popularity.png b/src/store/find-and-install/images/popularity.png similarity index 100% rename from src/marketplace/find-and-install/images/popularity.png rename to src/store/find-and-install/images/popularity.png diff --git a/src/store/find-and-install/images/registries.png b/src/store/find-and-install/images/registries.png new file mode 100644 index 0000000..828675b Binary files /dev/null and b/src/store/find-and-install/images/registries.png differ diff --git a/src/marketplace/find-and-install/images/search-blocklet.png b/src/store/find-and-install/images/search-blocklet.png similarity index 100% rename from src/marketplace/find-and-install/images/search-blocklet.png rename to src/store/find-and-install/images/search-blocklet.png diff --git a/src/marketplace/find-and-install/images/start-old.png b/src/store/find-and-install/images/start-old.png similarity index 100% rename from src/marketplace/find-and-install/images/start-old.png rename to src/store/find-and-install/images/start-old.png diff --git a/src/marketplace/find-and-install/images/start.png b/src/store/find-and-install/images/start.png similarity index 100% rename from src/marketplace/find-and-install/images/start.png rename to src/store/find-and-install/images/start.png diff --git a/src/store/find-and-install/index.md b/src/store/find-and-install/index.md new file mode 100644 index 0000000..21ec4d4 --- /dev/null +++ b/src/store/find-and-install/index.md @@ -0,0 +1,47 @@ +--- +title: 'Install Blocklets from Store' +description: 'Install Blocklets from Store' +keywords: 'blocklet server, blocklet' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +## Find a Blocklet + +To get started, go to the left-hand action bar and click on **Store**. It will display a catalog of Blocklets created by the ArcBlock community. Blocklets are shown with details like the latest release version, release date, install count, and project tags. You can sort the catalog by _popularity_ or by _name_. Additionally, a _search_ box is also provided to filter Blocklets based on their name and description. + + + +## Review a Blocklet + +The Store dashboard shows Blocklet summary, which can serve your selection criteria. But while working with a blocklet you must determine its setup guide, environment configurations, license, etc. All these details are provided on the details page hosted on the original store. Click on a particular blocklet will open its details page. + + + +## Install a Blocklet + +Installing a Blocklets is quite easy. Find a Blocklet you want to add to your Blocklet Server and click on the _Launch_ button. It will take sometime to complete the installation. + + + +Once the installation is complete, the store dashboard will confirm this with a notification message. The Blocklet _Launch_ button will also change to _Open_ button. + +The installation process does not start the Blocklet. You have to access the [Blocklet Management console](/en/blocklet) for starting/stopping/configuring the Blocklet. Please refer to the Blocklet details page for associated instructions. + + + +\_Note, some Blocklets may require additional configuration to work correctly, so be sure to check your configuration details if additional steps are required. + +## Multiple Blocklet Stores + +Blocklet server has the following 2 blocklet stores hosted by ArcBlock by default: + +1. [Official Store](https://store.blocklet.dev): It provides hosting for production-ready blocklets for the end-user. +2. [Dev Store](https://dev.store.blocklet.dev): It provides sample/demo blocklets for developers to learn the blocklet framework. + + + +You can add a custom store by clicking **Add Blocklet Store**. You will need to provide a URL for the custom store. diff --git a/src/store/index.md b/src/store/index.md new file mode 100644 index 0000000..1a64c9a --- /dev/null +++ b/src/store/index.md @@ -0,0 +1,17 @@ +--- +title: 'Blocklet Store' +description: 'Blocklet Store' +keywords: 'blocklet server, blocklet' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +Blocklets provide pluggable components for various user-oriented features by using the capabilities of the ArcBlock Platform. ArcBlock ecosystem partners have created numerous Blocklets to offer various features. Blocklet Store allows you to discover, purchase, and install Blocklets for your needs. It also serves as a product details document for an available Blocklet. + +## Contents + +- [What is Blocklet Store?](./what-is-store) : A brief introduction of blocklet store. +- [Install Blocklet from Store](./find-and-install) : An guide for all blocklet store features. diff --git a/src/store/index.zh.md b/src/store/index.zh.md new file mode 100644 index 0000000..1a64c9a --- /dev/null +++ b/src/store/index.zh.md @@ -0,0 +1,17 @@ +--- +title: 'Blocklet Store' +description: 'Blocklet Store' +keywords: 'blocklet server, blocklet' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +Blocklets provide pluggable components for various user-oriented features by using the capabilities of the ArcBlock Platform. ArcBlock ecosystem partners have created numerous Blocklets to offer various features. Blocklet Store allows you to discover, purchase, and install Blocklets for your needs. It also serves as a product details document for an available Blocklet. + +## Contents + +- [What is Blocklet Store?](./what-is-store) : A brief introduction of blocklet store. +- [Install Blocklet from Store](./find-and-install) : An guide for all blocklet store features. diff --git a/src/store/what-is-store/images/marketplace-1-en.png b/src/store/what-is-store/images/marketplace-1-en.png new file mode 100644 index 0000000..6ea8dab Binary files /dev/null and b/src/store/what-is-store/images/marketplace-1-en.png differ diff --git a/src/store/what-is-store/images/marketplace-1-zh.png b/src/store/what-is-store/images/marketplace-1-zh.png new file mode 100644 index 0000000..2408b13 Binary files /dev/null and b/src/store/what-is-store/images/marketplace-1-zh.png differ diff --git a/src/store/what-is-store/images/marketplace-2-en.png b/src/store/what-is-store/images/marketplace-2-en.png new file mode 100644 index 0000000..59c441c Binary files /dev/null and b/src/store/what-is-store/images/marketplace-2-en.png differ diff --git a/src/store/what-is-store/images/marketplace-blockletdetails-en.png b/src/store/what-is-store/images/marketplace-blockletdetails-en.png new file mode 100644 index 0000000..2ac965b Binary files /dev/null and b/src/store/what-is-store/images/marketplace-blockletdetails-en.png differ diff --git a/src/store/what-is-store/images/marketplace-installblocklet-en.png b/src/store/what-is-store/images/marketplace-installblocklet-en.png new file mode 100644 index 0000000..bd8cf65 Binary files /dev/null and b/src/store/what-is-store/images/marketplace-installblocklet-en.png differ diff --git a/src/store/what-is-store/images/marketplace-openblocklet-en.png b/src/store/what-is-store/images/marketplace-openblocklet-en.png new file mode 100644 index 0000000..f68e3f9 Binary files /dev/null and b/src/store/what-is-store/images/marketplace-openblocklet-en.png differ diff --git a/src/store/what-is-store/images/popularity.png b/src/store/what-is-store/images/popularity.png new file mode 100644 index 0000000..225e382 Binary files /dev/null and b/src/store/what-is-store/images/popularity.png differ diff --git a/src/store/what-is-store/images/registries.png b/src/store/what-is-store/images/registries.png new file mode 100644 index 0000000..828675b Binary files /dev/null and b/src/store/what-is-store/images/registries.png differ diff --git a/src/store/what-is-store/images/search-blocklet.png b/src/store/what-is-store/images/search-blocklet.png new file mode 100644 index 0000000..464695a Binary files /dev/null and b/src/store/what-is-store/images/search-blocklet.png differ diff --git a/src/store/what-is-store/images/start-old.png b/src/store/what-is-store/images/start-old.png new file mode 100644 index 0000000..3a6c0c2 Binary files /dev/null and b/src/store/what-is-store/images/start-old.png differ diff --git a/src/store/what-is-store/images/start.png b/src/store/what-is-store/images/start.png new file mode 100644 index 0000000..2926fed Binary files /dev/null and b/src/store/what-is-store/images/start.png differ diff --git a/src/store/what-is-store/index.md b/src/store/what-is-store/index.md new file mode 100644 index 0000000..2d32626 --- /dev/null +++ b/src/store/what-is-store/index.md @@ -0,0 +1,14 @@ +--- +title: 'What is Blocklet Store?' +description: 'What is Blocklet Store?' +keywords: 'blocklet server, blocklet' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet store' +--- + +The Store is a digital catalog of Blocklets created by ArcBlock, ecosystem partners, and third-party vendors. These Blocklet are fetched from different Blocklet registries, analogous to development package registries like `npm registry`. Each of these Blocklets can offer out-of-box capabilities by using ArcBlock Platform. The Store allows you to filter and install Blocklets based on your selection criteria. The Blocklet details page servers as a product guide which shows all provided information. + + diff --git a/src/team/index.md b/src/team/index.md new file mode 100644 index 0000000..9fb6f2d --- /dev/null +++ b/src/team/index.md @@ -0,0 +1,14 @@ +--- +title: 'Team' +description: 'Team' +keywords: 'team' +author: 'nate' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +Blocklet Server support some other features: + +- [Member Management](./members) diff --git a/src/misc/member-management/images/member-manager-1-en.png b/src/team/members/images/member-manager-1-en.png similarity index 100% rename from src/misc/member-management/images/member-manager-1-en.png rename to src/team/members/images/member-manager-1-en.png diff --git a/src/misc/member-management/images/member-manager-1-zh.png b/src/team/members/images/member-manager-1-zh.png similarity index 100% rename from src/misc/member-management/images/member-manager-1-zh.png rename to src/team/members/images/member-manager-1-zh.png diff --git a/src/misc/member-management/images/member-manager-2-en.png b/src/team/members/images/member-manager-2-en.png similarity index 100% rename from src/misc/member-management/images/member-manager-2-en.png rename to src/team/members/images/member-manager-2-en.png diff --git a/src/misc/member-management/images/member-manager-2-zh.png b/src/team/members/images/member-manager-2-zh.png similarity index 100% rename from src/misc/member-management/images/member-manager-2-zh.png rename to src/team/members/images/member-manager-2-zh.png diff --git a/src/misc/member-management/images/member-manager-3-en.png b/src/team/members/images/member-manager-3-en.png similarity index 100% rename from src/misc/member-management/images/member-manager-3-en.png rename to src/team/members/images/member-manager-3-en.png diff --git a/src/misc/member-management/images/member-manager-3-zh.png b/src/team/members/images/member-manager-3-zh.png similarity index 100% rename from src/misc/member-management/images/member-manager-3-zh.png rename to src/team/members/images/member-manager-3-zh.png diff --git a/src/misc/member-management/images/member-manager-4-en.png b/src/team/members/images/member-manager-4-en.png similarity index 100% rename from src/misc/member-management/images/member-manager-4-en.png rename to src/team/members/images/member-manager-4-en.png diff --git a/src/misc/member-management/images/member-manager-4-zh.png b/src/team/members/images/member-manager-4-zh.png similarity index 100% rename from src/misc/member-management/images/member-manager-4-zh.png rename to src/team/members/images/member-manager-4-zh.png diff --git a/src/misc/member-management/index.md b/src/team/members/index.md similarity index 57% rename from src/misc/member-management/index.md rename to src/team/members/index.md index 336f83f..1c600de 100644 --- a/src/misc/member-management/index.md +++ b/src/team/members/index.md @@ -1,6 +1,6 @@ --- -title: 'Member Management' -description: 'Member Management' +title: 'Members' +description: 'Members' keywords: 'blocklet server, blocklet' author: 'wangshijun' category: '' @@ -9,10 +9,20 @@ tags: - 'blocklet server' --- -Current members of an Blocklet Server can add other users as members to the Blocklet Server, and the node owner can manage member permissions -on the `Node -> Owner` page. +>This page is outdated and must be updated
-To add a new member, the new member should have [ABT Wallet](https://abtwallet.io/en/) set up on his or her phone. +Current members of an Blocklet Server can invite other users as members to the Blocklet Server, and the node owner can manage member permissions +on by issue or revoke member passports. + +## View Members + +## Invite New Member + +## Revoke Existing Member + +## Manage Member Access + +To invite a new member, the new member should have [DID Wallet](https://abtwallet.io/en/) set up on his or her phone. Then, the new member would scan the QR code on the Blocklet Server's site. @@ -22,7 +32,7 @@ A message will appear indicating that the new member does not have the permissio  -The owner of the node could see the sign-in attempt in the `Settings -> TEAM` page: +The owner of the node could see the sign-in attempt in the `TEAM` page:  diff --git a/src/team/passports/index.md b/src/team/passports/index.md new file mode 100644 index 0000000..ce0d7e2 --- /dev/null +++ b/src/team/passports/index.md @@ -0,0 +1,18 @@ +--- +title: 'Passports' +description: 'Passports' +keywords: 'passport, server' +author: 'wangshijun' +category: '' +layout: 'documentation' +tags: + - 'blocklet server' +--- + +>This page is incomplete and must be updated
+ +## What are Passports? + +## Builtin Passports + +## Trusted Passport Issuers diff --git a/version b/version index d3532a1..a918a2a 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.5.7 +0.6.0