feat(docker): docker

Author: MorvanZhou

.dockerignore

@@ -1,2 +1,26 @@
-/**/.env.development
 /**/.data
+/.*
+/logs
+/tmp
+/tests
+/img
+/dist
+/**/*.egg-info
+
+# local env files
+/.env.dev
+/.env.prod
+/.env.local
+
+# Editor directories and files
+.DS_Store
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+/temp
+/src/retk/plugins/official_plugins/**/*.json

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.11.9-slim-bullseye
+MAINTAINER [email protected]
+
+WORKDIR /app
+
+COPY . /app
+ENV PYTHONPATH=/app/src
+RUN python3 -m pip install --no-cache-dir -e .
+
+EXPOSE 8080
+
+ENV APP_LANGUAGE en
+ENV APP_PASSWORD ""
+ENV API_URL "http://127.0.0.1:8080"
+
+ENTRYPOINT ["python3", "run_in_docker.py"]

README.md

@@ -13,7 +13,7 @@
   <strong>English</strong> | <a href="README_ZH.md" target="_blank">简体中文</a>
 </p>
 
-Rethink is my understanding of self-developing.
+Rethink is a new understanding of self-developing.
 
 Every time a new thought is recorded,
 the relevant old thought will automatically emerge,
@@ -43,7 +43,45 @@ Making the new thought more connectable and memorable.
    which makes it easy to synchronize across multiple platforms.
 5. **Multi-language**: Support multiple languages, including Chinese and English.
 
-## Install
+## Deploy by Docker
+
+1. Pull the image:
+
+```shell
+docker pull morvanzhou/rethink
+```
+
+2. Run the container:
+
+For keeping your data safe, you should mount a local path to the container.
+
+```shell
+docker run -p 8080:8080 -v /your/data/path:/app/.data morvanzhou/rethink
+```
+
+Then you can visit `http://127.0.0.1:8080` in your browser.
+
+If you want to define another host's port, you have to also add an environment variable `API_URL`:
+
+```shell
+docker run -e API_URL=http://127.0.0.1:8001 -p 8001:8080 -v /your/data/path:/app/.data morvanzhou/rethink
+```
+
+If you want to set a password for authorization, you have to also add a environment variable `APP_PASSWORD`:
+
+```shell
+docker run -e APP_PASSWORD=12345678 -p 8080:8080 -v /your/data/path:/app/.data morvanzhou/rethink
+```
+
+All environment variables:
+
+- `API_URL`: the API url in app js code, default is `http://127.0.0.1:8080`
+- `APP_PASSWORD`: authorization password, default is None
+- `APP_LANGUAGE`: language, default is English, optional: zh, en
+
+## Use Python and pip to install
+
+The second way to use Rethink is to install it via pip.
 
 First install:
 

README_ZH.md

@@ -14,7 +14,7 @@
 </p>
 
 
-Rethink 表示重新思考，是我对于成长的理解。
+Rethink 表示重新思考，是对个人成长的新理解。
 
 每次记下新的认知时，相关的老认知都会自动涌现，交叉贯通，新旧认知不断 类比-迁移。
 使得每次记录都有再次发光的机会。所以 Rethink 的中文名是 比移。
@@ -38,7 +38,46 @@ Rethink 表示重新思考，是我对于成长的理解。
    ，便于在多个平台之间同步；
 5. **多语言**：支持多种语言，包括中文和英文。
 
-## 安装
+## 容器化部署
+
+1. 拉取镜像：
+
+```shell
+docker pull morvanzhou/rethink
+```
+
+2. 运行容器：
+
+为了保证数据安全，您应该将本地路径挂载到容器中。
+
+```shell
+docker run -p 8080:8080 -v /your/data/path:/app/.data morvanzhou/rethink
+```
+
+现在你可以在浏览器中访问 `http://127.0.0.1:8080` 使用服务。
+
+如果你想自定义其他端口，你除了需要修改 `-p` 参数的前半部分，还需要添加一个环境变量 `API_URL` 来重定向前端服务中的 API 的地址：
+请确保 `API_URL` 里的端口号和 `-p` 参数的前半部分一致。
+
+```shell 
+docker run -e API_URL=http://127.0.0.1:8081 -p 8081:8080 -v /your/data/path:/app/.data morvanzhou/rethink
+```
+
+如果你想做为 Rethink 鉴权，你可以添加环境变量 `APP_PASSWORD`：
+
+```shell
+docker run -e APP_PASSWORD=12345678 -p 8080:8080 -v /your/data/path:/app/.data morvanzhou/rethink
+```
+
+全部可配置的环境变量如下：
+
+- `API_URL`：前端服务中 API 的地址，默认为 `http://127.0.0.1:8080`
+- `APP_PASSWORD`：鉴权密码，默认为 None
+- `APP_LANGUAGE`：语言，默认为英语，可选值：zh, en
+
+## 使用 python 的 pip 安装
+
+第二种安装使用 Rethink 的方法是通过 pip 安装。然后用 python 直接启动服务。
 
 首次安装：
 

dockerBuild.sh

@@ -0,0 +1,2 @@
+version=$(grep "^version" setup.cfg | awk -F'=' '{print $2}' | tr -d '[:space:]')
+docker build -t morvanzhou/rethink:$version -t morvanzhou/rethink:latest .

main.py

@@ -17,12 +17,11 @@
 args = parser.parse_args()
 
 if __name__ == "__main__":
-    os.environ["VUE_APP_API_PORT"] = str(args.port)
+    os.environ["VUE_APP_API_URL"] = f"http://{args.host}:{args.port}"
     if os.environ.get("VUE_APP_MODE") is None:
         os.environ["VUE_APP_MODE"] = args.mode
 
     os.environ["RETHINK_SERVER_HEADLESS"] = "1" if args.headless else "0"
-    os.environ["RETHINK_SERVER_HOSTNAME"] = args.host
     os.environ["RETHINK_SERVER_DEBUG"] = "true" if args.debug else "false"
     if args.password is not None:
         os.environ["RETHINK_SERVER_PASSWORD"] = args.password

requirements.txt

@@ -12,7 +12,6 @@ httpx>=0.25.0
 captcha>=0.5.0
 python-multipart>=0.0.9
 cos-python-sdk-v5~=1.9.26
-numpy>=1.24.4
 whoosh~=2.7.4
 jieba>=0.42.1
 starlette>=0.37.2

run.sh

@@ -52,12 +52,11 @@ do
   esac
 done
 
-export VUE_APP_API_PORT=$port
+export VUE_APP_API_URL=http://$host:$port
 export VUE_APP_MODE=$mode
 # if mode is local, export RETHINK_LOCAL_STORAGE_PATH to .data
 if [ $mode == "local" ]; then
   export RETHINK_LOCAL_STORAGE_PATH=.
-  export RETHINK_SERVER_HOSTNAME=localhost
   export RETHINK_SERVER_HEADLESS=1
 fi
 echo "Running in $mode mode with reload=$reload on $host:$port"

run_in_docker.py

@@ -0,0 +1,36 @@
+import os
+
+import uvicorn
+
+from retk.run import _plugins_start_on_schedule
+
+
+def main():
+    os.environ["VUE_APP_API_URL"] = os.environ.get("API_URL")
+    os.environ["VUE_APP_MODE"] = "local"
+
+    os.environ["RETHINK_DEFAULT_LANGUAGE"] = os.environ.get("APP_LANGUAGE")
+    os.environ["RETHINK_LOCAL_STORAGE_PATH"] = os.getcwd()
+    os.environ["RETHINK_SERVER_HEADLESS"] = "0"
+    os.environ["RETHINK_SERVER_DEBUG"] = "true"
+
+    pw = os.environ.get("APP_PASSWORD", "")
+    if pw != "":
+        if len(pw) < 6 or len(pw) > 20:
+            raise ValueError("Password length should be between 6 and 20 characters!")
+        os.environ["RETHINK_SERVER_PASSWORD"] = pw
+
+    _plugins_start_on_schedule()
+    uvicorn.run(
+        "retk.application:app",
+        host="0.0.0.0",
+        port=8080,
+        reload=False,
+        workers=1,
+        log_level="error",
+        env_file=os.path.join(os.path.abspath(os.path.dirname(__file__)), "src", "retk", ".env.local"),
+    )
+
+
+if __name__ == "__main__":
+    main()

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = retk
-version = 0.2.8
+version = 0.2.9
 author = MorvanZhou
 author_email = [email protected]
 description = keep and reuse your thoughts
@@ -39,8 +39,6 @@ install_requires =
     httpx>=0.25.0
     captcha>=0.5.0
     python-multipart>=0.0.6
-    cos-python-sdk-v5~=1.9.26
-    numpy>=1.24.4
     whoosh~=2.7.4
     jieba>=0.42.1
     starlette>=0.27.0
@@ -66,3 +64,4 @@ build =
 remote =
     motor>=3.3.2
     elasticsearch[async]~=8.11.0
+    cos-python-sdk-v5~=1.9.26

src/retk/application.py

@@ -40,10 +40,9 @@ async def lifespan(app: FastAPI):
         )
     logger.debug(f'startup_event RETHINK_LOCAL_STORAGE_PATH: {os.environ.get("RETHINK_LOCAL_STORAGE_PATH")}')
     logger.debug(f'startup_event VUE_APP_MODE: {os.environ.get("VUE_APP_MODE")}')
-    logger.debug(f'startup_event VUE_APP_API_PORT: {os.environ.get("VUE_APP_API_PORT")}')
+    logger.debug(f'startup_event VUE_APP_API_URL: {os.environ.get("VUE_APP_API_URL")}')
     logger.debug(f'startup_event RETHINK_DEFAULT_LANGUAGE: {os.environ.get("RETHINK_DEFAULT_LANGUAGE")}')
     await client.init()
-    logger.debug("db initialized")
 
     # schedule job
     scheduler.start()

src/retk/core/files/saver.py

@@ -5,7 +5,11 @@
 
 from PIL import Image, UnidentifiedImageError
 from bson import ObjectId
-from qcloud_cos import CosConfig, CosServiceError, CosS3Client
+
+try:
+    from qcloud_cos import CosConfig, CosServiceError, CosS3Client
+except ImportError:
+    pass
 
 from retk.config import get_settings, is_local_db
 from retk.const.app import FileTypesEnum

src/retk/core/node/backup.py

@@ -5,7 +5,11 @@
 
 from bson.tz_util import utc
 from pydantic_settings import BaseSettings
-from qcloud_cos import CosConfig, CosServiceError, CosS3Client
+
+try:
+    from qcloud_cos import CosConfig, CosServiceError, CosS3Client
+except ImportError:
+    pass
 
 from retk import config, const
 from retk.logger import logger
@@ -200,7 +204,7 @@ def __cos_connect(
         nid: str,
         version: str,
         exist_ok: bool = False,
-) -> Tuple[CosS3Client, str, const.CodeEnum]:
+) -> Tuple["CosS3Client", str, const.CodeEnum]:
     cos_client, key = __get_client_and_key(settings, uid, nid, version)
 
     if not exist_ok:
@@ -217,7 +221,7 @@ def __cos_connect(
     return cos_client, key, const.CodeEnum.OK
 
 
-def __get_client_and_key(settings: BaseSettings, uid: str, nid: str, version: str = None) -> Tuple[CosS3Client, str]:
+def __get_client_and_key(settings: BaseSettings, uid: str, nid: str, version: str = None) -> Tuple["CosS3Client", str]:
     cos_client = CosS3Client(
         CosConfig(
             Region=settings.COS_REGION,