paperbaseapp / paperbase

Open source document organizer with automatic OCR and full text search

Quick start

Read the docs on how to set up your own Paperbase instance.

Development setup

Prerequisites

• Docker
• Docker Compose

1. Copy .env.example to .env
2. Fill APP_KEY (32 random chars) and DB_PASSWORD
3. docker-compose up
4. Create a new user with docker-compose exec app php artisan user:create
5. You can access Paperbase at http://paperbase.localhost

paperbase's Issues

Only scan for changed/new files if someone is logged in or viewing the page

• Turn autosync on and off
• Set custom autosync interval

set minimal width for side bar in document viewer

give user choice to set default library owner via user ID

enables user to directly access the folder without changing the owner first

Show error message if path/library does not exist

Change default items per page and change options for this in the drop down menu

Display job progresses

show progress icon after refreshing the site

Hide the document viewer on mobile devices

add also "view" and "download" button for mobile

support more document formats

for example:

• images [jpg, png]
• markdown (incl editor? ❤️)
• txt

Allow user to create library

The user should be able to create libraries to categorize their folders on a top-level.

lower process priority for the OCR jobs

currently the OCR jobs use too much CPU power. The system gets unresponsive due to this.

Use scroll wheel to navigate through item pages while hovering over the arrow buttons

implement new folder button

disable cache for download endpoint

Add logout button

display the sync alert without the need to reload the page

Implement multicore queue processing

Add breadcrumbs

Support for symlinks

RECURSION!!

implement basic drag and drop options

• upload from local computer
• move within application

Related to #40

Add dark mode and make it the default

Library settings

• Automatic OCR on/off
  Advanced:
• Sync mode: mtime (default) / hash (slow)

Add user account settings

• Allow changing the username
• Allow changing the password
• Allow changing/adding email address

Implement seperate page handling

• Create DocumentPage Model
• Read out PDF page count
• Adjust pdftotext args

Thumbnail creation

Create thumbnails for pdfs.

pdftocairo [input-file] [output-file] -jpeg -singlefile -antialias best -scale-to 400 -jpegopt "quality=60,progressive=y,optimize=y"

• One per document
• Save under /storage/thumbnails/
• delete thumbnails, when documents are deleted
• recreate thumbnail if the document is changed
• max 320px in width or height

Ask Lennard to create a logo

Please

file manager operations

• move files
• drag n drop
• delete files from library view
• select files
• upload files via dragging into library view

Move docs CI badge to docs repository

Support for 2FA

Folder is not opening by clicking it

Error msg:

vue-router.esm.js?8c4f:2065 Uncaught (in promise) NavigationDuplicated: Avoided redundant navigation to current location: "/browse/2960b227-b3ef-4687-baa3-3dfe0434ebbb?path=scan".
    at createRouterError (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:2066:15)
    at createNavigationDuplicatedError (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:2036:15)
    at HTML5History.confirmTransition (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:2329:18)
    at HTML5History.transitionTo (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:2261:8)
    at HTML5History.push (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:2602:10)
    at eval (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:3021:22)
    at new Promise (<anonymous>)
    at VueRouter.push (webpack-internal:///./node_modules/vue-router/dist/vue-router.esm.js:3020:12)
    at VueComponent.navigateToPath (webpack-internal:///./node_modules/cache-loader/dist/cjs.js?!./node_modules/babel-loader/lib/index.js!./node_modules/cache-loader/dist/cjs.js?!./node_modules/vue-loader/lib/index.js?!./src/components/library-explorer-view.vue?vue&type=script&lang=js&:312:20)
    at VueComponent.navigateToItem (webpack-internal:///./node_modules/cache-loader/dist/cjs.js?!./node_modules/babel-loader/lib/index.js!./node_modules/cache-loader/dist/cjs.js?!./node_modules/vue-loader/lib/index.js?!./src/components/library-explorer-view.vue?vue&type=script&lang=js&:320:14)

Steps to reproduce:

1. open Paperbase (libary completly synced)
2. open a pdf file from main folder
3. close file
4. click on a folder
   a. page looks like it reloads something but folder will not open
5. F5 will reload page and the selected folder will open

Proper 404 handling for libraries

Display an error when the user tries to load a library that doesn't exist instead of loading for eternity.

Create library from dialog with enter

Add overview over all failed files

This would be great because at the moment the user does not know which files failed and thus is not able to perform consequent actions.

Document viewer sidebar

Add Trash for each library

The trash is used for the user to be able to restore deleted files or to restore the original, non-OCR'd files in case something went wrong.

Switch to new library after creating one

give user the option to enable a automatic library sync

Reason: I do not want to click "sync" and wait some time after accessing Paperbase although the file I am looking for is already in the folder structure for some time (inserted manually directly into the folder)

Note:

• probably with backup of the read files so that the user can reset these in a fixed amount of time

Support for labels