diff --git a/.dockerignore b/.dockerignore index 68b25279..b769669b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -3,3 +3,4 @@ node_modules dist .history images +docs \ No newline at end of file diff --git a/README.md b/README.md index f38610ee..a6c19494 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,31 @@ services: restart: always ``` +直接启动的Docker命令 + +```bash +docker run -itd --name stackedit \ + -p 8080:8080 \ + -e LISTENING_PORT=8080 \ + -e ROOT_URL=/ \ + -e USER_BUCKET_NAME=root \ + -e DROPBOX_APP_KEY=【不需要支持则删掉】 \ + -e DROPBOX_APP_KEY_FULL=【不需要支持则删掉】 \ + -e GITHUB_CLIENT_ID=【不需要支持则删掉】 \ + -e GITHUB_CLIENT_SECRET=【不需要支持则删掉】 \ + -e GITEE_CLIENT_ID=【不需要支持则删掉】 \ + -e GITEE_CLIENT_SECRET=【不需要支持则删掉】 \ + -e GOOGLE_CLIENT_ID=【不需要支持则删掉】 \ + -e GOOGLE_API_KEY=【不需要支持则删掉】 \ + mafgwo/stackedit:【docker中央仓库找到最新版本】 + +``` + +**[如何配置Gitee应用](./docs/部署之Gitee应用创建.md)** +**[如何配置GitHub应用](./docs/部署之GitHub应用创建.md)** +**[如何配置Gitea应用](./docs/部署之Gitea应用创建.md)** + + 启动或停止命令 ```bash # 在 docker-compose.yml 文件目录下 启动命令 diff --git a/docs/部署之GitHub应用创建.md b/docs/部署之GitHub应用创建.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/部署之Gitea应用创建.md b/docs/部署之Gitea应用创建.md new file mode 100644 index 00000000..f4bfec5f --- /dev/null +++ b/docs/部署之Gitea应用创建.md @@ -0,0 +1,23 @@ +# Gitea应用配置说明 + +> StackEdit中文版支持Gitea，则需要到Gitea创建一个应用，在StackEdit中文版绑定Gitea账号的时候填入。 + + +# 如何创建Gitea应用 + +按下面图的指示创建 + + +![](../images/gitea/gitea01.pngg) + +![](../images/gitea/gitea02.pngg) + +![](../images/gitea/gitea03.pngg) + +![](../images/gitea/gitea04.pngg) + +创建成功后即可看到应用ID 和 应用秘钥。 + +# Gitea跨域问题 + +由于StackEdit中文版是从浏览器直接访问Gitea接口，故个人部署的Gitea需要支持跨域，至于如何支持跨域，请参考官方文档：https://docs.gitea.io/en-us/config-cheat-sheet/#cors-cors diff --git a/docs/部署之Gitee应用创建.md b/docs/部署之Gitee应用创建.md new file mode 100644 index 00000000..bd0daf98 --- /dev/null +++ b/docs/部署之Gitee应用创建.md @@ -0,0 +1,19 @@ +# Gitee应用配置说明 + +> StackEdit中文版部署如果需要支持Gitee，则需要到Gitee创建一个应用，并复制其中的clientId和clientSecret填充到环境变量 GITEE_CLIENT_ID 和 GITEE_CLIENT_SECRET 中。 + + +# 如何创建Gitee应用 + +按下面图的指示创建 + + +![](../images/gitee/gitee01.png) + +![](../images/gitee/gitee02.png) + +![](../images/gitee/gitee03.png) + +![](../images/gitee/gitee04.png) + +创建成功后即可看到client id 和 client secret。 \ No newline at end of file diff --git a/images/gitea/gitea01.png b/images/gitea/gitea01.png new file mode 100644 index 00000000..7a90e413 Binary files /dev/null and b/images/gitea/gitea01.png differ diff --git a/images/gitea/gitea02.png b/images/gitea/gitea02.png new file mode 100644 index 00000000..e94119bb Binary files /dev/null and b/images/gitea/gitea02.png differ diff --git a/images/gitea/gitea03.png b/images/gitea/gitea03.png new file mode 100644 index 00000000..10100330 Binary files /dev/null and b/images/gitea/gitea03.png differ diff --git a/images/gitea/gitea04.png b/images/gitea/gitea04.png new file mode 100644 index 00000000..2f5f8ae9 Binary files /dev/null and b/images/gitea/gitea04.png differ diff --git a/images/gitee/gitee01.png b/images/gitee/gitee01.png new file mode 100644 index 00000000..e1eabedc Binary files /dev/null and b/images/gitee/gitee01.png differ diff --git a/images/gitee/gitee02.png b/images/gitee/gitee02.png new file mode 100644 index 00000000..d8ffd0dc Binary files /dev/null and b/images/gitee/gitee02.png differ diff --git a/images/gitee/gitee03.png b/images/gitee/gitee03.png new file mode 100644 index 00000000..e1b25f82 Binary files /dev/null and b/images/gitee/gitee03.png differ diff --git a/images/gitee/gitee04.png b/images/gitee/gitee04.png new file mode 100644 index 00000000..8493ad45 Binary files /dev/null and b/images/gitee/gitee04.png differ diff --git a/images/github/github01.png b/images/github/github01.png new file mode 100644 index 00000000..ec2126fe Binary files /dev/null and b/images/github/github01.png differ diff --git a/images/github/github02.png b/images/github/github02.png new file mode 100644 index 00000000..57b5f826 Binary files /dev/null and b/images/github/github02.png differ diff --git a/images/github/github03.png b/images/github/github03.png new file mode 100644 index 00000000..60e7c50f Binary files /dev/null and b/images/github/github03.png differ diff --git a/images/github/github04.png b/images/github/github04.png new file mode 100644 index 00000000..0e896882 Binary files /dev/null and b/images/github/github04.png differ diff --git a/images/github/github05.png b/images/github/github05.png new file mode 100644 index 00000000..fa1947f3 Binary files /dev/null and b/images/github/github05.png differ