mirror of
https://github.com/wickedyoda/public-setupfiles.git
synced 2026-11-16 13:31:56 -06:00
- Add comprehensive wiki documentation under .github/wiki/ (19 articles) - Add READMEs to directories that lacked them - Fix merge conflict markers in existing READMEs - Update root readme.md with improved structure Co-authored-by: Jarvis <jarvis@wickedyoda.local>
59 lines
879 B
Markdown
59 lines
879 B
Markdown
# paperless-ngx
|
|
|
|
## Overview
|
|
|
|
Script for installing Paperless-ngx document management system.
|
|
|
|
---
|
|
|
|
## Files
|
|
|
|
| File | Description |
|
|
|------|-------------|
|
|
| `paperless-ngx-install.sh` | Installation script |
|
|
|
|
---
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
sudo ./paperless-ngx/paperless-ngx-install.sh
|
|
```
|
|
|
|
---
|
|
|
|
## What It Does
|
|
|
|
The script automates the installation of:
|
|
- Docker
|
|
- Docker Compose
|
|
- Paperless-ngx container
|
|
- Required dependencies
|
|
|
|
---
|
|
|
|
## Post-Installation
|
|
|
|
After running the script:
|
|
1. Access Paperless-ngx web interface
|
|
2. Create admin account
|
|
3. Configure document sources
|
|
4. Start ingesting documents
|
|
|
|
---
|
|
|
|
## Requirements
|
|
|
|
- Debian/Ubuntu system
|
|
- Root/sudo access
|
|
- Minimum 2GB RAM recommended
|
|
- Storage for documents
|
|
|
|
---
|
|
|
|
## Configuration Notes
|
|
|
|
The script may set up:
|
|
- Docker volume for data persistence
|
|
- Port mapping (usually 8000)
|
|
- Environment variables for configuration |