Skip to content

Conversation

@ldc861117
Copy link
Owner

  • Add .env.example template with comprehensive examples
  • Update .gitignore to exclude .env files from version control
  • Modify config.yaml to use environment variable substitution
  • Add python-dotenv dependency
  • Update CLI to automatically load .env files on startup
  • Enhance start-dev.sh to check for .env file presence
  • Create comprehensive ENV_CONFIGURATION.md documentation

Benefits:

  • Keep API keys and sensitive data secure (not in version control)
  • Easy to switch between configurations (Ollama, OpenAI, Doubao, etc.)
  • Follow 12-factor app best practices
  • Support fallback values for embedding config

Usage:

  1. cp .env.example .env
  2. Edit .env with your configuration
  3. ./start-dev.sh

Description

Please include a concise summary, in clear English, of the changes in this pull request. If it closes an issue, please
mention it here.

Closes: #(issue)

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue
for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

- Add .env.example template with comprehensive examples
- Update .gitignore to exclude .env files from version control
- Modify config.yaml to use environment variable substitution
- Add python-dotenv dependency
- Update CLI to automatically load .env files on startup
- Enhance start-dev.sh to check for .env file presence
- Create comprehensive ENV_CONFIGURATION.md documentation

Benefits:
- Keep API keys and sensitive data secure (not in version control)
- Easy to switch between configurations (Ollama, OpenAI, Doubao, etc.)
- Follow 12-factor app best practices
- Support fallback values for embedding config

Usage:
1. cp .env.example .env
2. Edit .env with your configuration
3. ./start-dev.sh
- Explain the difference between tracked and untracked config files
- Provide three setup options (.env, Ollama example, previous config)
- Document environment variable substitution syntax
- Include best practices for security and configuration management
- Add troubleshooting section for common issues
@ldc861117 ldc861117 merged commit 89ad70b into main Oct 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants