How to Install Paperless-ngx on Void Linux

Paperless-ngx is a free and open source document management system that allows you to scan, organize, and search your documents easily. This tutorial will guide you through the steps to install Paperless-ngx on Void Linux.

Prerequisites

Before we start the installation process, make sure your system meets the following prerequisites:

  • Void Linux OS installed on your system
  • Sudo user privileges

Step 1: Install necessary packages

First, we need to install some necessary software packages for Paperless-ngx. Open the terminal and run the following commands:

sudo xbps-install -S git python3 python3-dev python3-pip libxml2-dev libxslt-dev zlib-dev cairo-dev pango-dev

This command will install git, python3, python3-dev, python3-pip, libxml2-dev, libxslt-dev, zlib-dev, cairo-dev, and pango-dev packages on your system.

Step 2: Clone Paperless-ngx from Github

In this step, we will clone Paperless-ngx source code from Github to our project directory. Run the following command to clone the source code:

cd $HOME && git clone https://github.com/danielquinn/paperless-ng.git

Step 3: Install Python dependencies

In this step, we will install Python dependencies for Paperless-ngx using pip. Navigate to the paperless-ng directory and run the following command:

cd $HOME/paperless-ng && sudo pip3 install -r requirements.txt

Step 4: Create a configuration file

To configure Paperless-ngx, we need to create a configuration file. Copy the sample configuration file to the project directory using the following command:

cd /home/user/paperless-ng && cp config/settings.yml.sample config/settings.yml

Step 5: Edit the configuration file

Now, edit the configuration file using your preferred text editor:

vim config/settings.yml

You can set the database path, server address, and other settings in this configuration file as per your requirements.

Step 6: Initialize the database

In this step, we are going to create the database for Paperless-ngx. Run the following command in your project directory:

cd /home/user/paperless-ng && paperless -v initialize

Step 7: Run Paperless-ngx

To run the Paperless-ngx server, execute the following command in your project directory:

cd /home/user/paperless-ng && paperless -v runserver

Finally, open your web browser and go to localhost:8000 to access Paperless-ngx.

Congratulations! You have successfully installed Paperless-ngx on your Void Linux system.