v0.0.1b2

Author: URenko

README.md

@@ -3,8 +3,6 @@
 
 English | [中文](https://github.com/comiclib/comiclib/blob/master/README.zh.md)
 
-💬 Join Discussion: [![Discord](https://img.shields.io/discord/1100655762411372604?logo=discord&style=flat-square)](https://discord.gg/UmjCbgGUFW)
-
 # ✨ Features
 - 📁 Support [multiple archive formats](https://comiclib.github.io/comiclib/en/supported-formats/)
 - 🏷️ Support tag and category metadata import and management
@@ -45,10 +43,6 @@ where `--host 0.0.0.0` specifies the bound IP (`0.0.0.0` enables LAN access), an
 
 📄 Please see the [documentation](https://ComicLib.github.io/comiclib/en/) for more settings.
 
-# ⚠️ Warning
-
-ComicLib is currently in an early development stage🚧, and many things may change as new features are added. Click *watch* in the upper right corner of GitHub or join our group to be notified of the first official release.
-
 # 👩‍💻 Contributing
 Contributions, issues and feature requests are very much welcome.
 Feel free to join the group for deeper communication.

README.zh.md

@@ -3,8 +3,6 @@
 
 中文 | [English](https://github.com/comiclib/comiclib/blob/master/README.md)
 
-💬 加入讨论: [![Discord](https://img.shields.io/discord/1100655762411372604?logo=discord&style=flat-square)](https://discord.gg/UmjCbgGUFW)
-
 # ✨ 特点
 - 📁 支持[多种存档格式](https://comiclib.github.io/comiclib/zh/supported-formats/)
 - 🏷️ 支持tag和分类元数据导入和管理
@@ -45,10 +43,6 @@ uvicorn comiclib.main:app --host 0.0.0.0 --port 80
 
 📄 更多设置请查看[文档](https://ComicLib.github.io/comiclib/zh/)。
 
-# ⚠️ 警告
-
-目前ComicLib正处在早期开发阶段🚧，随着新功能的加入，很多东西都可能变化。点击GitHub右上角的watch或者加入我们的群组以获取第一个正式版本的通知。
-
 # 👩‍💻 贡献
 我们非常欢迎贡献、问题和功能请求。
 欢迎加入群组以深度交流。

comiclib/LANraragi/public/js/index.js

@@ -411,7 +411,7 @@ Index.checkVersion = function () {
 
             if (latestVersion > currentVersion) {
                 LRR.toast({
-                    heading: `A new version of LANraragi (${data.tag_name}) is available !`,
+                    heading: `A new version of ComicLib (${data.tag_name}) is available !`,
                     text: `<a href="${data.html_url}">Click here to check it out.</a>`,
                     icon: "info",
                     closeOnClick: false,

comiclib/main.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.1b1"
+__version__ = "0.0.1b2"
 print(f" >>> ComicLib v{__version__}")
 
 from .scan import watch, scannow

comiclib/scanner/40-thumb.py

@@ -11,6 +11,6 @@ def scan(self, path: Path, id: str, metadata: dict, prev_scanners: list[str]) ->
         if not prev_scanners or not metadata.get('thumb') is None:
             return False
         logger.info(f' <- {path}')
-        thumb = extract_thumbnail(path, id, 1)
+        thumb = extract_thumbnail(path, id, 1, cover=True)
         metadata['thumb'] = str(thumb)
         return True

docs/en/docs/getting-started.md

@@ -113,6 +113,11 @@ For more settings, please refer to [Gunicorn's documentation](https://docs.gunic
 
 In the end your command might look like this (my personal use case):
 ``` bash
-CONTENT=../mycomics/ UA_convert_jxl= thumb=/tmp/thumb/ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
+CONTENT=../mycomics/ thumb=/tmp/thumb/ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
 ```
+or
+``` bash
+importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
+```
+for debugging.
 Then use Nginx to reverse proxy to HTTPS connection.

docs/en/docs/settings.md

@@ -29,12 +29,15 @@ The following is a list of available settings:
 | `debug` | Turn on debug output (`True`/`False`) | `False` |
 | `loglevel` | Log level (`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL`). If `debug` is `True`, it will be overwritten to `DEBUG` | `INFO` |
 | `content` | The path where the comic file is stored | `.` |
-| `thumb` | The path where the generated thumbnails are stored | `./thumb`|
+| `cover` | The path where the generated cover thumbnails are stored | `./thumb`|
+| `thumb` | The path where the generated page thumbnails are stored. If not provided (`None`), will be the same as `cover`. | `None`|
 | `metadata` | The URL for metadata database, refer to [SQLAlchemy documentation](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) | `sqlite:///./comiclib_metadata.db` |
-| `password` | Admin password (also used as API Key currently). If it is `None`, any visitor will have editing permissions. This feature is designed to protect against gentlemen but not villains. If you need security protection, please use e.g. the HTTP basic authentication of the reverse proxy, Cloudflare Access or TLS client certificate, etc. | `None`|
+| `password` | Admin password (also used as API Key currently) [^1]. If it is `None`, any visitor will have editing permissions. This feature is designed to protect against gentlemen but not villains. If you need security protection, please use e.g. the HTTP basic authentication of the reverse proxy, Cloudflare Access or TLS client certificate, etc. | `None`|
 | `skip_exists`| Skip comics that have been scanned into the metadata database during scanning? (`True`/`False`) | `True` |
 | `watch` | Monitor comic folders and automatically scan (`True`/`False`) | `True` |
 | `UA_convert_jxl` | For requests with matched user-agent, convert JPEG XL files to other popular formats on the server side. The value is a regular expression. | `Android` |
 | `UA_convert_all` | For requests with matched user-agent, convert all files to other popular formats on the server side. The value is a regular expression. | `\b\B` (will not match anything) |
 
-For the settings of the scanners, please refer to the respective instructions.
+In addition, there are settings for scanners, please refer to the respective instructions.
+
+[^1]: The security system may change in future versions, including the meaning of the environment variable `password`.

docs/en/mkdocs.yml

@@ -34,6 +34,7 @@ copyright: Copyright © 2023 ComicLib
 markdown_extensions:
   - tables
   - def_list
+  - footnotes
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span

docs/zh/docs/getting-started.md

@@ -113,6 +113,11 @@ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind 0
 
 最后你的命令可能会像这样（我的个人用例）：
 ``` bash
-CONTENT=../mycomics/ UA_convert_jxl= thumb=/tmp/thumb/ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
+CONTENT=../mycomics/ thumb=/tmp/thumb/ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
 ```
+或者
+``` bash
+importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
+```
+用于调试。
 然后通过 Nginx 反代为 HTTPS 连接。

docs/zh/docs/settings.md

@@ -29,12 +29,15 @@
 | `debug` | 开启调试输出（`True`/`False`） | `False` |
 | `loglevel` | 日志级别（`DEBUG`/`INFO`/`WARNING`/`ERROR`/`CRITICAL`），若`debug`为`True`，会被覆盖为`DEBUG` | `INFO` |
 | `content` | 漫画文件存放的路径 | `.` |
-| `thumb` | 生成的缩略图存放的路径 | `./thumb`|
+| `cover` | 生成的封面缩略图存放的路径。 | `./thumb`|
+| `thumb` | 生成的页面缩略图存放的路径。如果未提供 (`None`)，会和 `cover` 的值一样。| `None`|
 | `metadata` | 元数据库 URL，参考[SQLAlchemy 文档](https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls) | `sqlite:///./comiclib_metadata.db` |
-| `password` | 管理密码（目前也用作 API 密钥），若为`None`则任何访客皆可编辑。此功能防君子不防小人，若需安全保护请借助反向代理的 HTTP 基本验证、Cloudflare Access 或 TLS 客户端证书等。| `None`|
+| `password` | 管理密码（目前也用作 API 密钥）[^1]，若为`None`则任何访客皆可编辑。此功能防君子不防小人，若需安全保护请借助反向代理的 HTTP 基本验证、Cloudflare Access 或 TLS 客户端证书等。| `None`|
 | `skip_exists`| 扫描时是否跳过曾扫入元数据库的漫画？（`True`/`False`）| `True` |
 | `watch` | 监视漫画文件夹，自动扫描 （`True`/`False`）| `True` |
 | `UA_convert_jxl` | 对于哪些 user-agent 的请求在服务端将 JPEG XL 文件转为其他流行格式，该值是一个用于匹配的正则表达式 | `Android` |
 | `UA_convert_all` | 对于哪些 user-agent 的请求在服务端将所有文件转为其他流行格式，该值是一个用于匹配的正则表达式 | `\b\B`（不匹配任何东西）|
 
-对于扫描脚本的设置，请参看各自的说明。
+此外还有扫描脚本的设置，请参看各自的说明。
+
+[^1]: 安全系统可能在未来的版本变更，包括环境变量 `password` 的含义。