docs: add READMEs and wiki documentation for all directories

- 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>
This commit is contained in:
WickedYodaandJarvis authored and GitHub committed 2026-09-04 12:31:11 -05:00
1 parent b40aaf6f0e
commit 0c62f7495a
42 files changed
+4501 -865

No files matched your search

+53 -34
View File
@@ -1,40 +1,59 @@
# paperless-ngx
<<<<<<< HEAD
## Purpose
This directory contains files related to **paperless ngx**.
## Contents
- `paperless-ngx-install.sh`
## Usage
- Review each script or configuration file before running
- Some scripts may require **root or sudo**
- Paths and variables may need adjustment for your environment
## Notes
- This folder is part of the **public-setupfiles** repository
- Files are provided as-is for reference or automation
## Safety
Always back up data before running scripts that modify system state.
=======
## Overview
This directory is part of the **public-setupfiles** repository.
It contains scripts, configuration files, or resources related to **paperless-ngx**.
## Usage
- Review scripts before execution
- Some files may require **root or sudo privileges**
- Paths, variables, or credentials may need customization
## Logging & Output
Scripts may generate logs or output files in the same directory or system locations.
## Safety Notes
- Always back up important data before running scripts
- Test in a non-production environment when possible
- Use at your own risk
Script for installing Paperless-ngx document management system.
---
>>>>>>> main
## 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