diff --git a/README.md b/README.md index d778acb08..331f4fb4b 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,8 @@ The overall program is located under `/opt/siyuan/`, which is basically the stru The entry point is set when building the Docker image: `ENTRYPOINT ["/opt/siyuan/kernel" ]`, use `docker run b3log/siyuan` with parameters to start: -* `--workspace` specifies the workspace folder path, mounted to the container via `-v` on the host +* `--workspace`: Specifies the workspace folder path, mounted to the container via `-v` on the host +* `--accessAuthCode`: Specifies the access authorization code More parameters can refer to `--help`. The following is an example of a startup command: @@ -138,7 +139,7 @@ More parameters can refer to `--help`. The following is an example of a startup docker run -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container --accessAuthCode=xxx ``` -* `workspace_dir_host`: the workspace folder path on the host +* `workspace_dir_host`: The workspace folder path on the host * `workspace_dir_container`: The path of the workspace folder in the container, which is the same as specified in `--workspace` * `accessAuthCode`: Access authorization code, please **be sure to modify**, otherwise anyone can read and write your data diff --git a/README_zh_CN.md b/README_zh_CN.md index f57379b98..32889ee43 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -133,7 +133,8 @@ 构建 Docker 镜像时设置了入口:`ENTRYPOINT [ "/opt/siyuan/kernel" ]`,使用 `docker run b3log/siyuan` 并带参即可启动: -* `--workspace` 指定工作空间文件夹路径,在宿主机上通过 `-v` 挂载到容器中 +* `--workspace`:指定工作空间文件夹路径,在宿主机上通过 `-v` 挂载到容器中 +* `--accessAuthCode`:指定访问授权码 更多的参数可参考 `--help`。下面是一条启动命令示例: diff --git a/kernel/util/working.go b/kernel/util/working.go index e95aade88..4b5ab11d8 100644 --- a/kernel/util/working.go +++ b/kernel/util/working.go @@ -81,6 +81,11 @@ func Boot() { Container = ContainerStd if isRunningInDockerContainer() { Container = ContainerDocker + if "" == AccessAuthCode { + // The access authorization code command line parameter must be set when deploying via Docker https://github.com/siyuan-note/siyuan/issues/9328 + fmt.Printf("The access authorization code command line parameter (--accessAuthCode) must be set when deploying via Docker.") + os.Exit(1) + } } if ContainerStd != Container { ServerPort = FixedPort