https://github.com/beuterei/paperless-ngx
Setup for paperless-ngx as document index/archive.
https://github.com/beuterei/paperless-ngx
docker docker-compose paperless-ngx
Last synced: 4 months ago
JSON representation
Setup for paperless-ngx as document index/archive.
- Host: GitHub
- URL: https://github.com/beuterei/paperless-ngx
- Owner: Beuterei
- License: other
- Created: 2025-11-23T20:56:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-11-23T21:51:31.000Z (7 months ago)
- Last Synced: 2025-11-23T23:27:13.288Z (7 months ago)
- Topics: docker, docker-compose, paperless-ngx
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
paperless-ngx
Docker setup for paperless-ngx
·
Report Bug
·
Request Feature
## About The Project
Small docker setup for paperless-ngx.
## Getting Started Develop
To get a local copy up and running follow these simple steps.
### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/Beuterei/paperless-ngx.git
```
2. Start docker-compose
```sh
docker-compose up --build
```
3. Set permissions for WebDAV
```sh
docker exec $(docker-compose ps -q webdav) chmod -R 777 /var/lib/dav
```
4. Navigate to `localhost:3500`
### Customization
1. Create a `.env` file
```sh
touch .env
```
2. Overwrite variables as you like (format: `{variable name}={variable value}`)
| Variable | Description | Default value | Required |
| --------------------------- | ------------------------------------ | ------------- | -------- |
| `POSTGRES_PASSWORD` | Password for the PostgreSQL database | none | true |
| `PAPERLESS_WEBDAV_USER` | Username for WebDAV access | none | true |
| `PAPERLESS_WEBDAV_PASSWORD` | Password for WebDAV access | none | true |
## Getting Started Production
To get a copy up and running follow these simple steps.
### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
### Installation
1. Clone the repo
```sh
git clone https://github.com/Beuterei/paperless-ngx.git
```
2. Create a `.env.production` file
```sh
touch .env.production
```
3. Overwrite all variables marked under Customization as required
4. Start docker-compose
```sh
docker-compose --env-file ./.env.production -f docker-compose.yml -f docker-compose.production.yml up -d
```
5. Set permissions for WebDAV
```sh
docker exec paperlessWebdavProd chmod -R 777 /var/lib/dav
```
### Customization
1. Create a `.env.production` file
```sh
touch .env.production
```
2. Overwrite variables as you like (format: `{variable name}={variable value}`)
| Variable | Description | Default value | Required |
| ----------------------------------- | ------------------------------------------------------------------------------- | ------------------------ | -------- |
| `POSTGRES_PASSWORD` | Password for the PostgreSQL database | none | true |
| `PAPERLESS_HOST` | Hostname/domain for your paperless-ngx instance (used for VIRTUAL_HOST and URL) | none | true |
| `PAPERLESS_LETSENCRYPT_HOST` | Hostname/domain for Let's Encrypt | ${PAPERLESS_HOST} | false |
| `PAPERLESS_WEBDAV_HOST` | Hostname/domain for WebDAV service | none | true |
| `PAPERLESS_WEBDAV_LETSENCRYPT_HOST` | Hostname/domain for WebDAV Let's Encrypt | ${PAPERLESS_WEBDAV_HOST} | false |
| `PAPERLESS_WEBDAV_USER` | Username for WebDAV access | none | true |
| `PAPERLESS_WEBDAV_PASSWORD` | Password for WebDAV access | none | true |
| `ACME_CHALLENGE` | ACME challenge type for Let's Encrypt | HTTP-01 | false |
| `PAPERLESS_SECRET_KEY` | Secret key for the paperless-ngx instance | none | true |
[contributors-shield]: https://img.shields.io/github/contributors/Beuterei/paperless-ngx.svg?style=flat-square
[contributors-url]: https://github.com/Beuterei/paperless-ngx/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Beuterei/paperless-ngx.svg?style=flat-square
[forks-url]: https://github.com/Beuterei/paperless-ngx/network/members
[stars-shield]: https://img.shields.io/github/stars/Beuterei/paperless-ngx.svg?style=flat-square
[stars-url]: https://github.com/Beuterei/paperless-ngx/stargazers
[issues-shield]: https://img.shields.io/github/issues/Beuterei/paperless-ngx.svg?style=flat-square
[issues-url]: https://github.com/Beuterei/paperless-ngx/issues
[license-shield]: https://img.shields.io/github/license/Beuterei/paperless-ngx.svg?style=flat-square