Skip to content

Commit

Permalink
docs: incorporate comments from PR
Browse files Browse the repository at this point in the history
Markdown was also linted
  • Loading branch information
bernd3k committed Nov 23, 2024
1 parent 377413b commit cb9c758
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 4 deletions.
15 changes: 15 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"default": true,

// Hard tabs
"MD010": { "spaces_per_tab": 4 },

// Line length
"MD013": false,

// Multiple top-level headings in the same document
"MD025": { "front_matter_title": "" },

// Inline HTML
"MD033": { "allowed_elements": ["a"] }
}
6 changes: 4 additions & 2 deletions docs/pre-consumption/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ paperless-ngx/
```

The pre-consumption "wrapper" just contains some helper variables and calls to your actual pre-consumption scripts.
<a name="pre-consumption-wrapper" />

<a name="pre-consumption-wrapper"></a>

```bash title="pre-consumption-wrapper.sh"
#!/usr/bin/env bash

Expand All @@ -51,4 +53,4 @@ python ${SCRIPT_DIR}/custom-script-02/actual-pre-consumption-task-02.py

## Examples

No examples yet :disappointed_relieved: [Want to add one?](../about/contributing.md)
Have a look at the examples via the navigation on the left side.
9 changes: 7 additions & 2 deletions docs/pre-consumption/decrypt-pdf.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
---
title: Decrypt PDFs
---

# Decrypt PDFs before consumption

Encrypted PDFs are one way to rain on your parade with paperless-ngx - even if you know the password. You get no thumbnail, no OCR, you are constantly nagged for the password when you want to view the file. So let's get rid of the encryption!
Encrypted PDFs are one way to rain on your parade with paperless-ngx - even if you know the password.You get no thumbnail, no OCR, you are constantly nagged for the password when you want to view the file. So let's get rid of the encryption!

## Setup

_decrypt-pdf_ consists of

1. the script itself
2. the password files (insecure.pwd.txt and personal.pwd.txt)
* **personal.pwd.txt** is slated for your personal passwords, it's also added to the local _.gitignore_ file
* **insecure.pwd.txt** contains some of the most prolific passwords I could find
* you can create other files in the same manner to try passwords from dumps, "most common password in XXX" lists etc.

Keep all of these in the same folder and install the script either as your one pre-consumption script or call it via other means, e.g. the [example pre-consumption consolidated wrapper script](./README.md#pre-consumption-wrapper).

0 comments on commit cb9c758

Please sign in to comment.