Added placeholder for documentation
This commit is contained in:
52
docs/getting-started/configuration.md
Normal file
52
docs/getting-started/configuration.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Configuration Guide
|
||||
|
||||
Environment configuration for the Letzshop Import API.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Create a `.env` file in your project root:
|
||||
|
||||
```env
|
||||
# Database Configuration
|
||||
DATABASE_URL=sqlite:///./ecommerce.db
|
||||
# For PostgreSQL: DATABASE_URL=postgresql://user:password@localhost:5432/ecommerce
|
||||
|
||||
# Security
|
||||
JWT_SECRET_KEY=your-super-secret-key-change-in-production
|
||||
JWT_EXPIRE_HOURS=24
|
||||
|
||||
# API Settings
|
||||
API_HOST=0.0.0.0
|
||||
API_PORT=8000
|
||||
DEBUG=True
|
||||
|
||||
# Rate Limiting
|
||||
RATE_LIMIT_ENABLED=True
|
||||
RATE_LIMIT_REQUESTS=100
|
||||
RATE_LIMIT_WINDOW=3600
|
||||
```
|
||||
|
||||
## Configuration Options
|
||||
|
||||
| Variable | Description | Default | Required |
|
||||
|----------|-------------|---------|----------|
|
||||
| `DATABASE_URL` | Database connection string | SQLite | Yes |
|
||||
| `JWT_SECRET_KEY` | JWT signing key | - | Yes |
|
||||
| `DEBUG` | Enable debug mode | False | No |
|
||||
|
||||
## Environment-Specific Setup
|
||||
|
||||
### Development
|
||||
```env
|
||||
DEBUG=True
|
||||
DATABASE_URL=sqlite:///./ecommerce.db
|
||||
```
|
||||
|
||||
### Production
|
||||
```env
|
||||
DEBUG=False
|
||||
DATABASE_URL=postgresql://user:password@host:5432/db
|
||||
JWT_SECRET_KEY=production-secret-key
|
||||
```
|
||||
|
||||
*This guide is under development. See [Installation](installation.md) for complete setup instructions.*
|
||||
Reference in New Issue
Block a user