feat(docs): update mkdocs references
This commit is contained in:
parent
6ee2dab80d
commit
08188ebb10
|
|
@ -8,10 +8,10 @@ This guide covers all configuration options available in Readur through environm
|
||||||
|
|
||||||
- [Environment Variables](#environment-variables)
|
- [Environment Variables](#environment-variables)
|
||||||
- [Core Configuration](#core-configuration)
|
- [Core Configuration](#core-configuration)
|
||||||
- [File Storage & Upload](#file-storage--upload)
|
- [File Storage & Upload](#file-storage-upload)
|
||||||
- [Watch Folder Configuration](#watch-folder-configuration)
|
- [Watch Folder Configuration](#watch-folder-configuration)
|
||||||
- [OCR & Processing Settings](#ocr--processing-settings)
|
- [OCR & Processing Settings](#ocr-processing-settings)
|
||||||
- [Search & Performance](#search--performance)
|
- [Search & Performance](#search-performance)
|
||||||
- [Data Management](#data-management)
|
- [Data Management](#data-management)
|
||||||
- [Port Configuration](#port-configuration)
|
- [Port Configuration](#port-configuration)
|
||||||
- [Example Configurations](#example-configurations)
|
- [Example Configurations](#example-configurations)
|
||||||
|
|
|
||||||
|
|
@ -427,7 +427,7 @@ docker run --read-only --tmpfs /tmp ...
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- Configure [monitoring and alerting](monitoring-usage)
|
- Configure [monitoring and alerting](health-monitoring-guide.md)
|
||||||
- Review [security best practices](security)
|
- Review [security best practices](security-guide.md)
|
||||||
- Set up [automated backups](#backup-strategy)
|
- Set up [automated backups](#backup-strategy)
|
||||||
- Explore [database guardrails](dev/DATABASE_GUARDRAILS.md)
|
- Explore [database guardrails](dev/DATABASE_GUARDRAILS.md)
|
||||||
|
|
@ -90,7 +90,7 @@ Start here if you need to:
|
||||||
1. [Set up sources](../sources-guide.md)
|
1. [Set up sources](../sources-guide.md)
|
||||||
2. [Configure watch folders](../WATCH_FOLDER.md)
|
2. [Configure watch folders](../WATCH_FOLDER.md)
|
||||||
3. [Use the API](../api-reference.md)
|
3. [Use the API](../api-reference.md)
|
||||||
4. [Automate workflows](../api-reference.md#automation-examples)
|
4. [Automate workflows](../api-reference.md#examples)
|
||||||
|
|
||||||
## Feature Highlights
|
## Feature Highlights
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -259,7 +259,7 @@ docker system prune -a
|
||||||
For production use:
|
For production use:
|
||||||
1. [Configure HTTPS](../self-hosting/reverse-proxy.md)
|
1. [Configure HTTPS](../self-hosting/reverse-proxy.md)
|
||||||
2. [Set up backups](../self-hosting/backup.md)
|
2. [Set up backups](../self-hosting/backup.md)
|
||||||
3. [Enable monitoring](../administration/monitoring.md)
|
3. [Enable monitoring](../health-monitoring-guide.md)
|
||||||
4. [Configure authentication](../self-hosting/authentication.md)
|
4. [Configure authentication](../self-hosting/authentication.md)
|
||||||
|
|
||||||
### Scaling
|
### Scaling
|
||||||
|
|
@ -272,6 +272,6 @@ Handle more documents:
|
||||||
## Related Documentation
|
## Related Documentation
|
||||||
|
|
||||||
- [Self-Hosting Guide](../self-hosting/index.md) - Complete deployment guide
|
- [Self-Hosting Guide](../self-hosting/index.md) - Complete deployment guide
|
||||||
- [Docker Compose Reference](../reference/docker-compose.md) - All configuration options
|
- [Configuration Reference](../configuration-reference.md) - All configuration options
|
||||||
- [Container Architecture](../architecture.md) - How services interact
|
- [Container Architecture](../architecture.md) - How services interact
|
||||||
- [Troubleshooting Guide](../troubleshooting.md) - Common issues and solutions
|
- [Troubleshooting Guide](../troubleshooting.md) - Common issues and solutions
|
||||||
|
|
@ -24,7 +24,7 @@ Direct installation on Linux servers:
|
||||||
- **From source**: Build and install manually
|
- **From source**: Build and install manually
|
||||||
- **SystemD services**: Managed by system init
|
- **SystemD services**: Managed by system init
|
||||||
|
|
||||||
[Bare Metal Installation →](./bare-metal.md)
|
[Bare Metal Installation →](../deployment.md)
|
||||||
|
|
||||||
### Cloud Platform Deployment
|
### Cloud Platform Deployment
|
||||||
|
|
||||||
|
|
@ -35,7 +35,7 @@ Deploy on managed cloud services:
|
||||||
- **Azure**: Virtual Machines, Database, Blob Storage
|
- **Azure**: Virtual Machines, Database, Blob Storage
|
||||||
- **DigitalOcean**: Droplets, Managed Database, Spaces
|
- **DigitalOcean**: Droplets, Managed Database, Spaces
|
||||||
|
|
||||||
[Cloud Deployment Guide →](./cloud-deployment.md)
|
[Cloud Deployment Guide →](../deployment.md)
|
||||||
|
|
||||||
## System Requirements
|
## System Requirements
|
||||||
|
|
||||||
|
|
@ -92,7 +92,7 @@ docker-compose ps
|
||||||
curl http://localhost:8000/health
|
curl http://localhost:8000/health
|
||||||
```
|
```
|
||||||
|
|
||||||
[Detailed Docker Guide →](./docker-setup.md)
|
[Detailed Docker Guide →](../quickstart/docker.md)
|
||||||
|
|
||||||
### Method 2: Kubernetes (Container Orchestration)
|
### Method 2: Kubernetes (Container Orchestration)
|
||||||
|
|
||||||
|
|
@ -121,7 +121,7 @@ spec:
|
||||||
- containerPort: 8000
|
- containerPort: 8000
|
||||||
```
|
```
|
||||||
|
|
||||||
[Kubernetes Deployment →](./kubernetes.md)
|
[Kubernetes Deployment →](../deployment.md#kubernetes)
|
||||||
|
|
||||||
### Method 3: Ansible Automation
|
### Method 3: Ansible Automation
|
||||||
|
|
||||||
|
|
@ -139,7 +139,7 @@ Automated deployment across multiple servers:
|
||||||
postgres_version: "14"
|
postgres_version: "14"
|
||||||
```
|
```
|
||||||
|
|
||||||
[Ansible Playbook →](./ansible.md)
|
[Ansible Playbook →](../deployment.md)
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
|
|
@ -163,7 +163,7 @@ S3_ACCESS_KEY_ID=<your-key>
|
||||||
S3_SECRET_ACCESS_KEY=<your-secret>
|
S3_SECRET_ACCESS_KEY=<your-secret>
|
||||||
```
|
```
|
||||||
|
|
||||||
[Complete Configuration Reference →](./configuration.md)
|
[Complete Configuration Reference →](../configuration-reference.md)
|
||||||
|
|
||||||
### Storage Configuration
|
### Storage Configuration
|
||||||
|
|
||||||
|
|
@ -306,7 +306,7 @@ docker-compose exec readur psql -U readur -d readur -c "SELECT COUNT(*) FROM doc
|
||||||
- [ ] Regular security updates
|
- [ ] Regular security updates
|
||||||
- [ ] Implement rate limiting
|
- [ ] Implement rate limiting
|
||||||
|
|
||||||
[Security Best Practices →](./security.md)
|
[Security Best Practices →](../security-guide.md)
|
||||||
|
|
||||||
### SSL/TLS Configuration
|
### SSL/TLS Configuration
|
||||||
|
|
||||||
|
|
@ -378,7 +378,7 @@ docker-compose exec readur alembic upgrade head
|
||||||
docker-compose down && docker-compose up -d
|
docker-compose down && docker-compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
[Update Procedures →](./updates.md)
|
[Update Procedures →](../migration-guide.md)
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
|
@ -415,7 +415,7 @@ psql $DATABASE_URL -c "SELECT 1"
|
||||||
telnet postgres_host 5432
|
telnet postgres_host 5432
|
||||||
```
|
```
|
||||||
|
|
||||||
[Complete Troubleshooting Guide →](./troubleshooting.md)
|
[Complete Troubleshooting Guide →](../troubleshooting.md)
|
||||||
|
|
||||||
## Migration from Other Systems
|
## Migration from Other Systems
|
||||||
|
|
||||||
|
|
@ -438,7 +438,7 @@ python migrate_mayan.py \
|
||||||
--target-db postgresql://readur_db
|
--target-db postgresql://readur_db
|
||||||
```
|
```
|
||||||
|
|
||||||
[Migration Guide →](./migration.md)
|
[Migration Guide →](../migration-guide.md)
|
||||||
|
|
||||||
## Support and Resources
|
## Support and Resources
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -427,7 +427,7 @@ Readur supports both local and OIDC users in the same installation:
|
||||||
- [🔌 API Reference](api-reference.md)
|
- [🔌 API Reference](api-reference.md)
|
||||||
REST API for automation and integration
|
REST API for automation and integration
|
||||||
|
|
||||||
- [🏗️ Developer Documentation](dev/)
|
- [🏗️ Developer Documentation](dev/README.md)
|
||||||
Architecture and development setup
|
Architecture and development setup
|
||||||
|
|
||||||
- [🔍 OCR Optimization](dev/OCR_OPTIMIZATION_GUIDE.md)
|
- [🔍 OCR Optimization](dev/OCR_OPTIMIZATION_GUIDE.md)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue