Skip to content

standard.md

Latest commit

 

History

History
105 lines (68 loc) · 2.56 KB

standard.md

File metadata and controls

105 lines (68 loc) · 2.56 KB

Prerequisites Installation

Before installing Unstructured Document Viewer, you need to install several system dependencies that are required for the application to generate PDF document views.

These packages and libraries are essential components that must be installed on your system to ensure Unstructured Document Viewer runs without issues and can generate views for your PDF documents.

The following instructions are for Ubuntu systems. If you're using a different operating system, please find the equivalent commands for your distribution.

1. System Update

First, ensure your system is up to date and all packages are current:

sudo apt update
sudo apt upgrade

2. Install System Dependencies

Install the required system libraries that pdf2htmlEX depends on:

sudo apt install libglib2.0-0 libfreetype6 libfontconfig1 libcairo2 libpng16-16 libjpeg-turbo8 libxml2 wget

3. pdf2htmlEX Installation

Install pdf2htmlEX following the official documentation.

For Ubuntu, run the following commands:

wget https://github.com/pdf2htmlEX/pdf2htmlEX/releases/download/v0.18.8.rc1/pdf2htmlEX-0.18.8.rc1-master-20200630-Ubuntu-bionic-x86_64.deb -O /var/tmp/pdf2htmlEX.deb
sudo apt install -y /var/tmp/pdf2htmlEX.deb

Verify the installation:

pdf2htmlEX --version
# Expected output example:
# pdf2htmlEX version 0.18.8.rc1
# Libraries:
#   poppler 0.89.0
#   libfontforge (date) 20200314
#   cairo 1.18.0
# Supported image formats: png jpg svg

Clean up the downloaded package file:

rm -f /var/tmp/pdf2htmlEX.deb

Installing Unstructured Document Viewer

Once all prerequisites are installed, you can install the viewer using one of the following methods:

Using pip:

pip install unstructured-document-viewer

Using Poetry:

poetry add unstructured-document-viewer
poetry install

Note: This will automatically install rag-document-viewer as a dependency.

Quick Start and Basic Usage

For quick start instructions and basic usage examples, please refer to the main documentation.

Troubleshooting

If you encounter any issues during installation:

  1. Ensure all system dependencies are properly installed
  2. Verify that pdf2htmlEX is working correctly using the version command above
  3. Check that your system is up to date

Roadmap

Upcoming Features:

  • Standalone docker image
  • Support for additional operating systems

Stay tuned for updates and new releases!