Sanitized mirror from private repository - 2026-04-20 01:32:01 UTC
This commit is contained in:
Gitea Mirror Bot
241
docs/services/individual/resume.md
Normal file
241
docs/services/individual/resume.md
Normal file
@@ -0,0 +1,241 @@
|
||||
# Resume
|
||||
|
||||
**🟡 Other Service**
|
||||
|
||||
## 📋 Service Overview
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Service Name** | resume |
|
||||
| **Host** | Calypso |
|
||||
| **Category** | Other |
|
||||
| **Difficulty** | 🟡 |
|
||||
| **Docker Image** | `amruthpillai/reactive-resume:latest` |
|
||||
| **Compose File** | `Calypso/reactive_resume_v4/docker-compose.yml` |
|
||||
| **Directory** | `Calypso/reactive_resume_v4` |
|
||||
|
||||
## 🎯 Purpose
|
||||
|
||||
resume is a specialized service that provides specific functionality for the homelab infrastructure.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
- Docker and Docker Compose installed
|
||||
- Basic understanding of REDACTED_APP_PASSWORD
|
||||
- Access to the host system (Calypso)
|
||||
|
||||
### Deployment
|
||||
```bash
|
||||
# Navigate to service directory
|
||||
cd Calypso/reactive_resume_v4
|
||||
|
||||
# Start the service
|
||||
docker-compose up -d
|
||||
|
||||
# Check service status
|
||||
docker-compose ps
|
||||
|
||||
# View logs
|
||||
docker-compose logs -f resume
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Docker Compose Configuration
|
||||
```yaml
|
||||
container_name: Resume-ACCESS
|
||||
depends_on:
|
||||
chrome:
|
||||
condition: service_started
|
||||
db:
|
||||
condition: service_healthy
|
||||
minio:
|
||||
condition: service_healthy
|
||||
environment:
|
||||
ACCESS_TOKEN_SECRET: access_token_secret
|
||||
AI_API_KEY: ollama
|
||||
AI_BASE_URL: http://192.168.0.200:11434/
|
||||
AI_MODEL: neural-chat:7b
|
||||
AI_PROVIDER: openai
|
||||
CHROME_TOKEN: chrome_token
|
||||
CHROME_URL: ws://chrome:3000
|
||||
DATABASE_URL: postgresql://resumeuser:REDACTED_PASSWORD@resume-db:5432/resume
|
||||
DISABLE_EMAIL_AUTH: false
|
||||
DISABLE_SIGNUPS: false
|
||||
MAIL_FROM: noreply@localhost
|
||||
NODE_ENV: production
|
||||
OPENAI_API_KEY: ollama
|
||||
OPENAI_BASE_URL: http://192.168.0.200:11434/
|
||||
OPENAI_MODEL: neural-chat:7b
|
||||
PORT: 3000
|
||||
PUBLIC_URL: https://rxv4access.vishconcord.synology.me
|
||||
REFRESH_TOKEN_SECRET: refresh_token_secret
|
||||
SMTP_URL: smtp://your-email@example.com:app-password@smtp.example.com:587
|
||||
STORAGE_ACCESS_KEY: minioadmin
|
||||
STORAGE_BUCKET: default
|
||||
STORAGE_ENDPOINT: minio
|
||||
STORAGE_PORT: 9000
|
||||
STORAGE_REGION: us-east-1
|
||||
STORAGE_SECRET_KEY: miniopass
|
||||
STORAGE_URL: https://rxv4download.vishconcord.synology.me/default/
|
||||
STORAGE_USE_SSL: false
|
||||
VITE_DISABLE_SIGNUPS: false
|
||||
hostname: resume
|
||||
image: amruthpillai/reactive-resume:latest
|
||||
ports:
|
||||
- 9751:3000
|
||||
restart: on-failure:5
|
||||
security_opt:
|
||||
- no-new-privileges:true
|
||||
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
| Variable | Value | Description |
|
||||
|----------|-------|-------------|
|
||||
| `PORT` | `3000` | Configuration variable |
|
||||
| `NODE_ENV` | `production` | Configuration variable |
|
||||
| `ACCESS_TOKEN_SECRET` | `***MASKED***` | Configuration variable |
|
||||
| `REFRESH_TOKEN_SECRET` | `***MASKED***` | Configuration variable |
|
||||
| `PUBLIC_URL` | `https://rxv4access.vishconcord.synology.me` | Configuration variable |
|
||||
| `STORAGE_URL` | `https://rxv4download.vishconcord.synology.me/default/` | Configuration variable |
|
||||
| `CHROME_TOKEN` | `***MASKED***` | Configuration variable |
|
||||
| `CHROME_URL` | `ws://chrome:3000` | Configuration variable |
|
||||
| `DATABASE_URL` | `postgresql://resumeuser:REDACTED_PASSWORD@resume-db:5432/resume` | Database connection string |
|
||||
| `STORAGE_ENDPOINT` | `minio` | Configuration variable |
|
||||
| `STORAGE_PORT` | `9000` | Configuration variable |
|
||||
| `STORAGE_REGION` | `us-east-1` | Configuration variable |
|
||||
| `STORAGE_BUCKET` | `default` | Configuration variable |
|
||||
| `STORAGE_ACCESS_KEY` | `***MASKED***` | Configuration variable |
|
||||
| `STORAGE_SECRET_KEY` | `***MASKED***` | Application secret key |
|
||||
| `STORAGE_USE_SSL` | `False` | Configuration variable |
|
||||
| `DISABLE_SIGNUPS` | `False` | Configuration variable |
|
||||
| `MAIL_FROM` | `noreply@localhost` | Configuration variable |
|
||||
| `SMTP_URL` | `smtp://your-email@example.com:app-password@smtp.example.com:587` | Configuration variable |
|
||||
| `DISABLE_EMAIL_AUTH` | `False` | Configuration variable |
|
||||
| `VITE_DISABLE_SIGNUPS` | `False` | Configuration variable |
|
||||
| `OPENAI_API_KEY` | `***MASKED***` | Configuration variable |
|
||||
| `OPENAI_BASE_URL` | `http://192.168.0.200:11434/` | Base URL for the service |
|
||||
| `OPENAI_MODEL` | `neural-chat:7b` | Configuration variable |
|
||||
| `AI_PROVIDER` | `openai` | Configuration variable |
|
||||
| `AI_API_KEY` | `***MASKED***` | Configuration variable |
|
||||
| `AI_BASE_URL` | `http://192.168.0.200:11434/` | Base URL for the service |
|
||||
| `AI_MODEL` | `neural-chat:7b` | Configuration variable |
|
||||
|
||||
|
||||
### Port Mappings
|
||||
| Host Port | Container Port | Protocol | Purpose |
|
||||
|-----------|----------------|----------|----------|
|
||||
| 9751 | 3000 | TCP | Web interface |
|
||||
|
||||
|
||||
### Volume Mappings
|
||||
No volumes mounted.
|
||||
|
||||
## 🌐 Access Information
|
||||
|
||||
### Web Interface
|
||||
- **HTTP**: `http://Calypso:9751`
|
||||
|
||||
### Default Credentials
|
||||
Refer to service documentation for default credentials
|
||||
|
||||
## 🔒 Security Considerations
|
||||
|
||||
- ✅ Security options configured
|
||||
- ⚠️ Consider running as non-root user
|
||||
|
||||
## 📊 Resource Requirements
|
||||
|
||||
No resource limits configured
|
||||
|
||||
### Recommended Resources
|
||||
- **Minimum RAM**: 512MB
|
||||
- **Recommended RAM**: 1GB+
|
||||
- **CPU**: 1 core minimum
|
||||
- **Storage**: Varies by usage
|
||||
|
||||
### Resource Monitoring
|
||||
Monitor resource usage with:
|
||||
```bash
|
||||
docker stats
|
||||
```
|
||||
|
||||
## 🔍 Health Monitoring
|
||||
|
||||
⚠️ No health check configured
|
||||
Consider adding a health check:
|
||||
```yaml
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:PORT/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
```
|
||||
|
||||
### Manual Health Checks
|
||||
```bash
|
||||
# Check container health
|
||||
docker inspect --format='{{.State.Health.Status}}' CONTAINER_NAME
|
||||
|
||||
# View health check logs
|
||||
docker inspect --format='{{range .State.Health.Log}}{{.Output}}{{end}}' CONTAINER_NAME
|
||||
```
|
||||
|
||||
## 🚨 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
**Service won't start**
|
||||
- Check Docker logs: `docker-compose logs service-name`
|
||||
- Verify port availability: `netstat -tulpn | grep PORT`
|
||||
- Check file permissions on mounted volumes
|
||||
|
||||
**Can't access web interface**
|
||||
- Verify service is running: `docker-compose ps`
|
||||
- Check firewall settings
|
||||
- Confirm correct port mapping
|
||||
|
||||
**Performance issues**
|
||||
- Monitor resource usage: `docker stats`
|
||||
- Check available disk space: `df -h`
|
||||
- Review service logs for errors
|
||||
|
||||
### Useful Commands
|
||||
```bash
|
||||
# Check service status
|
||||
docker-compose ps
|
||||
|
||||
# View real-time logs
|
||||
docker-compose logs -f resume
|
||||
|
||||
# Restart service
|
||||
docker-compose restart resume
|
||||
|
||||
# Update service
|
||||
docker-compose pull resume
|
||||
docker-compose up -d resume
|
||||
|
||||
# Access service shell
|
||||
docker-compose exec resume /bin/bash
|
||||
# or
|
||||
docker-compose exec resume /bin/sh
|
||||
```
|
||||
|
||||
## 📚 Additional Resources
|
||||
|
||||
- **Official Documentation**: Check the official docs for resume
|
||||
- **Docker Hub**: [amruthpillai/reactive-resume:latest](https://hub.docker.com/r/amruthpillai/reactive-resume:latest)
|
||||
- **Community Forums**: Search for community discussions and solutions
|
||||
- **GitHub Issues**: Check the project's GitHub for known issues
|
||||
|
||||
## 🔗 Related Services
|
||||
|
||||
Other services in the other category on Calypso
|
||||
|
||||
---
|
||||
|
||||
*This documentation is auto-generated from the Docker Compose configuration. For the most up-to-date information, refer to the official documentation and the actual compose file.*
|
||||
|
||||
**Last Updated**: 2025-11-17
|
||||
**Configuration Source**: `Calypso/reactive_resume_v4/docker-compose.yml`
|
||||
Reference in New Issue
Block a user