├── .travis.yml ├── .yamllint ├── LICENSE ├── README.md ├── defaults └── main.yml ├── handlers └── main.yml ├── meta └── main.yml ├── molecule └── default │ ├── Dockerfile.j2 │ ├── INSTALL.rst │ ├── molecule.yml │ ├── playbook.yml │ └── tests │ └── test_default.py ├── tasks └── main.yml ├── templates ├── etc │ ├── paperless.conf │ └── systemd │ │ └── system │ │ ├── paperless-consumer.service │ │ └── paperless-web.service └── opt │ └── paperless │ └── admin_password.sh ├── test.py └── vars └── main.yml /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | language: python 3 | services: docker 4 | 5 | env: 6 | - MOLECULE_DISTRO: debian9 7 | - MOLECULE_DISTRO: ubuntu1604 8 | - MOLECULE_DISTRO: ubuntu1804 9 | 10 | install: 11 | - mv ../ansible-role-paperless ../ovv.paperless 12 | - pip install molecule docker 13 | 14 | script: 15 | - molecule test 16 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | extends: default 2 | 3 | rules: 4 | braces: 5 | max-spaces-inside: 1 6 | level: error 7 | brackets: 8 | max-spaces-inside: 1 9 | level: error 10 | line-length: disable 11 | # NOTE(retr0h): Templates no longer fail this lint rule. 12 | # Uncomment if running old Molecule templates. 13 | # truthy: disable 14 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ovv.paperless 2 | ============= 3 | 4 | [![Build Status](https://travis-ci.org/ovv/ansible-role-paperless.svg?branch=master)](https://travis-ci.org/ovv/ansible-role-paperless) 5 | 6 | Ansible role to install and configure [paperless](https://github.com/danielquinn/paperless). 7 | 8 | Requirements 9 | ------------ 10 | 11 | A python3 and nginx installation are required. We recommend using [pyslackers.python](https://github.com/pyslackers/ansible-role-python) 12 | and [pyslackers.nginx](https://github.com/pyslackers/ansible-role-nginx). 13 | 14 | Installation 15 | ------------ 16 | 17 | To install this roles clone it into your roles directory. 18 | 19 | ```bash 20 | $ git clone https://github.com/ovv/ansible-role-paperless.git ovv.paperless 21 | ``` 22 | 23 | If your playbook already reside inside a git repository you can clone it by using git submodules. 24 | 25 | ```bash 26 | $ git submodule add -b master https://github.com/ovv/ansible-role-paperless.git ovv.paperless 27 | ``` 28 | 29 | Role Variables 30 | -------------- 31 | 32 | * `paperless_admin_user`: Paperless admin user. 33 | * `paperless_admin_email`: Paperless admin email. 34 | * `paperless_admin_password`: Paperless admin password. 35 | * `paperless_encrypt_passphrase`: Paperless encryption passphrase. 36 | * `paperless_secret_key`: Paperless secret key. 37 | 38 | * `paperless_consumption_dir`: Consumption directory for paperless (default to `/opt/paperless/consumption`). 39 | * `paperless_consumption_dir_group`: Group of the consumption directory (default to `paperless`). 40 | * `paperless_consumption_dir_users`: List of users to add to the `paperless_consumption_dir_group` (default to `[]`). 41 | * `paperless_consumption_dir_mode`: Consumption directory mode (default to `0770`). 42 | 43 | * `paperless_list_per_page`: Number of item per page (default to `100`). 44 | * `paperless_tz`: Timezone (default to `Etc/UTC`). 45 | * `paperless_ocr_language`: Default ocr language (default to `eng`). 46 | * `paperless_force_script_name`: See paperless configuration file. (default to `False`). 47 | * `paperless_disable_login`: Disable user authentication (default to `False`). 48 | * `paperless_inline_doc`: Allow viewing document in browser (default to `False`). 49 | 50 | * `paperless_allowed_host`: List of hosts allowed to connect (default to `[127.0.0.1, localhost]`). 51 | * `paperless_custom_packages`: Custom packages to install, like some tesseract languages (default to `[]`). 52 | 53 | * `paperless_backup`: Export paperless documents and fetch them to `paperless_backup_directory` (default to `False`). 54 | * `paperless_restore`: Upload and import documents from the `paperless_backup_directory` (default to `False`). 55 | * `paperless_backup_directory`: Directory on the computer launching the ansible where to store documents backup. 56 | 57 | Other variable and their defaults are located in [defaults](defaults/main.yml). 58 | 59 | Example Playbook 60 | ---------------- 61 | 62 | ```yml 63 | - hosts: paperless 64 | tags: 65 | - paperless 66 | roles: 67 | - pyslackers.python 68 | - ovv.paperless 69 | - pyslackers.nginx 70 | vars: 71 | paperless_admin_user: admin 72 | paperless_admin_password: password 73 | paperless_admin_email: paperless@example.com 74 | paperless_encrypt_passphrase: passphrase 75 | paperless_secret_key: supersecretkey 76 | 77 | # pyslackers.python 78 | virtualenvs: 79 | paperless: 80 | path: /opt/paperless/.env 81 | version: 3.6.4 82 | 83 | # pyslackers.nginx 84 | nginx_sites: 85 | paperless: 86 | directory: /opt/paperless 87 | locations: 88 | - location: /static 89 | custom: | 90 | autoindex on; 91 | alias /opt/paperless/static; 92 | - location: / 93 | proxy_pass: http://127.0.0.1:8000 94 | ``` 95 | -------------------------------------------------------------------------------- /defaults/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | paperless_base_packages: 4 | - git 5 | - libmagic-dev 6 | - tesseract-ocr 7 | - imagemagick 8 | - unpaper 9 | - gnupg 10 | - expect 11 | - build-essential 12 | - pkg-config 13 | - libpoppler-cpp-dev 14 | - optipng 15 | - python3-dev 16 | - python3 17 | - python3-venv 18 | - python3-pip 19 | - python3-setuptools 20 | - net-tools 21 | 22 | paperless_custom_packages: [] 23 | 24 | paperless_virtualenv: /opt/paperless/.env 25 | paperless_consumption_dir: /opt/paperless/consumption 26 | paperless_consumption_dir_group: paperless 27 | paperless_consumption_dir_users: [] 28 | paperless_consumption_dir_mode: 0770 29 | paperless_configuration_template: etc/paperless.conf 30 | 31 | paperless_git_url: https://github.com/danielquinn/paperless.git 32 | paperless_version: 2.7.0 33 | 34 | paperless_tz: Etc/UTC 35 | paperless_ocr_language: eng 36 | paperless_list_per_page: 100 37 | 38 | paperless_force_script_name: false 39 | paperless_allowed_host: 40 | - 127.0.0.1 41 | - localhost 42 | 43 | paperless_backup: false 44 | paperless_restore: false 45 | 46 | paperless_disable_login: false 47 | paperless_inline_doc: false 48 | -------------------------------------------------------------------------------- /handlers/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Restart Paperless 4 | service: 5 | name: "{{ item }}" 6 | state: restarted 7 | daemon-reload: true 8 | with_items: 9 | - paperless-web 10 | - paperless-consumer 11 | when: "'travis' not in group_names" 12 | -------------------------------------------------------------------------------- /meta/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | galaxy_info: 3 | author: Ovv 4 | description: Ansible role to install and configure paperless 5 | 6 | # If the issue tracker for your role is not on github, uncomment the 7 | # next line and provide a value 8 | # issue_tracker_url: http://example.com/issue/tracker 9 | 10 | # Some suggested licenses: 11 | # - BSD (default) 12 | # - MIT 13 | # - GPLv2 14 | # - GPLv3 15 | # - Apache 16 | # - CC-BY 17 | license: GPLv3 18 | 19 | min_ansible_version: 1.2 20 | 21 | # If this a Container Enabled role, provide the minimum Ansible Container version. 22 | # min_ansible_container_version: 23 | 24 | # Optionally specify the branch Galaxy will use when accessing the GitHub 25 | # repo for this role. During role install, if no tags are available, 26 | # Galaxy will use this branch. During import Galaxy will access files on 27 | # this branch. If Travis integration is configured, only notifications for this 28 | # branch will be accepted. Otherwise, in all cases, the repo's default branch 29 | # (usually master) will be used. 30 | # github_branch: 31 | 32 | # 33 | # platforms is a list of platforms, and each platform has a name and a list of versions. 34 | # 35 | platforms: 36 | - name: Debian 37 | versions: 38 | - 9 39 | - name: Ubuntu 40 | versions: 41 | - 16.04 42 | - 18.04 43 | 44 | galaxy_tags: [] 45 | # List tags for your role here, one per line. A tag is a keyword that describes 46 | # and categorizes the role. Users find roles by searching for tags. Be sure to 47 | # remove the '[]' above, if you add tags to this list. 48 | # 49 | # NOTE: A tag is limited to a single word comprised of alphanumeric characters. 50 | # Maximum 20 tags per role. 51 | 52 | dependencies: [] 53 | # List your role dependencies here, one per line. Be sure to remove the '[]' above, 54 | # if you add dependencies to this list. 55 | -------------------------------------------------------------------------------- /molecule/default/Dockerfile.j2: -------------------------------------------------------------------------------- 1 | # Molecule managed 2 | 3 | {% if item.registry is defined %} 4 | FROM {{ item.registry.url }}/{{ item.image }} 5 | {% else %} 6 | FROM {{ item.image }} 7 | {% endif %} 8 | 9 | RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get install -y python sudo bash ca-certificates && apt-get clean; \ 10 | elif [ $(command -v dnf) ]; then dnf makecache && dnf --assumeyes install python sudo python-devel python2-dnf bash && dnf clean all; \ 11 | elif [ $(command -v yum) ]; then yum makecache fast && yum install -y python sudo yum-plugin-ovl bash && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf && yum clean all; \ 12 | elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml && zypper clean -a; \ 13 | elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates; \ 14 | elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates && xbps-remove -O; fi 15 | -------------------------------------------------------------------------------- /molecule/default/INSTALL.rst: -------------------------------------------------------------------------------- 1 | ******* 2 | Docker driver installation guide 3 | ******* 4 | 5 | Requirements 6 | ============ 7 | 8 | * General molecule dependencies (see https://molecule.readthedocs.io/en/latest/installation.html) 9 | * Docker Engine 10 | * docker-py 11 | * docker 12 | 13 | Install 14 | ======= 15 | 16 | $ sudo pip install docker-py 17 | -------------------------------------------------------------------------------- /molecule/default/molecule.yml: -------------------------------------------------------------------------------- 1 | --- 2 | dependency: 3 | name: galaxy 4 | driver: 5 | name: docker 6 | lint: 7 | name: yamllint 8 | platforms: 9 | - name: instance 10 | image: "geerlingguy/docker-${MOLECULE_DISTRO:-debian9}-ansible:latest" 11 | command: ${MOLECULE_DOCKER_COMMAND:-""} 12 | volumes: 13 | - /sys/fs/cgroup:/sys/fs/cgroup:ro 14 | privileged: true 15 | provisioner: 16 | name: ansible 17 | lint: 18 | name: ansible-lint 19 | scenario: 20 | name: default 21 | verifier: 22 | name: testinfra 23 | lint: 24 | name: flake8 25 | -------------------------------------------------------------------------------- /molecule/default/playbook.yml: -------------------------------------------------------------------------------- 1 | --- 2 | - name: Converge 3 | hosts: all 4 | vars: 5 | paperless_admin_user: admin 6 | paperless_admin_password: Vf3FUN2ozH1ReDoK 7 | paperless_admin_email: paperless@example.com 8 | paperless_encrypt_passphrase: passphrase 9 | paperless_secret_key: supersecretkey 10 | paperless_consumption_dir_group: paperless_consumption 11 | roles: 12 | - role: ovv.paperless 13 | -------------------------------------------------------------------------------- /molecule/default/tests/test_default.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | import testinfra.utils.ansible_runner 4 | 5 | testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( 6 | os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') 7 | 8 | 9 | def test_paperless_web_is_running_and_enabled(host): 10 | web = host.service("paperless-web") 11 | assert web.is_running 12 | 13 | 14 | def test_paperless_consumer_is_running_and_enabled(host): 15 | consumer = host.service("paperless-consumer") 16 | assert consumer.is_running 17 | 18 | 19 | def test_folders_exists(host): 20 | assert host.file("/opt/paperless").is_directory 21 | 22 | consumption = host.file("/opt/paperless/consumption") 23 | assert consumption.is_directory 24 | assert consumption.user == "paperless" 25 | assert consumption.group == "paperless_consumption" 26 | assert consumption.mode == 0o770 27 | 28 | configuration = host.file("/etc/paperless.conf") 29 | assert configuration.is_file 30 | assert configuration.user == "root" 31 | assert configuration.group == "root" 32 | 33 | 34 | def test_password_script_does_not_exist(host): 35 | assert not host.file("/opt/paperless/admin_password.sh").exists 36 | 37 | 38 | def test_listenning_on_port_8000(host): 39 | assert host.socket("tcp://127.0.0.1:8000").is_listening 40 | -------------------------------------------------------------------------------- /tasks/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | - name: Base packages 4 | apt: 5 | pkg: "{{ paperless_base_packages }}" 6 | state: present 7 | 8 | - name: Custom packages 9 | apt: 10 | pkg: "{{ paperless_custom_packages }}" 11 | state: present 12 | 13 | - name: "Install python2 requirements" 14 | apt: 15 | pkg: 16 | - "python-virtualenv" 17 | - "python-pip" 18 | - "python-setuptools" 19 | state: present 20 | when: "ansible_python_version[0] == '2'" 21 | 22 | - name: Paperless group 23 | group: 24 | name: paperless 25 | state: present 26 | 27 | - name: Paperless user 28 | user: 29 | name: paperless 30 | createhome: true 31 | group: paperless 32 | 33 | - name: paperless consumption group 34 | group: 35 | name: "{{ paperless_consumption_dir_group }}" 36 | state: present 37 | 38 | - name: paperless consumption group users 39 | user: 40 | name: "{{ item }}" 41 | groups: "{{ paperless_consumption_dir_group }}" 42 | append: true 43 | with_items: "{{ paperless_consumption_dir_users }}" 44 | 45 | - name: Directories 46 | file: 47 | state: directory 48 | path: "{{ item }}" 49 | mode: 0755 50 | owner: paperless 51 | group: paperless 52 | with_items: 53 | - /opt/paperless 54 | - /opt/paperless/export 55 | - /opt/paperless/database 56 | - /opt/paperless/documents 57 | - /opt/paperless/static 58 | 59 | - name: Consumption directory 60 | file: 61 | owner: paperless 62 | group: "{{ paperless_consumption_dir_group }}" 63 | state: directory 64 | mode: "{{ paperless_consumption_dir_mode }}" 65 | path: "{{ paperless_consumption_dir }}" 66 | 67 | - name: Clone 68 | become: true 69 | become_user: paperless 70 | git: 71 | repo: "{{ paperless_git_url }}" 72 | dest: /opt/paperless/source 73 | force: true 74 | version: "{{ paperless_version }}" 75 | register: paperless_source 76 | notify: Restart Paperless 77 | 78 | - name: Python Requirements 79 | pip: 80 | requirements: /opt/paperless/source/requirements.txt 81 | virtualenv: "{{ paperless_virtualenv }}" 82 | virtualenv_python: python3 83 | 84 | - name: Configure 85 | template: 86 | src: "{{ paperless_configuration_template }}" 87 | dest: /etc/paperless.conf 88 | notify: Restart Paperless 89 | 90 | - name: Migrate Database 91 | become: true 92 | become_user: paperless 93 | django_manage: 94 | command: migrate 95 | app_path: /opt/paperless/source/src 96 | virtualenv: "{{ paperless_virtualenv }}" 97 | environment: 98 | PAPERLESS_PASSPHRASE: "{{ paperless_encrypt_passphrase }}" 99 | PAPERLESS_SECRET_KEY: "{{ paperless_secret_key }}" 100 | 101 | - name: Check if admin user exist 102 | shell: > 103 | set -o pipefail 104 | echo "from django.contrib.auth import get_user_model; 105 | User = get_user_model(); 106 | print(User.objects.filter(username='{{ paperless_admin_user }}').count()>0)" | 107 | {{ paperless_virtualenv }}/bin/python /opt/paperless/source/src/manage.py shell 108 | changed_when: "'False' in admin_exist.stdout" 109 | register: admin_exist 110 | 111 | - name: Create admin user 112 | django_manage: 113 | command: "createsuperuser --noinput --username={{ paperless_admin_user }} --email={{ paperless_admin_email }}" 114 | app_path: /opt/paperless/source/src 115 | virtualenv: "{{ paperless_virtualenv }}" 116 | when: admin_exist is changed 117 | 118 | - name: Copy admin user password script 119 | template: 120 | src: opt/paperless/admin_password.sh 121 | dest: /opt/paperless/admin_password.sh 122 | mode: 0700 123 | when: admin_exist is changed 124 | 125 | - name: Set admin user password 126 | command: /opt/paperless/admin_password.sh 127 | when: admin_exist is changed 128 | 129 | - name: Remove admin user password script 130 | file: 131 | path: /opt/paperless/admin_password.sh 132 | state: absent 133 | 134 | - name: Collect static files 135 | become: true 136 | become_user: paperless 137 | django_manage: 138 | command: collectstatic --noinput 139 | app_path: /opt/paperless/source/src 140 | virtualenv: "{{ paperless_virtualenv }}" 141 | when: paperless_source is changed 142 | 143 | - name: Create systemd directory 144 | file: 145 | path: /etc/systemd/system 146 | state: directory 147 | 148 | - name: Configure systemd services 149 | template: 150 | src: "etc/systemd/system/{{ item }}.service" 151 | dest: "/etc/systemd/system/{{ item }}.service" 152 | with_items: 153 | - paperless-web 154 | - paperless-consumer 155 | notify: Restart Paperless 156 | 157 | - name: Start & enable systemd services 158 | systemd: 159 | name: "{{ item }}" 160 | state: started 161 | enabled: true 162 | with_items: 163 | - paperless-web 164 | - paperless-consumer 165 | 166 | - name: Export documents 167 | django_manage: 168 | command: "document_exporter /opt/paperless/export" 169 | app_path: /opt/paperless/source/src 170 | virtualenv: "{{ paperless_virtualenv }}" 171 | register: paperless_docs_export 172 | changed_when: not paperless_docs_export.out 173 | when: paperless_backup | bool 174 | 175 | - name: Fetch export 176 | synchronize: 177 | mode: pull 178 | src: /opt/paperless/export/ 179 | dest: "{{ paperless_backup_directory }}" 180 | recursive: true 181 | when: paperless_backup | bool 182 | 183 | - name: Upload documents 184 | synchronize: 185 | mode: push 186 | src: "{{ paperless_backup_directory }}" 187 | dest: /opt/paperless/export 188 | recursive: true 189 | when: paperless_restore | bool 190 | 191 | - name: Import documents 192 | django_manage: 193 | command: "document_importer /opt/paperless/export" 194 | app_path: /opt/paperless/source/src 195 | virtualenv: "{{ paperless_virtualenv }}" 196 | register: paperless_docs_import 197 | changed_when: "paperless_docs_import.out is defined and 'Installed 0 object' not in paperless_docs_import.out" 198 | when: paperless_restore | bool 199 | -------------------------------------------------------------------------------- /templates/etc/paperless.conf: -------------------------------------------------------------------------------- 1 | # {{ ansible_managed }} 2 | 3 | # Sample paperless.conf 4 | # Copy this file to /etc/paperless.conf and modify it to suit your needs. 5 | # As this file contains passwords it should only be readable by the user 6 | # running paperless. 7 | 8 | 9 | ############################################################################### 10 | #### Paths & Folders #### 11 | ############################################################################### 12 | 13 | # This where your documents should go to be consumed. Make sure that it exists 14 | # and that the user running the paperless service can read/write its contents 15 | # before you start Paperless. 16 | PAPERLESS_CONSUMPTION_DIR={{ paperless_consumption_dir }} 17 | 18 | 19 | # You can specify where you want the SQLite database to be stored instead of 20 | # the default location of /data/ within the install directory. 21 | PAPERLESS_DBDIR=/opt/paperless/database 22 | 23 | 24 | # Override the default MEDIA_ROOT here. This is where all files are stored. 25 | # The default location is /media/documents/ within the install folder. 26 | PAPERLESS_MEDIADIR=/opt/paperless/documents 27 | 28 | 29 | # Override the default STATIC_ROOT here. This is where all static files 30 | # created using "collectstatic" manager command are stored. 31 | PAPERLESS_STATICDIR=/opt/paperless/static 32 | 33 | 34 | # Override the MEDIA_URL here. Unless you're hosting Paperless off a subdomain 35 | # like /paperless/, you probably don't need to change this. 36 | #PAPERLESS_MEDIA_URL="/media/" 37 | 38 | # Override the STATIC_URL here. Unless you're hosting Paperless off a 39 | # subdomain like /paperless/, you probably don't need to change this. 40 | #PAPERLESS_STATIC_URL="/static/" 41 | 42 | 43 | # These values are required if you want paperless to check a particular email 44 | # box every 10 minutes and attempt to consume documents from there. If you 45 | # don't define a HOST, mail checking will just be disabled. 46 | PAPERLESS_CONSUME_MAIL_HOST="" 47 | PAPERLESS_CONSUME_MAIL_PORT="" 48 | PAPERLESS_CONSUME_MAIL_USER="" 49 | PAPERLESS_CONSUME_MAIL_PASS="" 50 | 51 | # Override the default IMAP inbox here. If not set Paperless defaults to 52 | # "INBOX". 53 | #PAPERLESS_CONSUME_MAIL_INBOX="INBOX" 54 | 55 | # Any email sent to the target account that does not contain this text will be 56 | # ignored. 57 | PAPERLESS_EMAIL_SECRET="" 58 | 59 | 60 | ############################################################################### 61 | #### Security #### 62 | ############################################################################### 63 | 64 | # Controls whether django's debug mode is enabled. Disable this on production 65 | # systems. Debug mode is enabled by default. 66 | PAPERLESS_DEBUG="false" 67 | 68 | 69 | # Paperless can be instructed to attempt to encrypt your PDF files with GPG 70 | # using the PAPERLESS_PASSPHRASE specified below. If however you're not 71 | # concerned about encrypting these files (for example if you have disk 72 | # encryption locally) then you don't need this and can safely leave this value 73 | # un-set. 74 | # 75 | # One final note about the passphrase. Once you've consumed a document with 76 | # one passphrase, DON'T CHANGE IT. Paperless assumes this to be a constant and 77 | # can't properly export documents that were encrypted with an old passphrase if 78 | # you've since changed it to a new one. 79 | # 80 | # The default is to not use encryption at all. 81 | #PAPERLESS_PASSPHRASE="secret" 82 | 83 | 84 | # The secret key has a default that should be fine so long as you're hosting 85 | # Paperless on a closed network. However, if you're putting this anywhere 86 | # public, you should change the key to something unique and verbose. 87 | #PAPERLESS_SECRET_KEY="change-me" 88 | 89 | 90 | # If you're planning on putting Paperless on the open internet, then you 91 | # really should set this value to the domain name you're using. Failing to do 92 | # so leaves you open to HTTP host header attacks: 93 | # https://docs.djangoproject.com/en/1.10/topics/security/#host-headers-virtual-hosting 94 | # 95 | # Just remember that this is a comma-separated list, so "example.com" is fine, 96 | # as is "example.com,www.example.com", but NOT " example.com" or "example.com," 97 | PAPERLESS_ALLOWED_HOSTS="{{ paperless_allowed_host | join(',') }}" 98 | 99 | # If you decide to use the Paperless API in an ajax call, you need to add your 100 | # servers to the list of allowed hosts that can do CORS calls. By default 101 | # Paperless allows calls from localhost:8080, but you'd like to change that, 102 | # you can set this value to a comma-separated list. 103 | #PAPERLESS_CORS_ALLOWED_HOSTS="localhost:8080,example.com,localhost:8000" 104 | 105 | # To host paperless under a subpath url like example.com/paperless you set 106 | # this value to /paperless. No trailing slash! 107 | # 108 | # https://docs.djangoproject.com/en/1.11/ref/settings/#force-script-name 109 | {% if paperless_force_script_name %} 110 | PAPERLESS_FORCE_SCRIPT_NAME="{{ paperless_force_script_name }}" 111 | {% else %} 112 | #PAPERLESS_FORCE_SCRIPT_NAME="" 113 | {% endif %} 114 | # If you are using alternative authentication means or are just using paperless 115 | # as a single user on a small private network, this option allows you to disable 116 | # user authentication if you set it to "true" 117 | PAPERLESS_DISABLE_LOGIN="{{ paperless_disable_login }}" 118 | 119 | ############################################################################### 120 | #### Software Tweaks #### 121 | ############################################################################### 122 | 123 | # After a document is consumed, Paperless can trigger an arbitrary script if 124 | # you like. This script will be passed a number of arguments for you to work 125 | # with. The default is blank, which means nothing will be executed. For more 126 | # information, take a look at the docs: 127 | # http://paperless.readthedocs.org/en/latest/consumption.html#hooking-into-the-consumption-process 128 | #PAPERLESS_POST_CONSUME_SCRIPT="/path/to/an/arbitrary/script.sh" 129 | 130 | # By default, when clicking on a document within the web interface, the 131 | # browser will prompt the user to save the document to disk. By setting this to 132 | # "true", the document will instead be opened in the browser, if possible. 133 | PAPERLESS_INLINE_DOC={{ paperless_inline_doc }} 134 | 135 | # 136 | # The following values use sensible defaults for modern systems, but if you're 137 | # running Paperless on a low-resource device (like a Raspberry Pi), modifying 138 | # some of these values may be necessary. 139 | # 140 | 141 | 142 | # By default, Paperless will attempt to use all available CPU cores to process 143 | # a document, but if you would like to limit that, you can set this value to 144 | # an integer: 145 | #PAPERLESS_OCR_THREADS=1 146 | 147 | 148 | # Customize the default language that tesseract will attempt to use when 149 | # parsing documents. It should be a 3-letter language code consistent with ISO 150 | # 639: https://www.loc.gov/standards/iso639-2/php/code_list.php 151 | PAPERLESS_OCR_LANGUAGE={{ paperless_ocr_language }} 152 | 153 | 154 | # On smaller systems, or even in the case of Very Large Documents, the consumer 155 | # may explode, complaining about how it's "unable to extend pixel cache". In 156 | # such cases, try setting this to a reasonably low value, like 32000000. The 157 | # default is to use whatever is necessary to do everything without writing to 158 | # disk, and units are in megabytes. 159 | # 160 | # For more information on how to use this value, you should probably search 161 | # the web for "MAGICK_MEMORY_LIMIT". 162 | #PAPERLESS_CONVERT_MEMORY_LIMIT=0 163 | 164 | 165 | # Similar to the memory limit, if you've got a small system and your OS mounts 166 | # /tmp as tmpfs, you should set this to a path that's on a physical disk, like 167 | # /home/your_user/tmp or something. ImageMagick will use this as scratch space 168 | # when crunching through very large documents. 169 | # 170 | # For more information on how to use this value, you should probably search 171 | # the web for "MAGICK_TMPDIR". 172 | #PAPERLESS_CONVERT_TMPDIR=/var/tmp/paperless 173 | 174 | 175 | # By default the conversion density setting for documents is 300DPI, in some 176 | # cases it has proven useful to configure a lesser value. 177 | # This setting has a high impact on the physical size of tmp page files, 178 | # the speed of document conversion, and can affect the accuracy of OCR 179 | # results. Individual results can vary and this setting should be tested 180 | # thoroughly against the documents you are importing to see if it has any 181 | # impacts either negative or positive. 182 | # Testing on limited document sets has shown a setting of 200 can cut the 183 | # size of tmp files by 1/3, and speed up conversion by up to 4x 184 | # with little impact to OCR accuracy. 185 | #PAPERLESS_CONVERT_DENSITY=300 186 | 187 | 188 | # (This setting is ignored on Linux where inotify is used instead of a 189 | # polling loop.) 190 | # The number of seconds that Paperless will wait between checking 191 | # PAPERLESS_CONSUMPTION_DIR. If you tend to write documents to this directory 192 | # rarely, you may want to use a higher value than the default (10). 193 | #PAPERLESS_CONSUMER_LOOP_TIME=10 194 | 195 | 196 | # By default Paperless stops consuming a document if no language can be detected. 197 | # Set to true to consume documents even if the language detection fails. 198 | PAPERLESS_FORGIVING_OCR="true" 199 | 200 | 201 | 202 | ############################################################################### 203 | #### Interface #### 204 | ############################################################################### 205 | 206 | # Override the default UTC time zone here. 207 | # See https://docs.djangoproject.com/en/1.10/ref/settings/#std:setting-TIME_ZONE 208 | # for details on how to set it. 209 | PAPERLESS_TIME_ZONE={{ paperless_tz }} 210 | 211 | 212 | # If set, Paperless will show document filters per financial year. 213 | # The dates must be in the format "mm-dd", for example "07-15" for July 15. 214 | #PAPERLESS_FINANCIAL_YEAR_START="mm-dd" 215 | #PAPERLESS_FINANCIAL_YEAR_END="mm-dd" 216 | 217 | 218 | # The number of items on each page in the web UI. This value must be a 219 | # positive integer, but if you don't define one in paperless.conf, a default of 220 | # 100 will be used. 221 | PAPERLESS_LIST_PER_PAGE={{ paperless_list_per_page }} 222 | 223 | 224 | # The number of years for which a correspondent will be included in the recent 225 | # correspondents filter. 226 | #PAPERLESS_RECENT_CORRESPONDENT_YEARS=1 -------------------------------------------------------------------------------- /templates/etc/systemd/system/paperless-consumer.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Paperless Consumer Daemon 3 | 4 | [Service] 5 | User=paperless 6 | Group=paperless 7 | WorkingDirectory=/opt/paperless 8 | Environment="PAPERLESS_PASSPHRASE={{ paperless_encrypt_passphrase }}" 9 | Environment="PAPERLESS_SECRET_KEY={{ paperless_secret_key }}" 10 | ExecStart={{ paperless_virtualenv }}/bin/python /opt/paperless/source/src/manage.py document_consumer 11 | 12 | [Install] 13 | WantedBy=multi-user.target 14 | -------------------------------------------------------------------------------- /templates/etc/systemd/system/paperless-web.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Paperless Web Daemon 3 | 4 | [Service] 5 | User=paperless 6 | Group=paperless 7 | WorkingDirectory=/opt/paperless/source/src 8 | Environment="PAPERLESS_PASSPHRASE={{ paperless_encrypt_passphrase }}" 9 | Environment="PAPERLESS_SECRET_KEY={{ paperless_secret_key }}" 10 | ExecStart={{ paperless_virtualenv }}/bin/gunicorn paperless.wsgi -w 2 11 | 12 | [Install] 13 | WantedBy=multi-user.target 14 | -------------------------------------------------------------------------------- /templates/opt/paperless/admin_password.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/expect 2 | 3 | set timeout -1; 4 | spawn {{ paperless_virtualenv }}/bin/python /opt/paperless/source/src/manage.py changepassword {{ paperless_admin_user }}; 5 | expect { 6 | "Password:" { exp_send "{{ paperless_admin_password }}\r" ; exp_continue } 7 | "Password (again):" { exp_send "{{ paperless_admin_password }}\r" ; exp_continue } 8 | eof 9 | } 10 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | import requests 2 | 3 | url = 'http://localhost/admin/login/?next=/admin/' 4 | 5 | with requests.Session() as session: 6 | session.get(url) 7 | csrftoken = session.cookies['csrftoken'] 8 | response = session.post( 9 | url, 10 | data={ 11 | 'csrfmiddlewaretoken': csrftoken, 12 | 'next': '/admin/', 13 | 'password': 'Vf3FUN2ozH1ReDoK', 14 | 'username': 'admin' 15 | }, 16 | headers={ 17 | 'Referer': url 18 | } 19 | ) 20 | 21 | 22 | print(response.status_code) 23 | print(response.text) 24 | 25 | assert response.status_code == 200 26 | assert 'Paperless administration' in response.text 27 | -------------------------------------------------------------------------------- /vars/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # vars file for paperless 3 | --------------------------------------------------------------------------------