Skip to content

Commit ee12a66

Browse files
LucienShuiLucienShui
authored
Merge pull request #79 from import-ai/chore/docs
Chore/docs
2 parents e001abd + 87174e0 commit ee12a66

File tree

9 files changed

+82
-269
lines changed

9 files changed

+82
-269
lines changed

‎README.md‎

Lines changed: 4 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
English | [简体中文](./README_zh.md)
99

10+
<img width="923" height="620" alt="Image" src="https://github.com/user-attachments/assets/35dad1b4-5652-4f2f-8eac-38c49da0545f" />
11+
1012
## Docs
1113

1214
[OmniBox Docs](https://www.omnibox.pro/docs/?utm_source=gh_readme_en)
@@ -26,91 +28,17 @@ OmniBox (小黑) is a simple, cross-platform, all-in-one AI knowledge hub. All y
2628
7. **WeChat Bot**: Save files, webpages, videos, voice messages, text, and chat records to OmniBox anytime, anywhere via WeChat.
2729
8. User and team system, permissions, sharing management, multi-tenancy, multi-language, dark mode, mobile responsiveness, and more.
2830

29-
### Screenshots
30-
31-
<details>
32-
<table>
33-
<tr>
34-
<th>Feature</th>
35-
<th>Source</th>
36-
<th>Parsing Result</th>
37-
</tr>
38-
<tr>
39-
<td>Save Webpage to OmniBox</td>
40-
<td><img src="assets/screenshots/extension/SCR-20250727-uniy.png" alt="Source web"></td>
41-
<td><img src="assets/screenshots/extension/SCR-20250727-srzd.png" alt="Extension parsing result"></td>
42-
</tr>
43-
<tr>
44-
<td rowspan="2">File Parsing</td>
45-
<td><a href="assets/example.mp3">example.mp3</a></td>
46-
<td><img src="assets/screenshots/uploads/SCR-20250727-uakj.png"></td>
47-
</tr>
48-
<tr>
49-
<td><img src="assets/screenshots/uploads/SCR-20250727-ujjl.png"></td>
50-
<td><img src="assets/screenshots/uploads/SCR-20250727-uanf.png">
51-
<img src="assets/screenshots/uploads/SCR-20250727-uaoi.png"></td>
52-
</tr>
53-
</table>
54-
55-
<table>
56-
<tr>
57-
<th>Feature</th>
58-
<th>Screenshot</th>
59-
</tr>
60-
<tr>
61-
<td>Q&A</td>
62-
<td><img src="assets/screenshots/chat/SCR-20250727-uder.png"></td>
63-
</tr>
64-
<tr>
65-
<td>Writing</td>
66-
<td><img src="assets/screenshots/chat/SCR-20250727-udta.png">
67-
<img src="assets/screenshots/chat/SCR-20250727-uegk.png"></td>
68-
</tr>
69-
<tr>
70-
<td>Markdown</td>
71-
<td><img src="assets/screenshots/markdown/SCR-20250727-ssnr.png">
72-
<img src="assets/screenshots/markdown/SCR-20250727-ssou.png">
73-
<img src="assets/screenshots/markdown/SCR-20250727-sspn.png">
74-
<img src="assets/screenshots/markdown/SCR-20250727-ssqi.png"></td>
75-
</tr>
76-
</table>
77-
78-
<table>
79-
<tr>
80-
<th>Feature</th>
81-
<th>Demo Video</th>
82-
</tr>
83-
<tr>
84-
<td>Flash - Voice Recording</td>
85-
<td><video src="https://github.com/user-attachments/assets/7d7c1089-5f7d-4575-b3cc-a2ee5effb3db" width="300"></video></td>
86-
</tr>
87-
<tr>
88-
<td>Flash - Text Note</td>
89-
<td><video src="https://github.com/user-attachments/assets/b31c6bbd-78b3-4808-8370-a93e16ff6ddd" width="300"></video></td>
90-
</tr>
91-
<tr>
92-
<td>Share Files to OmniBox</td>
93-
<td><video src="https://github.com/user-attachments/assets/0000f920-4028-4d3d-8024-e4fbfb78a77f" width="300"></video></td>
94-
</tr>
95-
</table>
96-
</details>
97-
9831
## Quick Start
9932

10033
Welcome to our online service: [omnibox.pro](https://www.omnibox.pro/?utm_source=gh_readme_en), supporting login via Email, Google and WeChat.
10134

10235
### Browser Extension
10336

104-
[Browser Extension Installation | OmniBox Docs](https://www.omnibox.pro/docs/collect/browser-extension)
37+
[Browser Extension Installation | OmniBox Docs](https://www.omnibox.pro/docs/browser-extension?utm_source=gh_readme_en)
10538

10639
### Deployment
10740

108-
```shell
109-
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/import-ai/omnibox.git
110-
cd omnibox
111-
cp example.env .env
112-
bash scripts/compose.sh up -d
113-
```
41+
[Local Deployment](https://www.omnibox.pro/docs/deploy?utm_source=gh_readme_en)
11442

11543
### Local Development
11644

@@ -132,4 +60,3 @@ bash scripts/dev.sh up -d --build
13260
## Star History
13361

13462
[![Star History Chart](https://api.star-history.com/svg?repos=import-ai/omnibox&type=date&legend=top-left)](https://www.star-history.com/#import-ai/omnibox&type=date&legend=top-left)
135-

‎README_zh.md‎

Lines changed: 4 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
[English](./README.md) | 简体中文
99

10+
<img width="923" height="620" alt="Image" src="https://github.com/user-attachments/assets/35dad1b4-5652-4f2f-8eac-38c49da0545f" />
11+
1012
## 文档
1113

1214
[小黑帮助文档](https://www.omnibox.pro/docs/zh-cn/?utm_source=gh_readme_zh)
@@ -28,91 +30,17 @@
2830
7. **微信助手**：在微信中随时随地将文件、网页、视频、语音、文字、聊天记录保存至小黑
2931
8. 用户、团队系统、权限、分享管理、多租户、多语言、暗色模式、移动端自适应等
3032

31-
### 截图
32-
33-
<details>
34-
<table>
35-
<tr>
36-
<th>功能</th>
37-
<th>源</th>
38-
<th>解析结果</th>
39-
</tr>
40-
<tr>
41-
<td>收藏网页</td>
42-
<td><img src="assets/screenshots/extension/SCR-20250727-uniy.png" alt="Source web"></td>
43-
<td><img src="assets/screenshots/extension/SCR-20250727-srzd.png" alt="Extension parsing result"></td>
44-
</tr>
45-
<tr>
46-
<td rowspan="2">文件解析</td>
47-
<td><a href="assets/example.mp3">example.mp3</a></td>
48-
<td><img src="assets/screenshots/uploads/SCR-20250727-uakj.png"></td>
49-
</tr>
50-
<tr>
51-
<td><img src="assets/screenshots/uploads/SCR-20250727-ujjl.png"></td>
52-
<td><img src="assets/screenshots/uploads/SCR-20250727-uanf.png">
53-
<img src="assets/screenshots/uploads/SCR-20250727-uaoi.png"></td>
54-
</tr>
55-
</table>
56-
57-
<table>
58-
<tr>
59-
<th>功能</th>
60-
<th>截图</th>
61-
</tr>
62-
<tr>
63-
<td>问答</td>
64-
<td><img src="assets/screenshots/chat/SCR-20250727-uder.png"></td>
65-
</tr>
66-
<tr>
67-
<td>写作</td>
68-
<td><img src="assets/screenshots/chat/SCR-20250727-udta.png">
69-
<img src="assets/screenshots/chat/SCR-20250727-uegk.png"></td>
70-
</tr>
71-
<tr>
72-
<td>Markdown</td>
73-
<td><img src="assets/screenshots/markdown/SCR-20250727-ssnr.png">
74-
<img src="assets/screenshots/markdown/SCR-20250727-ssou.png">
75-
<img src="assets/screenshots/markdown/SCR-20250727-sspn.png">
76-
<img src="assets/screenshots/markdown/SCR-20250727-ssqi.png"></td>
77-
</tr>
78-
</table>
79-
80-
<table>
81-
<tr>
82-
<th>功能</th>
83-
<th>演示视频</th>
84-
</tr>
85-
<tr>
86-
<td>闪记 - 语音录制</td>
87-
<td><video src="https://github.com/user-attachments/assets/7d7c1089-5f7d-4575-b3cc-a2ee5effb3db" width="300"></video></td>
88-
</tr>
89-
<tr>
90-
<td>闪记 - 文字笔记</td>
91-
<td><video src="https://github.com/user-attachments/assets/b31c6bbd-78b3-4808-8370-a93e16ff6ddd" width="300"></video></td>
92-
</tr>
93-
<tr>
94-
<td>分享文件至小黑</td>
95-
<td><video src="https://github.com/user-attachments/assets/0000f920-4028-4d3d-8024-e4fbfb78a77f" width="300"></video></td>
96-
</tr>
97-
</table>
98-
</details>
99-
10033
## 快速开始
10134

10235
欢迎使用我们的在线服务：[omnibox.pro](https://www.omnibox.pro/?utm_source=gh_readme_zh)，支持邮箱注册以及谷歌、微信登录。
10336

10437
### 浏览器插件
10538

106-
[浏览器插件安装 | 小黑帮助文档](https://www.omnibox.pro/docs/zh-cn/collect/browser-extension)
39+
[浏览器插件安装 | 小黑帮助文档](https://www.omnibox.pro/docs/zh-cn/browser-extension?utm_source=gh_readme_zh)
10740

10841
### 部署
10942

110-
```shell
111-
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/import-ai/omnibox.git
112-
cd omnibox
113-
cp example.env .env
114-
bash scripts/compose.sh up -d
115-
```
43+
[本地部署](https://www.omnibox.pro/docs/zh-cn/deploy?utm_source=gh_readme_zh)
11644

11745
### 本地开发
11846

@@ -134,4 +62,3 @@ bash scripts/dev.sh up -d --build
13462
## Star History
13563

13664
[![Star History Chart](https://api.star-history.com/svg?repos=import-ai/omnibox&type=date&legend=top-left)](https://www.star-history.com/#import-ai/omnibox&type=date&legend=top-left)
137-

‎backend‎

Submodule backend updated 46 files

‎compose.yaml‎

Lines changed: 14 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: omnibox
22

33
services:
44
web:
5-
image: ghcr.io/import-ai/omnibox-web:0.1.4
5+
image: ghcr.io/import-ai/omnibox-web:0.1.10
66
volumes:
77
- '/etc/localtime:/etc/localtime:ro'
88
ports:
@@ -13,39 +13,14 @@ services:
1313
condition: service_healthy
1414

1515
backend:
16-
image: ghcr.io/import-ai/omnibox-backend:0.1.4
16+
image: ghcr.io/import-ai/omnibox-backend:0.1.10
1717
restart: always
1818
volumes:
1919
- '/etc/localtime:/etc/localtime:ro'
2020
environment:
21-
OBB_LOG_LEVELS: ${OBB_LOG_LEVELS:-error,warn,log}
2221
ENV: prod
23-
OTEL_EXPORTER_OTLP_ENDPOINT: ${OTEL_EXPORTER_OTLP_ENDPOINT}
24-
25-
OBB_WIZARD_BASE_URL: ${OBB_WIZARD_BASE_URL:-http://wizard:8000}
26-
27-
OBB_POSTGRES_URL: ${OBB_POSTGRES_URL:-postgres://omnibox:omnibox@postgres:5432/omnibox}
28-
OBB_MINIO_URL: ${OBB_MINIO_URL:-http://username:password@minio:9000/omnibox}
29-
30-
OBB_KAFKA_BROKER: ${OBB_KAFKA_BROKER}
31-
OBB_KAFKA_TOPIC: ${OBB_KAFKA_TOPIC}
32-
OBB_KAFKA_CLIENT_ID: ${OBB_KAFKA_CLIENT_ID}
33-
34-
OBB_JWT_SECRET: ${OBB_JWT_SECRET}
35-
OBB_JWT_EXPIRE: ${OBB_JWT_EXPIRE:-2678400s}
36-
37-
OBB_MAIL_TRANSPORT: ${OBB_MAIL_TRANSPORT}
38-
OBB_MAIL_FROM: ${OBB_MAIL_FROM}
39-
40-
OBB_WECHAT_APP_ID: ${OBB_WECHAT_APP_ID}
41-
OBB_WECHAT_APP_SECRET: ${OBB_WECHAT_APP_SECRET}
42-
OBB_OPEN_WECHAT_APP_ID: ${OBB_OPEN_WECHAT_APP_ID}
43-
OBB_OPEN_WECHAT_APP_SECRET: ${OBB_OPEN_WECHAT_APP_SECRET}
44-
OBB_WECHAT_REDIRECT_URI: ${OBB_WECHAT_REDIRECT_URI}
45-
46-
OBB_GOOGLE_CLIENT_ID: ${OBB_GOOGLE_CLIENT_ID}
47-
OBB_GOOGLE_CLIENT_SECRET: ${OBB_GOOGLE_CLIENT_SECRET}
48-
OBB_GOOGLE_REDIRECT_URI: ${OBB_GOOGLE_REDIRECT_URI}
22+
env_file:
23+
- .env
4924
healthcheck:
5025
test: ['CMD', 'wget', '-q', '-O-', 'http://127.0.0.1:8000/api/v1/health']
5126
interval: 30s
@@ -57,37 +32,16 @@ services:
5732
condition: service_healthy
5833

5934
wizard:
60-
image: ghcr.io/import-ai/omnibox-wizard:0.1.4
35+
image: ghcr.io/import-ai/omnibox-wizard:0.1.9
6136
restart: always
6237
volumes:
6338
- '/etc/localtime:/etc/localtime:ro'
6439
environment:
6540
ENV: prod
66-
OTEL_EXPORTER_OTLP_ENDPOINT: ${OTEL_EXPORTER_OTLP_ENDPOINT}
67-
68-
OBW_VECTOR_HOST: ${OBW_MEILI_HOST:-http://meilisearch:7700}
69-
OBW_VECTOR_MEILI_API_KEY: ${GLOBAL_MEILI_KEY:-meili_master_key}
70-
OBW_BACKEND_BASE_URL: 'http://backend:8000'
71-
72-
OBW_VECTOR_EMBEDDING_API_KEY: ${OBW_VECTOR_EMBEDDING_API_KEY}
73-
OBW_VECTOR_EMBEDDING_BASE_URL: ${OBW_VECTOR_EMBEDDING_BASE_URL}
74-
OBW_VECTOR_EMBEDDING_MODEL: ${OBW_VECTOR_EMBEDDING_MODEL}
75-
76-
OBW_GRIMOIRE_OPENAI_DEFAULT_API_KEY: ${OBW_GRIMOIRE_OPENAI_DEFAULT_API_KEY}
77-
OBW_GRIMOIRE_OPENAI_DEFAULT_BASE_URL: ${OBW_GRIMOIRE_OPENAI_DEFAULT_BASE_URL}
78-
OBW_GRIMOIRE_OPENAI_DEFAULT_MODEL: ${OBW_GRIMOIRE_OPENAI_DEFAULT_MODEL}
79-
OBW_GRIMOIRE_OPENAI_MINI_MODEL: ${OBW_GRIMOIRE_OPENAI_MINI_MODEL}
80-
OBW_GRIMOIRE_OPENAI_LARGE_MODEL: ${OBW_GRIMOIRE_OPENAI_LARGE_MODEL}
81-
OBW_GRIMOIRE_OPENAI_LARGE_THINKING_MODEL: ${OBW_GRIMOIRE_OPENAI_LARGE_THINKING_MODEL}
82-
83-
OBW_TOOLS_SEARXNG_BASE_URL: ${OBW_TOOLS_SEARXNG_BASE_URL}
84-
OBW_TOOLS_SEARXNG_ENGINES: ${OBW_TOOLS_SEARXNG_ENGINES}
85-
86-
OBW_TOOLS_RERANKER_OPENAI_API_KEY: ${OBW_TOOLS_RERANKER_OPENAI_API_KEY}
87-
OBW_TOOLS_RERANKER_OPENAI_MODEL: ${OBW_TOOLS_RERANKER_OPENAI_MODEL}
88-
OBW_TOOLS_RERANKER_OPENAI_BASE_URL: ${OBW_TOOLS_RERANKER_OPENAI_BASE_URL}
89-
OBW_TOOLS_RERANKER_THRESHOLD: ${OBW_TOOLS_RERANKER_THRESHOLD}
90-
OBW_TOOLS_RERANKER_K: ${OBW_TOOLS_RERANKER_K}
41+
OBW_VECTOR_HOST: ${OBW_MEILI_HOST}
42+
OBW_VECTOR_MEILI_API_KEY: ${GLOBAL_MEILI_KEY}
43+
env_file:
44+
- .env
9145
healthcheck:
9246
test: ['CMD', 'wget', '-q', '-O-', 'http://127.0.0.1:8000/api/v1/health']
9347
interval: 30s
@@ -96,34 +50,14 @@ services:
9650
start_period: 5s
9751

9852
wizard-worker:
99-
image: ghcr.io/import-ai/omnibox-wizard:0.1.4
53+
image: ghcr.io/import-ai/omnibox-wizard:0.1.9
10054
restart: always
10155
environment:
10256
ENV: prod
103-
OTEL_EXPORTER_OTLP_ENDPOINT: ${OTEL_EXPORTER_OTLP_ENDPOINT}
104-
105-
OBW_VECTOR_HOST: ${OBW_MEILI_HOST:-http://meilisearch:7700}
106-
OBW_VECTOR_MEILI_API_KEY: ${GLOBAL_MEILI_KEY:-meili_master_key}
107-
OBW_BACKEND_BASE_URL: 'http://backend:8000'
108-
109-
OBW_VECTOR_EMBEDDING_API_KEY: ${OBW_VECTOR_EMBEDDING_API_KEY}
110-
OBW_VECTOR_EMBEDDING_BASE_URL: ${OBW_VECTOR_EMBEDDING_BASE_URL}
111-
OBW_VECTOR_EMBEDDING_MODEL: ${OBW_VECTOR_EMBEDDING_MODEL}
112-
113-
OBW_TASK_OFFICE_OPERATOR_BASE_URL: ${OBW_TASK_OFFICE_OPERATOR_BASE_URL}
114-
OBW_TASK_DOCLING_BASE_URL: ${OBW_TASK_DOCLING_BASE_URL}
115-
116-
OBW_TASK_ASR_API_KEY: ${OBW_TASK_ASR_API_KEY}
117-
OBW_TASK_ASR_BASE_URL: ${OBW_TASK_ASR_BASE_URL}
118-
OBW_TASK_ASR_MODEL: ${OBW_TASK_ASR_MODEL}
119-
OBW_TASK_PDF_READER_BASE_URL: ${OBW_TASK_PDF_READER_BASE_URL}
120-
121-
OBW_GRIMOIRE_OPENAI_DEFAULT_API_KEY: ${OBW_GRIMOIRE_OPENAI_DEFAULT_API_KEY}
122-
OBW_GRIMOIRE_OPENAI_DEFAULT_BASE_URL: ${OBW_GRIMOIRE_OPENAI_DEFAULT_BASE_URL}
123-
OBW_GRIMOIRE_OPENAI_DEFAULT_MODEL: ${OBW_GRIMOIRE_OPENAI_DEFAULT_MODEL}
124-
OBW_GRIMOIRE_OPENAI_MINI_MODEL: ${OBW_GRIMOIRE_OPENAI_MINI_MODEL}
125-
OBW_GRIMOIRE_OPENAI_LARGE_MODEL: ${OBW_GRIMOIRE_OPENAI_LARGE_MODEL}
126-
OBW_GRIMOIRE_OPENAI_LARGE_THINKING_MODEL: ${OBW_GRIMOIRE_OPENAI_LARGE_THINKING_MODEL}
57+
OBW_VECTOR_HOST: ${OBW_MEILI_HOST}
58+
OBW_VECTOR_MEILI_API_KEY: ${GLOBAL_MEILI_KEY}
59+
env_file:
60+
- .env
12761
volumes:
12862
- '/etc/localtime:/etc/localtime:ro'
12963
entrypoint: ['python', 'main.py']

‎compose/deps.yaml‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ services:
77
condition: service_healthy
88
minio:
99
condition: service_healthy
10+
mailhog:
11+
condition: service_healthy
1012

1113
wizard:
1214
depends_on:
@@ -40,8 +42,10 @@ services:
4042
restart: always
4143
command: 'server /data --console-address ":9001"'
4244
environment:
43-
MINIO_ROOT_USER: username
44-
MINIO_ROOT_PASSWORD: password
45+
MINIO_ROOT_USER: ${OBB_S3_ACCESS_KEY_ID}
46+
MINIO_ROOT_PASSWORD: ${OBB_S3_SECRET_ACCESS_KEY}
47+
ports:
48+
- "${MINIO_API_PORT:-9000}:9000"
4549
volumes:
4650
- "/etc/localtime:/etc/localtime:ro"
4751
- '${PWD}/data/minio:/data'
@@ -64,3 +68,17 @@ services:
6468
interval: 5s
6569
timeout: 3s
6670
retries: 5
71+
72+
mailhog:
73+
image: mailhog/mailhog:v1.0.1
74+
restart: always
75+
ports:
76+
- "${MAILHOG_WEB_PORT:-8025}:8025" # Web UI
77+
volumes:
78+
- /etc/localtime:/etc/localtime:ro
79+
healthcheck:
80+
test: ["CMD", "nc", "-z", "localhost", "8025"]
81+
interval: 10s
82+
timeout: 5s
83+
retries: 3
84+
start_period: 15s

0 commit comments

Comments
 (0)