Docs: document all SMTP_* and other undocumented env vars for self-hosting
Maintainer thường phản hồi trong vòng 1 ngày
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 82/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách so sánh .env.example với các biến môi trường được đọc trong packages/backend/src/settings/email.service.ts, knowledge-graph/identifier.ts và những vị trí khác được nêu trong issue. Sau đó, đối chiếu docs/deployment.md với các cài đặt đó. Công việc hoàn tất khi các biến SMTP và năm biến khác chưa được tài liệu hóa được liệt kê cùng giá trị mặc định hoặc cách hoạt động trong .env.example, cả bảy biến SMTP được ghi lại trong hướng dẫn triển khai và nhận xét gây hiểu lầm được sửa.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Problem
When self-hosting, I couldn't find a complete list of environment variables:
.env.exampleL269 says the cloud jobs "mail through the SMTP_* settings above", but.env.exampledoesn't define anySMTP_*variables.packages/backend/src/settings/email.service.ts(L166–178) readsSMTP_HOST,SMTP_PORT(default 587),SMTP_USER,SMTP_PASS,SMTP_FROM,SMTP_SECUREandSMTP_REPLY_TO.docs/deployment.mdL427 lists only the first four.- These are read in code but not documented anywhere:
KG_HASH_SECRET(knowledge-graph/identifier.tsL122; falls back toENCRYPTION_KEY, thenJWT_SECRET, then a hardcoded 'anythingmcp-kg-dev-secret'),KG_MCP_TOOL(off disables it),KG_OBSERVE_COOLDOWN_SEC(default 45),SHUTDOWN_TIMEOUT_MS(default 20000),SENTRY_MCP_TRACES_SAMPLE_RATE(default: base rate / 5).
Proposed Solution
Add a commented SMTP block (plus the variables above) to .env.example, and list all seven SMTP variables in docs/deployment.md. I'm happy to send a PR.
Alternatives Considered
At minimum, reword the L269 comment so it doesn't refer to settings "above".
Area
Documentation
Additional Context
No response
- Ngôn ngữ chính
- TypeScript
- Star
- 856
- Fork
- 82
- Merge trung bình
- 6 giờ 15 phút
- Pull request đã merge (30 ngày)
- 141
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của HelpCode-ai/anythingmcp
-
good first issue hacktoberfest
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 70/100
HelpCode-ai/anythingmcp#996 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
good first issue hacktoberfest
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 72/100
HelpCode-ai/anythingmcp#995 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement good first issue hacktoberfest help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
HelpCode-ai/anythingmcp#982 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Upload the new social previewCó thể đã có người làm @helpcodeai đã nhận hôm nay. Đang mở
HelpCode-ai/anythingmcp#1087 · 2 bình luận · 1 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement hacktoberfest help wanted
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 50/100
HelpCode-ai/anythingmcp#1014 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của HelpCode-ai/anythingmcp
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
high priority
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
CI-CMG/deep-sea-corals-exb#84 · 1 bình luận ·
-
Create/import wallet form shows raw "password must be at least 1 characters" instead of the translated messageCó thể đã có người làm @CapThunder19 đã nhận hôm nay. Đang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
joinmarket-webui/jam#1538 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
t0ggles
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
nolimits4web/swiper#8240 · 1 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày