{"_id":"@baruchiro/n8n-nodes-paperless-ngx","name":"@baruchiro/n8n-nodes-paperless-ngx","dist-tags":{"development":"0.0.0-development.1","latest":"0.0.0-development.1"},"versions":{"0.0.0-development.1":{"name":"@baruchiro/n8n-nodes-paperless-ngx","version":"0.0.0-development.1","description":"n8n community nodes for Paperless-ngx document management system","keywords":["n8n-community-node-package","paperless-ngx","document-management","ocr"],"license":"MIT","homepage":"https://github.com/baruchiro/n8n-nodes-paperless-ngx","author":{"name":"Baruch Odem","email":"baruchiro@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/baruchiro/n8n-nodes-paperless-ngx.git"},"engines":{"node":">=20.15"},"main":"index.js","scripts":{"build":"npx rimraf dist && tsc && gulp build:icons","dev":"tsc --watch","format":"prettier nodes credentials --write","lint":"eslint nodes credentials package.json","lintfix":"eslint nodes credentials package.json --fix","prepublishOnly":"npm run build && npm run lint -c .eslintrc.prepublish.js nodes credentials package.json"},"n8n":{"n8nNodesApiVersion":1,"credentials":["dist/credentials/PaperlessNgxApi.credentials.js"],"nodes":["dist/nodes/PaperlessDocuments/PaperlessDocuments.node.js","dist/nodes/PaperlessTags/PaperlessTags.node.js","dist/nodes/PaperlessDocumentDetails/PaperlessDocumentDetails.node.js"]},"devDependencies":{"@typescript-eslint/parser":"~8.32.0","eslint":"^8.57.0","eslint-plugin-n8n-nodes-base":"^1.16.3","gulp":"^5.0.0","prettier":"^3.5.3","typescript":"^5.8.2"},"peerDependencies":{"n8n-workflow":"*"},"_id":"@baruchiro/n8n-nodes-paperless-ngx@0.0.0-development.1","gitHead":"8cbefc100b7a239407768380756b394c1559f4a7","bugs":{"url":"https://github.com/baruchiro/n8n-nodes-paperless-ngx/issues"},"_nodeVersion":"22.13.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-z06emy8ik4m7Zn0mc/kZqZxHW70Vd3WN0WPcsirSKs6fS0G2iZsbyp5iNbo3DyH7o0jG5QjpFstytaKzVSOPSQ==","shasum":"3901410a86abdd4c4f1a5104ed45a44944d87c5f","tarball":"https://registry.npmjs.org/@baruchiro/n8n-nodes-paperless-ngx/-/n8n-nodes-paperless-ngx-0.0.0-development.1.tgz","fileCount":35,"unpackedSize":120023,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEjlhodo5VoouvIpp2gWzBbUN9BsUQBp0XGCmwjWi8amAiBBV/JEFPRTVY38AgH8POufiENhCG92xiLvrR9rDEaqhA=="}]},"_npmUser":{"name":"baruchiro","email":"baruchiro@gmail.com"},"directories":{},"maintainers":[{"name":"baruchiro","email":"baruchiro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/n8n-nodes-paperless-ngx_0.0.0-development.1_1753335705857_0.9252173203759719"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-24T05:41:45.749Z","0.0.0-development.1":"2025-07-24T05:41:46.071Z","modified":"2025-07-24T05:41:46.352Z"},"maintainers":[{"name":"baruchiro","email":"baruchiro@gmail.com"}],"description":"n8n community nodes for Paperless-ngx document management system","homepage":"https://github.com/baruchiro/n8n-nodes-paperless-ngx","keywords":["n8n-community-node-package","paperless-ngx","document-management","ocr"],"repository":{"type":"git","url":"git+https://github.com/baruchiro/n8n-nodes-paperless-ngx.git"},"author":{"name":"Baruch Odem","email":"baruchiro@gmail.com"},"bugs":{"url":"https://github.com/baruchiro/n8n-nodes-paperless-ngx/issues"},"license":"MIT","readme":"# n8n-nodes-paperless-ngx\n\nThis is an n8n community node. It lets you use Paperless-ngx in your n8n workflows.\n\nPaperless-ngx is a document management system that allows you to scan, archive, and organize your documents with OCR capabilities.\n\n[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.\n\n[Installation](#installation)  \n[Development](#development)  \n[Operations](#operations)  \n[Credentials](#credentials)  \n[Compatibility](#compatibility)  \n[Usage](#usage)  \n[Resources](#resources)  \n\n## Installation\n\nFollow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.\n\n## Development\n\nYou can test your node as you build it by running it in a local n8n instance.\n\n### Prerequisites\n\n1. Install n8n using npm:\n   ```bash\n   npm install n8n -g\n   ```\n\n### Testing Your Node Locally\n\n1. When you are ready to test your node, publish it locally:\n   ```bash\n   # In your node directory\n   npm run build\n   npm link\n   ```\n\n2. Install the node into your local n8n instance:\n   ```bash\n   # In the nodes directory within your n8n installation\n   # node-package-name is the name from the package.json\n   npm link <node-package-name>\n   ```\n   \n   **Check your directory**: Make sure you run `npm link <node-name>` in the nodes directory within your n8n installation. This can be:\n   - `~/.n8n/custom/`\n   - `~/.n8n/<your-custom-name>`: if your n8n installation set a different name using `N8N_CUSTOM_EXTENSIONS`.\n\n3. Start n8n:\n   ```bash\n   n8n start\n   ```\n\n4. Open n8n in your browser. You should see your nodes when you search for them in the nodes panel.\n\n**Node names**: Make sure you search using the node name, not the package name. For example, if your npm package name is `n8n-nodes-paperless-ngx`, and the package contains nodes named `get-documents-by-tags`, `get-all-documents`, `get-all-tags`, you should search for `get-documents-by-tags`, not `paperless-ngx`.\n\n### Troubleshooting\n\nFor troubleshooting issues with running nodes locally, see the [n8n documentation on running nodes locally](https://docs.n8n.io/integrations/creating-nodes/test/run-node-locally/).\n\n## Operations\n\n### Paperless Documents Node\n- **Get Documents by Tags** - Retrieve documents filtered by specific tags\n- **Get All Documents** - Retrieve all documents with pagination and ordering\n\n### Paperless Tags Node\n- **Get All Tags** - Retrieve all tags with pagination and ordering\n- **Get Tag by ID** - Retrieve a specific tag by its ID\n\n### Paperless Document Details Node\n- **Get Document by ID** - Retrieve detailed information about a specific document\n- **Get Document Metadata** - Retrieve metadata for a specific document\n- **Get Document History** - Retrieve history for a specific document\n\n## Credentials\n\nTo use this node, you need to authenticate with your Paperless-ngx instance:\n\n1. **Base URL** - The URL of your Paperless-ngx instance (e.g., `http://192.168.1.105`)\n2. **Token** - Your authentication token from Paperless-ngx\n3. **Port** (optional) - Custom port if different from default HTTP/HTTPS ports\n\n### Getting Your Token\n\n1. Log into your Paperless-ngx instance\n2. Go to your user profile\n3. Generate an authentication token\n4. Copy the token and use it in the credentials\n\n## Compatibility\n\n- **n8n version**: 1.0.0 or later\n- **Paperless-ngx version**: 6.0.0 or later\n- **Node.js version**: 20.15 or later\n\n## Usage\n\n### Basic Workflow Example\n\n1. **Get Documents by Tags**\n   - Use the \"Paperless Documents\" node\n   - Select \"Get Documents by Tags\" operation\n   - Enter tag names (comma-separated)\n   - Configure pagination and ordering as needed\n\n2. **Get Document Details**\n   - Use the \"Paperless Document Details\" node\n   - Select \"Get Document by ID\" operation\n   - Enter the document ID\n   - Retrieve detailed document information\n\n3. **Get Available Tags**\n   - Use the \"Paperless Tags\" node\n   - Select \"Get All Tags\" operation\n   - Browse available tags in your Paperless-ngx instance\n\n### Advanced Workflow Example\n\n```\nStart → Paperless Tags (Get All Tags) → Paperless Documents (Get Documents by Tags) → Paperless Document Details (Get Document by ID)\n```\n\nThis workflow:\n1. Gets all available tags\n2. Uses those tags to filter documents\n3. Gets detailed information for each document\n\n## Resources\n\n* [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)\n* [Paperless-ngx API documentation](https://docs.paperless-ngx.com/api/)\n* [Paperless-ngx project](https://github.com/paperless-ngx/paperless-ngx)\n\n## License\n\n[MIT](LICENSE.md)\n","readmeFilename":"README.md","_rev":"1-76a10ab783a309853539b6d66ba30f82"}