Tutorial: How to Install Paperless-ngx on Windows 10

This tutorial will guide you through the process of installing Paperless-ngx on your Windows 10 machine.

Prerequisites

Before starting this tutorial, make sure you have the following prerequisites:

  • Windows 10 operating system
  • Python 3.x installed (preferably Python 3.8 or higher)
  • Git installed
  • PostgreSQL database installed (version 10 or higher)

Step 1: Clone Paperless Repository

  1. Open Command Prompt and navigate to the directory where you want to clone the Paperless repository.
  2. Run the following command to clone the Paperless repository:
git clone https://github.com/jonaswinkler/paperless-ng.git

Step 2: Install Dependencies

  1. Navigate to the cloned Paperless directory using the Command Prompt.
cd paperless-ng
  1. Run the following command to install the required dependencies:
pip3 install -r requirements.txt

Step 3: Configure Paperless Settings

  1. Copy the config.yaml.template file to config.yaml.
copy config.yaml.template config.yaml
  1. Edit the config.yaml file and modify the following settings:
    • database.url - Set this to the URL of your PostgreSQL database.
    • paperless.url - Set this to the URL you want to use to access Paperless.
    • ocr.language - Set this to the language of the documents you want to OCR.

Step 4: Create Database Tables

  1. Run the following command to create the database tables:
python3 manage.py migrate
  1. Create a superuser account:
python3 manage.py createsuperuser

Step 5: Start Paperless

  1. Start the Paperless server:
python3 manage.py runserver
  1. Navigate to http://localhost:8000 in your web browser to access Paperless.

Congratulations! You have successfully installed Paperless-ngx on your Windows 10 machine.