Sanitized mirror from private repository - 2026-03-20 09:03:20 UTC
This commit is contained in:
Gitea Mirror Bot
219
docs/services/individual/webserver.md
Normal file
219
docs/services/individual/webserver.md
Normal file
@@ -0,0 +1,219 @@
|
||||
# Webserver
|
||||
|
||||
**🟡 Productivity Service**
|
||||
|
||||
## 📋 Service Overview
|
||||
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| **Service Name** | webserver |
|
||||
| **Host** | Atlantis |
|
||||
| **Category** | Productivity |
|
||||
| **Difficulty** | 🟡 |
|
||||
| **Docker Image** | `ghcr.io/paperless-ngx/paperless-ngx` |
|
||||
| **Compose File** | `Atlantis/paperlessngx.yml` |
|
||||
| **Directory** | `Atlantis` |
|
||||
|
||||
## 🎯 Purpose
|
||||
|
||||
webserver is a productivity application that helps manage tasks, documents, or workflows.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
- Docker and Docker Compose installed
|
||||
- Basic understanding of REDACTED_APP_PASSWORD
|
||||
- Access to the host system (Atlantis)
|
||||
|
||||
### Deployment
|
||||
```bash
|
||||
# Navigate to service directory
|
||||
cd Atlantis
|
||||
|
||||
# Start the service
|
||||
docker-compose up -d
|
||||
|
||||
# Check service status
|
||||
docker-compose ps
|
||||
|
||||
# View logs
|
||||
docker-compose logs -f webserver
|
||||
```
|
||||
|
||||
## 🔧 Configuration
|
||||
|
||||
### Docker Compose Configuration
|
||||
```yaml
|
||||
container_name: PaperlessNGX
|
||||
depends_on:
|
||||
- db
|
||||
- redis
|
||||
- gotenberg
|
||||
- tika
|
||||
environment:
|
||||
PAPERLESS_ADMIN_PASSWORD: "REDACTED_PASSWORD"
|
||||
PAPERLESS_ADMIN_USER: vish
|
||||
PAPERLESS_DBHOST: db
|
||||
PAPERLESS_LOCALE: en_US
|
||||
PAPERLESS_OCR_LANGUAGE: deu+eng
|
||||
PAPERLESS_REDIS: redis://redis:6379
|
||||
PAPERLESS_TIKA_ENABLED: 1
|
||||
PAPERLESS_TIKA_ENDPOINT: http://tika:9998
|
||||
PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000/forms/libreoffice/convert#
|
||||
PAPERLESS_TIME_ZONE: America/Los_Angeles
|
||||
USERMAP_GID: 100
|
||||
USERMAP_UID: 1026
|
||||
image: ghcr.io/paperless-ngx/paperless-ngx
|
||||
ports:
|
||||
- 8777:8000
|
||||
restart: always
|
||||
volumes:
|
||||
- /volume1/docker/paperlessngx/data:/usr/src/paperless/data
|
||||
- /volume1/docker/paperlessngx/media:/usr/src/paperless/media
|
||||
- /volume1/docker/paperlessngx/export:/usr/src/paperless/export
|
||||
- /volume1/docker/paperlessngx/consume:/usr/src/paperless/consume
|
||||
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
| Variable | Value | Description |
|
||||
|----------|-------|-------------|
|
||||
| `PAPERLESS_REDIS` | `redis://redis:6379` | Configuration variable |
|
||||
| `PAPERLESS_DBHOST` | `db` | Configuration variable |
|
||||
| `USERMAP_UID` | `1026` | Configuration variable |
|
||||
| `USERMAP_GID` | `100` | Configuration variable |
|
||||
| `PAPERLESS_TIME_ZONE` | `America/Los_Angeles` | Configuration variable |
|
||||
| `PAPERLESS_ADMIN_USER` | `vish` | Configuration variable |
|
||||
| `PAPERLESS_ADMIN_PASSWORD` | `***MASKED***` | Administrator password |
|
||||
| `PAPERLESS_OCR_LANGUAGE` | `deu+eng` | Configuration variable |
|
||||
| `PAPERLESS_TIKA_ENABLED` | `1` | Configuration variable |
|
||||
| `PAPERLESS_TIKA_GOTENBERG_ENDPOINT` | `http://gotenberg:3000/forms/libreoffice/convert#` | Configuration variable |
|
||||
| `PAPERLESS_TIKA_ENDPOINT` | `http://tika:9998` | Configuration variable |
|
||||
| `PAPERLESS_LOCALE` | `en_US` | Configuration variable |
|
||||
|
||||
|
||||
### Port Mappings
|
||||
| Host Port | Container Port | Protocol | Purpose |
|
||||
|-----------|----------------|----------|----------|
|
||||
| 8777 | 8000 | TCP | Service port |
|
||||
|
||||
|
||||
### Volume Mappings
|
||||
| Host Path | Container Path | Type | Purpose |
|
||||
|-----------|----------------|------|----------|
|
||||
| `/volume1/docker/paperlessngx/data` | `/usr/src/paperless/data` | bind | Application data |
|
||||
| `/volume1/docker/paperlessngx/media` | `/usr/src/paperless/media` | bind | Media files |
|
||||
| `/volume1/docker/paperlessngx/export` | `/usr/src/paperless/export` | bind | Data storage |
|
||||
| `/volume1/docker/paperlessngx/consume` | `/usr/src/paperless/consume` | bind | Data storage |
|
||||
|
||||
|
||||
## 🌐 Access Information
|
||||
|
||||
### Web Interface
|
||||
- **HTTP**: `http://Atlantis:8777`
|
||||
|
||||
### Default Credentials
|
||||
Refer to service documentation for default credentials
|
||||
|
||||
## 🔒 Security Considerations
|
||||
|
||||
- ⚠️ Consider adding security options (no-new-privileges)
|
||||
- ⚠️ 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 webserver
|
||||
|
||||
# Restart service
|
||||
docker-compose restart webserver
|
||||
|
||||
# Update service
|
||||
docker-compose pull webserver
|
||||
docker-compose up -d webserver
|
||||
|
||||
# Access service shell
|
||||
docker-compose exec webserver /bin/bash
|
||||
# or
|
||||
docker-compose exec webserver /bin/sh
|
||||
```
|
||||
|
||||
## 📚 Additional Resources
|
||||
|
||||
- **Official Documentation**: Check the official docs for webserver
|
||||
- **Docker Hub**: [ghcr.io/paperless-ngx/paperless-ngx](https://hub.docker.com/r/ghcr.io/paperless-ngx/paperless-ngx)
|
||||
- **Community Forums**: Search for community discussions and solutions
|
||||
- **GitHub Issues**: Check the project's GitHub for known issues
|
||||
|
||||
## 🔗 Related Services
|
||||
|
||||
Services REDACTED_APP_PASSWORD webserver:
|
||||
- Nextcloud
|
||||
- Paperless-NGX
|
||||
- BookStack
|
||||
- Syncthing
|
||||
|
||||
---
|
||||
|
||||
*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**: `Atlantis/paperlessngx.yml`
|
||||
Reference in New Issue
Block a user