Skip to content

Commit

Permalink
Update docs to match recent changes
Browse files Browse the repository at this point in the history
  • Loading branch information
hv0905 committed May 20, 2024
1 parent 0b07ef8 commit c5bf1da
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
6 changes: 4 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Local file storage does not require an additional database deployment process, b

#### Deploy NekoImageGallery

1. Clone the project directory to your own PC or server.
1. Clone the project directory to your own PC or server, then checkout to a specific version tag (like `v1.0.0`).
2. It is highly recommended to install the dependencies required for this project in a Python venv virtual environment.
Run the following command:
```shell
Expand All @@ -80,7 +80,9 @@ Local file storage does not require an additional database deployment process, b
```
5. Modify the project configuration file inside `config/`, you can edit `default.env` directly, but it's recommended to
create a new file named `local.env` and override the configuration in `default.env`.
6. Initialize the Qdrant database by running the following command:
6. ~~Initialize the Qdrant database by running the following command:~~
Since NekoImageGallery will now automatically create the collection if not present, this steps is no longer required.
However, if you want to explicitly create the collection, you can still run the following command:
```shell
python main.py --init-database
```
Expand Down
4 changes: 2 additions & 2 deletions readme_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ NekoImageGallery支持两种元数据存储方式:Qdrant数据库存储与本

#### 部署NekoImageGallery

1. 将项目目录clone到你自己的PC或服务器中。
1. 将项目目录clone到你自己的PC或服务器中,然后按需checkout到特定版本tag(如`v1.0.0`
2. 强烈建议在python venv虚拟环境中安装本项目所需依赖, 运行下面命令:
```shell
python -m venv .venv
Expand All @@ -70,7 +70,7 @@ NekoImageGallery支持两种元数据存储方式:Qdrant数据库存储与本
```
5. 按需修改位于`config`目录下的配置文件,您可以直接修改`default.env`,但是建议创建一个名为`local.env`
的文件,覆盖`default.env`中的配置。
6. 初始化Qdrant数据库,运行下面命令:
6. ~~初始化Qdrant数据库,运行下面命令:~~ 由于NekoImageGallery会自动在第一次运行时初始化Qdrant数据库,因此此步骤可省略。但您仍可通过以下命令显式初始化Qdrant数据库
```shell
python main.py --init-database
```
Expand Down

0 comments on commit c5bf1da

Please sign in to comment.