├── .gitignore ├── .vscode └── settings.json ├── LICENSE ├── README.md ├── app.py ├── scan_adf.sh └── templates └── form.html /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # UV 98 | # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | #uv.lock 102 | 103 | # poetry 104 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 105 | # This is especially recommended for binary packages to ensure reproducibility, and is more 106 | # commonly ignored for libraries. 107 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 108 | #poetry.lock 109 | 110 | # pdm 111 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 112 | #pdm.lock 113 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 114 | # in version control. 115 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 116 | .pdm.toml 117 | .pdm-python 118 | .pdm-build/ 119 | 120 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 121 | __pypackages__/ 122 | 123 | # Celery stuff 124 | celerybeat-schedule 125 | celerybeat.pid 126 | 127 | # SageMath parsed files 128 | *.sage.py 129 | 130 | # Environments 131 | .env 132 | .venv 133 | env/ 134 | venv/ 135 | ENV/ 136 | env.bak/ 137 | venv.bak/ 138 | 139 | # Spyder project settings 140 | .spyderproject 141 | .spyproject 142 | 143 | # Rope project settings 144 | .ropeproject 145 | 146 | # mkdocs documentation 147 | /site 148 | 149 | # mypy 150 | .mypy_cache/ 151 | .dmypy.json 152 | dmypy.json 153 | 154 | # Pyre type checker 155 | .pyre/ 156 | 157 | # pytype static type analyzer 158 | .pytype/ 159 | 160 | # Cython debug symbols 161 | cython_debug/ 162 | 163 | # PyCharm 164 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 165 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 166 | # and can be added to the global gitignore or merged into this file. For a more nuclear 167 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 168 | #.idea/ 169 | 170 | # PyPI configuration file 171 | .pypirc 172 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "cSpell.words": [ 3 | "Lineart", 4 | "nuvious", 5 | "ocrmypdf", 6 | "pycache", 7 | "scanadf", 8 | "scanlock", 9 | "scanpi", 10 | "smbscandir" 11 | ] 12 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ScanPi 2 | 3 | A simple self-hosted scanner that is designed to allow scanning using document 4 | scanners to automatically scan, save and ocr documents. While called ScanPi it 5 | could be deployed to any system. Designed to give USB scanners or any scanner 6 | that is supported by [scanadf](https://linux.die.net/man/1/scanadf) a second 7 | life. 8 | 9 | Current implementation does not have authentication. Issue #1 is earmarked for 10 | implementation of authentication, ideally without requiring any registration. 11 | 12 | ## Demo 13 | 14 | [![ScanPi Video Demo](http://img.youtube.com/vi/9Ftn02hEa44/0.jpg)](http://www.youtube.com/watch?v=9Ftn02hEa44 "ScanPi Video Demo") 15 | 16 | ## Quickstart 17 | 18 | First install flask, scanadf and ocrmypdf. The application needs to run as root 19 | for `scanadf` so install as the root user. 20 | 21 | ```bash 22 | sudo pip3 install Flask 23 | sudo apt update 24 | sudo apt install scanadf ocrmypdf -y 25 | ``` 26 | 27 | Next launch the app. 28 | 29 | ```bash 30 | sudo python3 app.py 31 | ``` 32 | 33 | The scan tool defaults to `http://localhost:5000`. Current implementation has 34 | no authentication, but will be added in the future. 35 | 36 | ## Environment Variables 37 | 38 | Settings are modified through environment variables listed below: 39 | 40 | |Name|Desc|Default| 41 | |-|-|-| 42 | |DEBUG|Launches flask in debug and raises all exceptions.|False| 43 | |ROOT_PATH|Root path for scan form endpoint.|'/'| 44 | |SOURCES|Scanner specific sources as a comma separated string.|"ADF Front,ADF Back,ADF Duplex"| 45 | |MODES|Scanner specific modes as a comma separated string.|"Lineart,Halftone,Gray,Color"| 46 | |RESOLUTIONS|Scanner specific resolutions as a comma separated string.|"50,100,150,200,250,300,350,400,450,500,550,600"| 47 | |DATE_FORMAT|A date format string prepended to file names|"%Y-%m-%d-%H-%M-%S"| 48 | |SCAN_DIRECTORY|A default directory to put scanned files. Default assumes using some form of network share.|/mnt/scan| 49 | |PROCESSING_LOCKFILE|Location of the lockfile used to avoid collisions during scan processing.|/var/lock/.scanlock| 50 | |SCAN_JOB_DELAY|Seconds to wait between scan jobs to allow loading the next job.|15s| 51 | 52 | NOTE: It is possible to queue multiple jobs, but order is not guaranteed. If 53 | queueing multiple jobs use a generic name like 'scan1', 'scan2', etc and rename 54 | after the fact. 55 | 56 | ## Systemd Service Template 57 | 58 | Below is an example of a systemd configuration that moves the scan directory 59 | to `/mnt/smbscandir` and makes the root path `/scan` instead of `/` with the 60 | project cloned to my home directory. 61 | 62 | ```ini 63 | [Unit] 64 | Description=ScanPi Python Application 65 | After=network.target 66 | 67 | [Service] 68 | WorkingDirectory=/home/nuvious/scanpi 69 | ExecStart=/usr/bin/python3 /home/nuvious/scanpi/app.py 70 | Environment="SCAN_DIRECTORY=/mnt/smbscandir" 71 | Environment="ROOT_PATH=/scan" 72 | Restart=always 73 | RestartSec=30 74 | User=root 75 | Group=root 76 | 77 | [Install] 78 | WantedBy=multi-user.target 79 | ``` 80 | 81 | Below is a copy-paste-ready command one could run that generates a default 82 | configuration with scanpi cloned to /opt/scanpi and scans are saved to 83 | `/mnt/scan` and the root path is `/`. Below should be run as root. 84 | 85 | ```bash 86 | set -e # Stop on any error 87 | mkdir -p /mnt/scan 88 | git clone https://github.com/nuvious/scanpi.git /opt/scanpi 89 | touch /lib/systemd/system/scanpi.service 90 | cat > /lib/systemd/system/scanpi.service << EOF 91 | [Unit] 92 | Description=ScanPi Python Application 93 | After=network.target 94 | 95 | [Service] 96 | WorkingDirectory=/opt/scanpi 97 | ExecStart=/usr/bin/python3 /opt/scanpi/app.py 98 | Restart=always 99 | RestartSec=30 100 | User=root 101 | Group=root 102 | 103 | [Install] 104 | WantedBy=multi-user.target 105 | EOF 106 | # Edit accordingly if desired to add environment variables. 107 | systemctl enable scanpi --now 108 | ``` 109 | 110 | ## Tested Hardware 111 | 112 | [Fujitsu/RICOH SnapScan S1500](https://www.pfu.ricoh.com/global/scanners/scansnap/discontinued/s1500/s1500.html) 113 | -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | from flask import Flask, render_template, request, redirect, url_for 2 | import subprocess 3 | import datetime as dt 4 | import os 5 | 6 | DEBUG = os.environ.get("DEBUG", False) 7 | ROOT_PATH = os.environ.get("ROOT_PATH", '/') 8 | SOURCES = os.environ.get("SOURCES", "ADF Front,ADF Back,ADF Duplex").split(",") 9 | MODES = os.environ.get("MODES", "Lineart,Halftone,Gray,Color").split(",") 10 | RESOLUTIONS = os.environ.get("RESOLUTIONS", "50,100,150,200,250,300,350,400,450,500,550,600").split(",") 11 | DATE_FORMAT = os.environ.get("DATE_FORMAT", "%Y-%m-%d-%H-%M-%S") 12 | 13 | app = Flask(__name__) 14 | 15 | # Function to generate current date-time formatted as specified 16 | def current_datetime(): 17 | """ 18 | Generates a datetime string for the file folder and name. Format defaults 19 | to %Y-%m-%d-%H-%M-%S and can be modified by setting the DATE_FORMAT 20 | environment variable. 21 | 22 | Returns: 23 | str: Formatted datetime string 24 | """ 25 | now = dt.datetime.now() 26 | return now.strftime(DATE_FORMAT) 27 | 28 | def render_root_path(default_date, message=""): 29 | """Renders the root path with an optional message 30 | 31 | Args: 32 | default_date (str): A datetime string 33 | message (str, optional): A status message. Defaults to "". 34 | 35 | Returns: 36 | str: The rendered template 37 | """ 38 | return render_template('form.html', 39 | default_date=default_date, 40 | resolutions=RESOLUTIONS, 41 | sources=SOURCES, 42 | modes=MODES, 43 | message=message) 44 | 45 | @app.route(ROOT_PATH, methods=['GET','POST']) 46 | def root_path(): 47 | """ 48 | Front page renderer that also launches the scanner script. Root path 49 | defaults to '/' but can be modified via the ROOT_PATH environment variable. 50 | 51 | Returns: 52 | str: The rendered root path. 53 | """ 54 | default_date = current_datetime() 55 | try: 56 | if request.method == 'POST': 57 | # Extract form data 58 | name = f"{request.form['date']}-{request.form['name']}" 59 | mode = request.form['mode'] 60 | resolution = f"{int(request.form['resolution'])}dpi" 61 | source = request.form['source'] 62 | env_vars = os.environ.copy() 63 | env_vars["FILENAME"] = name 64 | env_vars["MODE"] = mode 65 | env_vars["RESOLUTION"] = resolution 66 | env_vars["SOURCE"] = source 67 | 68 | # Call the scan_adf.sh script with the provided arguments 69 | subprocess.Popen(['/bin/bash','scan_adf.sh'], env=env_vars) 70 | return render_root_path(default_date, message='Scan request submitted successfully!') 71 | else: 72 | return render_root_path(default_date) 73 | except Exception as _: 74 | if DEBUG: 75 | raise 76 | else: 77 | return render_root_path(default_date, 'There was an error. Check the server.') 78 | 79 | if __name__ == '__main__': 80 | app.run(host="0.0.0.0", debug=DEBUG) 81 | -------------------------------------------------------------------------------- /scan_adf.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -x 3 | # set -e 4 | 5 | SCAN_DIRECTORY=${SCAN_DIRECTORY:-/mnt/scan} 6 | PROCESSING_LOCKFILE=/var/lock/.scanlock 7 | touch "$PROCESSING_LOCKFILE" 8 | 9 | # Acquire lock for scanning and processing 10 | exec 4<"$PROCESSING_LOCKFILE" 11 | flock 4 12 | 13 | # Create the directory for the scan 14 | pushd $SCAN_DIRECTORY 15 | mkdir -p "$FILENAME" 16 | pushd "$FILENAME" 17 | 18 | # Scan the document 19 | scanadf --mode $MODE --source "$SOURCE" --resolution $RESOLUTION 2>>stderr.log 1>>stdout.log || true 20 | 21 | # Convert to pdf and apply OCR 22 | convert image* "$FILENAME.pdf" 2>>stderr.log 1>>stdout.log 23 | ocrmypdf -r -d -c --rotate-pages-threshold 0 "$FILENAME.pdf" "$FILENAME.ocr.pdf" 2>>stderr.log 1>>stdout.log 24 | # Sometimes ocrmypdf still has these files locked after, wait until they're done 25 | until ! lsof "stdout.log" >/dev/null 2>&1; do sleep 1s; done 26 | until ! lsof "stderr.log" >/dev/null 2>&1; do sleep 1s; done 27 | 28 | # Replace non-ocr with ocr document and cleanup files and locks 29 | mv "$FILENAME.ocr.pdf" "$FILENAME.pdf" 2>>stderr.log 1>>stdout.log 30 | rm image* 2>>stderr.log 1>>stdout.log 31 | 32 | # Ensure permissions allow users to access the scans 33 | chmod -R u+rwX,g+rwX,o+rwX "$FILENAME" 34 | 35 | # Give a break between scan jobs of 15 seconds to allow loading a queued job 36 | sleep 15s 37 | 38 | exec 4<&- 39 | popd # FILENAME 40 | 41 | popd # SCAN_DIRECTORY 42 | -------------------------------------------------------------------------------- /templates/form.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Scan Form 6 |

{{ message }}

7 | 53 | 54 | 55 |

Scan Form

56 |
57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 69 | 70 | 71 | 76 | 77 | 78 | 83 | 84 | 85 |
86 | 87 | 88 | --------------------------------------------------------------------------------