Giter Club home page Giter Club logo

ansible-role-paperless's Introduction

ovv.paperless

Build Status

Ansible role to install and configure paperless.

Requirements

A python3 and nginx installation are required. We recommend using pyslackers.python and pyslackers.nginx.

Installation

To install this roles clone it into your roles directory.

$ git clone https://github.com/ovv/ansible-role-paperless.git ovv.paperless

If your playbook already reside inside a git repository you can clone it by using git submodules.

$ git submodule add -b master https://github.com/ovv/ansible-role-paperless.git ovv.paperless

Role Variables

  • paperless_admin_user: Paperless admin user.

  • paperless_admin_email: Paperless admin email.

  • paperless_admin_password: Paperless admin password.

  • paperless_encrypt_passphrase: Paperless encryption passphrase.

  • paperless_secret_key: Paperless secret key.

  • paperless_consumption_dir: Consumption directory for paperless (default to /opt/paperless/consumption).

  • paperless_consumption_dir_group: Group of the consumption directory (default to paperless).

  • paperless_consumption_dir_users: List of users to add to the paperless_consumption_dir_group (default to []).

  • paperless_consumption_dir_mode: Consumption directory mode (default to 0770).

  • paperless_list_per_page: Number of item per page (default to 100).

  • paperless_tz: Timezone (default to Etc/UTC).

  • paperless_ocr_language: Default ocr language (default to eng).

  • paperless_force_script_name: See paperless configuration file. (default to False).

  • paperless_disable_login: Disable user authentication (default to False).

  • paperless_inline_doc: Allow viewing document in browser (default to False).

  • paperless_allowed_host: List of hosts allowed to connect (default to [127.0.0.1, localhost]).

  • paperless_custom_packages: Custom packages to install, like some tesseract languages (default to []).

  • paperless_backup: Export paperless documents and fetch them to paperless_backup_directory (default to False).

  • paperless_restore: Upload and import documents from the paperless_backup_directory (default to False).

  • paperless_backup_directory: Directory on the computer launching the ansible where to store documents backup.

Other variable and their defaults are located in defaults.

Example Playbook

- hosts: paperless
  tags:
    - paperless
  roles:
    - pyslackers.python
    - ovv.paperless
    - pyslackers.nginx
  vars:
    paperless_admin_user: admin
    paperless_admin_password: password
    paperless_admin_email: [email protected]
    paperless_encrypt_passphrase: passphrase
    paperless_secret_key: supersecretkey

    # pyslackers.python
    virtualenvs:
      paperless:
        path: /opt/paperless/.env
        version: 3.6.4

    # pyslackers.nginx
    nginx_sites:
      paperless:
        directory: /opt/paperless
        locations:
          - location: /static
            custom: |
              autoindex on;
              alias /opt/paperless/static;
          - location: /
            proxy_pass: http://127.0.0.1:8000

ansible-role-paperless's People

Contributors

ovv avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.