| Name | DuplexPDF JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | None |
| Summary | Auto merge your scans to a duplex using a FTP relay server. Designed to work on Synology DSM Container Manager |
| upload_time | 2025-01-11 17:28:30 |
| maintainer | None |
| docs_url | None |
| author | Andreas Brilka |
| requires_python | >=3.11 |
| license | None |
| keywords |
docker
nas
duplex
scan
scanning
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DuplexPDF
DuplexPDF is a simple FTP relay server which allows you to generate duplex scans (front and backed scanned) if your scanner at least support to upload to a FTP server.
It works best if you have a ADF (automatic document feeder) which can scan a range of documents fast, but can't scan them on both sides.
While designed for Synology DSM and the included Container Manager, you can make it work on any system.
To start, please first make sure you fullfill therequirements:
* You have a printer that can scan FDPs to FTP
* You have a FTP server to upload the merged files
* Your printer is able to name your scans with the 'Duplex1_' or 'Duplex2_' literal followed by the datetime in the following format: YYYYMMDD_hhmmss (for example Duplex1_20251217_135916.pdf)
* You can run python3 and pip in a Docker container (for example supported by most Synology NAS)
DuplexPDF is configured by environment variables to be easly run in a Docker container
* **duplexPDF_cache**: path for cache directory (e.g. /usr/duplexPDF/cache)
* **duplexPDF_log**: path for the log directory (e.g. /usr/duplexPDF/log)
* **duplexPDF_incoming_addr**: the ip adress and port for the FTP server. IMPORTANT: If your container is running behind a NAT, set here the address you are accessing your NAS. (e.g. 192.168.178.46:1487)
* **duplexPDF_incoming_passive_port_range**: the range for PASV commands (e.g. 32000-32005)
* **duplexPDF_incoming_password**: the password for the relay FTP server your printer uploads the scanned files to. The username is 'duplexPDF'
* **duplexPDF_outgoing_addr**: the ip adress and port for your destination FTP server where the merged files will be send (e.g. 127.0.0.1:21)
* **duplexPDF_outgoing_username**: the username for your destination FTP server
* **duplexPDF_outgoing_password**: the password for your destination FTP server
* **duplexPDF_outgoing_dir**: into this path the merged files will be send
* **duplexPDF_source_port**: The port duplexPDF uses to communicate to the destination FTP server (e.g. 1488)
### Some important notes:
* You need to open the ports you specified in the config, usually the duplexPDF_source_port, duplexPDF_incoming_addr (port) and every port in the range of duplexPDF_incoming_passive_port_range
* DuplexPDF supports FTPS, but can fallback to FTP
* The cache is only cleared on startup. Everything inside of it except the '.cache', 'ftpd.cert' and 'ftpd.key' can be safely deleted while the container is running
### Example configuration on a Synology NAS
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_folders.png" style="max-width: 600px;"> <br>
<em>You should create a folder for the logs, the cache and the script (run.py)</em>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_script_run.png" style="max-width: 600px;"> <br>
<em>You need to download the run.py script which installs and runs duplexPDF from PIP </em>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_container_creation.png" style="max-width: 600px;"> <br>
<em>Creating the container in DSM (You don't need to change the IP adress here)</em>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_container_network_cmd.png" style="max-width: 600px;"> <br>
<em>Network settings and the command to execute</em>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_port_settings.png" style="max-width: 600px;"> <br>
<em>Port settings in DSM</em>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_volume_settings.png" style="max-width: 600px;"> <br>
<em>Volume settings in DSM</em>
</p>
<p align="center">
<img src="https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_env_settings.png" style="max-width: 600px;"> <br>
<em>Environment settings in DSM</em>
</p>
Raw data
{
"_id": null,
"home_page": null,
"name": "DuplexPDF",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Docker, NAS, duplex, scan, scanning",
"author": "Andreas Brilka",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f8/4d/9323a14c65d07451eb8b383270bdecd203396013ae0bd23ed95fb9a05e7f/duplexpdf-1.0.3.tar.gz",
"platform": null,
"description": "# DuplexPDF\n\nDuplexPDF is a simple FTP relay server which allows you to generate duplex scans (front and backed scanned) if your scanner at least support to upload to a FTP server. \nIt works best if you have a ADF (automatic document feeder) which can scan a range of documents fast, but can't scan them on both sides. \nWhile designed for Synology DSM and the included Container Manager, you can make it work on any system.\n\nTo start, please first make sure you fullfill therequirements:\n\n* You have a printer that can scan FDPs to FTP\n* You have a FTP server to upload the merged files\n* Your printer is able to name your scans with the 'Duplex1_' or 'Duplex2_' literal followed by the datetime in the following format: YYYYMMDD_hhmmss (for example Duplex1_20251217_135916.pdf)\n* You can run python3 and pip in a Docker container (for example supported by most Synology NAS)\n\nDuplexPDF is configured by environment variables to be easly run in a Docker container\n\n* **duplexPDF_cache**: path for cache directory (e.g. /usr/duplexPDF/cache)\n* **duplexPDF_log**: path for the log directory (e.g. /usr/duplexPDF/log)\n* **duplexPDF_incoming_addr**: the ip adress and port for the FTP server. IMPORTANT: If your container is running behind a NAT, set here the address you are accessing your NAS. (e.g. 192.168.178.46:1487)\n* **duplexPDF_incoming_passive_port_range**: the range for PASV commands (e.g. 32000-32005)\n* **duplexPDF_incoming_password**: the password for the relay FTP server your printer uploads the scanned files to. The username is 'duplexPDF'\n* **duplexPDF_outgoing_addr**: the ip adress and port for your destination FTP server where the merged files will be send (e.g. 127.0.0.1:21)\n* **duplexPDF_outgoing_username**: the username for your destination FTP server\n* **duplexPDF_outgoing_password**: the password for your destination FTP server\n* **duplexPDF_outgoing_dir**: into this path the merged files will be send\n* **duplexPDF_source_port**: The port duplexPDF uses to communicate to the destination FTP server (e.g. 1488)\n\n\n### Some important notes:\n\n* You need to open the ports you specified in the config, usually the duplexPDF_source_port, duplexPDF_incoming_addr (port) and every port in the range of duplexPDF_incoming_passive_port_range\n* DuplexPDF supports FTPS, but can fallback to FTP\n* The cache is only cleared on startup. Everything inside of it except the '.cache', 'ftpd.cert' and 'ftpd.key' can be safely deleted while the container is running\n\n### Example configuration on a Synology NAS\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_folders.png\" style=\"max-width: 600px;\"> <br>\n <em>You should create a folder for the logs, the cache and the script (run.py)</em>\n</p> \n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_script_run.png\" style=\"max-width: 600px;\"> <br>\n <em>You need to download the run.py script which installs and runs duplexPDF from PIP </em>\n</p> \n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_container_creation.png\" style=\"max-width: 600px;\"> <br>\n <em>Creating the container in DSM (You don't need to change the IP adress here)</em>\n</p> \n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_container_network_cmd.png\" style=\"max-width: 600px;\"> <br>\n <em>Network settings and the command to execute</em>\n</p> \n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_port_settings.png\" style=\"max-width: 600px;\"> <br>\n <em>Port settings in DSM</em>\n</p> \n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_volume_settings.png\" style=\"max-width: 600px;\"> <br>\n <em>Volume settings in DSM</em>\n</p> \n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/andreasmz/duplexPDF/main/media/dsm_env_settings.png\" style=\"max-width: 600px;\"> <br>\n <em>Environment settings in DSM</em>\n</p> \n",
"bugtrack_url": null,
"license": null,
"summary": "Auto merge your scans to a duplex using a FTP relay server. Designed to work on Synology DSM Container Manager",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/andreasmz/duplexPDF",
"Issues": "https://github.com/andreasmz/duplexPDF/issues",
"Repository": "https://github.com/andreasmz/duplexPDF"
},
"split_keywords": [
"docker",
" nas",
" duplex",
" scan",
" scanning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d0236b260116216ffaeef8f7d03ad4556d481430ce43f312dc2a222e0df4e18",
"md5": "76001a6b716896ebf536de406e7110c9",
"sha256": "981a441e46c5f31b57b1bb34ffa6c4cee3076fbee008a6afef10e20a72fbb1cd"
},
"downloads": -1,
"filename": "duplexpdf-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76001a6b716896ebf536de406e7110c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9244,
"upload_time": "2025-01-11T17:28:28",
"upload_time_iso_8601": "2025-01-11T17:28:28.162211Z",
"url": "https://files.pythonhosted.org/packages/3d/02/36b260116216ffaeef8f7d03ad4556d481430ce43f312dc2a222e0df4e18/duplexpdf-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f84d9323a14c65d07451eb8b383270bdecd203396013ae0bd23ed95fb9a05e7f",
"md5": "cf40ba27440ec94d871e5fe685a115d1",
"sha256": "3efaa5c401ae70c7b2eb42301f53b26a9a5c03f8546e77d15ab56a4173784f01"
},
"downloads": -1,
"filename": "duplexpdf-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "cf40ba27440ec94d871e5fe685a115d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 93913,
"upload_time": "2025-01-11T17:28:30",
"upload_time_iso_8601": "2025-01-11T17:28:30.465558Z",
"url": "https://files.pythonhosted.org/packages/f8/4d/9323a14c65d07451eb8b383270bdecd203396013ae0bd23ed95fb9a05e7f/duplexpdf-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 17:28:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andreasmz",
"github_project": "duplexPDF",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "duplexpdf"
}
