Skip to content

Commit

Permalink
docs: fix capsule manager bin name (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
@zhongtianq
zhongtianq authored Sep 11, 2024
1 parent 13b13e0 commit 5ceebb7
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions docs/quick_start/step1.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,17 @@
"\n",
"CapsuleManager 默认会启用mTLS，关于如何配置mTLS可以参考[CapsuleManager mTLS](https://github.com/secretflow/capsule-manager/blob/master/README.md#mutual-tls)：\n",
"```bash\n",
"./capsule_manager --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
"./capsule_manager_grpc --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
" --tls_config.server_cert_path <SERVER_CERT_PATH> \\\n",
" --tls_config.client_ca_cert_path <CLIENT_CA_CERT_PATH>\n",
"```\n",
"如果不希望开启mTLS，可以添加启动参数`--tls_config.enable_tls false` 来**关闭mTLS功能**（注意关闭mTLS是不安全的，生产环境建议启动mTLS）：\n",
"```bash\n",
"./capsule_manager --tls_config.enable_tls false\n",
"./capsule_manager_grpc --tls_config.enable_tls false\n",
"```\n",
"默认的监听端口为8888，您可以在启动时添加`--port xx`参数修改为其他端口号。"
"默认的监听端口为8888，您可以在启动时添加`--port xx`参数修改为其他端口号。\n",
"\n",
"我们也提供了http的接口，只需要将capsule_manager_grpc替换为capsule_manager_http即可启动。"
]
},
{
Expand Down Expand Up @@ -140,15 +142,17 @@
"> 默认的监听端口为8888，您可以在启动时添加`--port xx`参数修改为其他端口号\n",
"\n",
"```bash\n",
"occlum run /bin/capsule_manager --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
"occlum run /bin/capsule_manager_grpc --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
" --tls_config.server_cert_path <SERVER_CERT_PATH> \\\n",
" --tls_config.client_ca_cert_path <CLIENT_CA_CERT_PATH>\n",
"```\n",
"\n",
"如果不希望开启mTLS，可以添加启动参数`--tls_config.enable_tls false` 来**关闭mTLS功能**（注意关闭mTLS是不安全的，生产环境建议启动mTLS）：\n",
"```bash\n",
"occlum run /bin/capsule_manager --tls_config.enable_tls false\n",
"```"
"occlum run /bin/capsule_manager_grpc --tls_config.enable_tls false\n",
"```\n",
"\n",
"我们也提供了http的接口，只需要将capsule_manager_grpc替换为capsule_manager_http即可启动。"
]
},
{
Expand Down Expand Up @@ -207,19 +211,21 @@
"\n",
"CapsuleManager 默认会启用mTLS，关于如何配置mTLS可以参考[CapsuleManager mTLS](https://github.com/secretflow/capsule-manager/blob/master/README.md#mutual-tls)：\n",
"```bash\n",
"./capsule_manager --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
"./capsule_manager_grpc --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
" --tls_config.server_cert_path <SERVER_CERT_PATH> \\\n",
" --tls_config.client_ca_cert_path <CLIENT_CA_CERT_PATH>\n",
"```\n",
"如果不希望开启mTLS，可以添加启动参数`--tls_config.enable_tls false` 来**关闭mTLS功能**（注意关闭mTLS是不安全的，生产环境建议启动mTLS）：\n",
"```bash\n",
"./capsule_manager --tls_config.enable_tls false\n",
"./capsule_manager_grpc --tls_config.enable_tls false\n",
"```\n",
"默认的监听端口为8888，您可以在启动时添加`--port xx`参数修改为其他端口号。\n",
"\n",
"我们也提供了http的接口，只需要将capsule_manager_grpc替换为capsule_manager_http即可启动。\n",
"\n",
"#### 5. 获取CapsuleManager所在的VM度量值\n",
"\n",
"目前暂无简易工具可以获取度量值，您可以在后续步骤中获取远程认证报告并记录其中携带的度量值用于后验。"
"目前暂无简易工具可以获取度量值，您可以在后续步骤中获取远程认证报告并记录其中携带的度量值用于后验。\n"
]
},
{
Expand Down Expand Up @@ -265,16 +271,18 @@
"\n",
"CapsuleManager 默认会启用mTLS，关于如何配置mTLS可以参考[CapsuleManager mTLS](https://github.com/secretflow/capsule-manager/blob/master/README.md#mutual-tls)：\n",
"```bash\n",
"./capsule_manager --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
"./capsule_manager_grpc --tls_config.server_private_key_path <SERVER_CERT_KEY_PATH> \\\n",
" --tls_config.server_cert_path <SERVER_CERT_PATH> \\\n",
" --tls_config.client_ca_cert_path <CLIENT_CA_CERT_PATH>\n",
"```\n",
"如果不希望开启mTLS，可以添加启动参数`--tls_config.enable_tls false` 来**关闭mTLS功能**（注意关闭mTLS是不安全的，生产环境建议启动mTLS）：\n",
"```bash\n",
"./capsule_manager --tls_config.enable_tls false\n",
"./capsule_manager_grpc --tls_config.enable_tls false\n",
"```\n",
"默认的监听端口为8888，您可以在启动时添加`--port xx`参数修改为其他端口号。\n",
"\n",
"我们也提供了http的接口，只需要将capsule_manager_grpc替换为capsule_manager_http即可启动。\n",
"\n",
"#### 4. 获取CapsuleManager所在的VM度量值\n",
"\n",
"目前暂无简易工具可以获取度量值，您可以在后续步骤中获取远程认证报告并记录其中携带的度量值用于后验。"
Expand Down

0 comments on commit 5ceebb7

Please sign in to comment.