docs(readme): add installation section and update documentation#135
Merged
docs(readme): add installation section and update documentation#135
Conversation
- Remove 15 unused config files (derisk-graphrag, derisk-local-*, derisk-proxy-*) - Keep derisk-docker.toml and configs/my for local debugging - Add new derisk-openai.toml based on dev-1.toml configuration
- Replace hardcoded API keys with environment variable placeholders - Replace hardcoded encrypt_key with environment variable placeholder - Keep configs/my unchanged as requested
- Remove RAG configuration (rag, rag.storage sections) - Remove models configuration (llms, embeddings, rerankers) - Align structure with derisk-proxy-aliyun.toml - Keep environment variable placeholders for security
…ceholders - Change API base URL from DashScope to OpenAI (https://api.openai.com/v1) - Update API key environment variable from DASHSCOPE_API_KEY_2 to OPENAI_API_KEY - Keep OSS placeholders consistent with aliyun config
- Remove unused deployment configs (docker, bun, homebrew) - Simplify OpenAI proxy config by removing RAG and models sections - Update API endpoints to use https://api.openai.com/v1 - Replace hardcoded secrets with environment variable placeholders - Align OpenAI config structure with Aliyun config for consistency BREAKING CHANGE: Removed docker-compose and deployment configs, moved to separate deployment repository
- Add Install (recommended) section to README.md, README.ja.md, and README.zh.md - Include curl installation method and configuration instructions - Update package READMEs with proper documentation - Synchronize all language versions of README files
github-actions
bot
added
the
documentation
yhjun1026
pushed a commit
that referenced
this pull request
Mar 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes