Upload Documents

Note

For uploading documents in bulk from local filesystem we highly recommend papermerge-cli command line utility which is briefly described in paragraph below and explained in details in :ref:papermerge_cli section.

There are different ways to upload documents to Papermerge: via web user interface, like upload button, drag'n drop, or via command line utilities like papermerge-cli. All methods have one thing in common: they use REST API to perform the actual upload. In this sense all applications which upload documents, even web user interface's described in this manual, act as REST API clients:

Note

REST API Server is web application. As any web application it is accessible with an url prefixed with http or https scheme e.g. https://my-example-dms.com, https://my-papermerge.local, http://localhost:8000/

Note

A fancy English word for "uploading" is ingesting i.e. "ingest documents to Papermerge" is same as "upload documents to Papermerge".

All documents are organized in folders. Each user has two special folders - Inbox and Home. Inbox and Home folders are special in sense that they are always there they cannot be renamed or deleted. Actually, whenever a new user is added into the Papermerge the two special folders Inbox and Home are automatically created for him/her.

Note

Internally the two special folders are named .home and .inbox - title starts with a dot and has only lowercase characters.

Upload Button

Uploading documents via user interface is the most straightforward method, just click "upload" button:

Note that documents will be uploaded into your current folder. Current folder is considered the one which you currently see as opened in web UI - that may be Inbox folder, Home folder or any arbitrarily deeply nested folder inside Home or Inbox.

Again, using upload button, you can upload documents into randomly deeply nested folder inside Inbox as well:

Drag'n Drop

This method is very similar to the above described method, the only difference is that instead of clicking upload button - you drag'n drop documents, using mouse, from your desktop to Papermerge web ui in your browser.

Warning

Currently drag 'n drop feature does not work for folders, in other words you can drag 'n drop only documents. If you want to import an folders with entire content preserved - use papermerge-cli described in next paragraph.

Command Line

You can upload documents and folders from your local filesystem using :ref:papermerge_cli command line utility:

papermerge-cli import /path/to/local/folder/

Note that papermerge-cli will import all content of /path/to/local/folder/ directory recursively i.e. it will preserve the structure of local folder in Papermerge as well.

You can upload one single document by providing path to the document:

papermerge-cli import /path/to/document.pdf

Note

By default all imported documents and folders will end up inside user's Inbox folder.

For more information about papermerge-cli check papermerge-cli section.