Git Product home page Git Product logo

paperless-mobile's Introduction

Contributors Forks Stargazers Issues MIT License


Logo

Paperless Mobile

An (almost) fully fledged mobile paperless client.

Get it on Google Play Get it on F-Droid

Report Bug · Request Feature

⚠️ Important Notes

  • Breaking changes are still expected between updates! Please perform a clean instal after updating the app before filing an issue or leaving a 1-star review in the App-Store!

About The Project

Paperless Mobile brings paperless-ngx to your smartphone without any compromises. While you can use paperless-ngx from a mobile browser, managing your documents this way is often a tedious and slow process. The app integrates a custom scanner, biometric authentication and many more conveniences to help you make the transition from a paper-based to a fully digital office experience.

🚀 Highlights

✔️ View your documents at a glance
✔️ Add, delete or edit documents
✔️ Share, download and preview files
✔️ Manage and assign labels
✔️ Scan and upload documents to paperless
✔️ Upload existing documents from other apps via Paperless Mobile
✔️ Easily process and manage new documents in the dedicated inbox
✔️ Search for documents using a wide range of filter criteria
✔️ Secure your data with a biometric factor
✔️ Support for TLS mutual authentication (client certificates)
✔️ Modern, intuitive UI built according to the Material Design 3 specification
✔️ Available in English, German, Polish, French, Catalan, Czech and Turkish language with more to come

Built With

Flutter

Languages and Translations Crowdin

If you want to contribute by translating a language, feel free to join the Crowdin project!

Thanks to the following contributors for providing translations:

Roadmap

  • Fully custom document scanner optimized for common white A4 documents and optimized for the use with Paperless
  • Add more languages
  • Publish to AppStore

See the open issues for a full list of issues and open feature requests for requested features.

License

Distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.

Donations

If you wish to support the development of this project, you can donate through GitHub Sponsors (see "Sponsor this project" on the right). Any donation is much appreciated and keeps the development of this project alive!

Contributors

Made with contrib.rocks.

Want to contribute? Have a look at the contributing guidelines and how to get started.

Troubleshooting

Suggestions are not selectable in any of the label form fields

This is a known issue in ealier versions (<3.x.x) and it has to do with accessibility features of Android. Password managers such as Bitwarden often caused this issue. Luckily, this can be resolved by turning off the accessibility features in these apps. This could also be observed with apps that are allowed to display over other apps, such as emulations of the dynamic island on android.

I cannot log in since the update to paperless-ngx 1.14.0 (and above).

The app has to somehow get information about its user from the paperless API. Therefore, the Users -> View and the UISettings -> View permissions are required for each user trying to log into the app. Otherwise, the app has no way of obtaining your user id and other information required for the usage of most features.

paperless-mobile's People

Contributors

astubenbord avatar bjoernh avatar enrico204 avatar flokol120 avatar hermannoffen avatar iulica avatar klys-equinix avatar lagmoellertim avatar markkastoun avatar svetlemodry avatar zjean avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

paperless-mobile's Issues

[Feature] Add documents inbox

Change start page to an inbox or welcome page showing all documents tagged with an inbox tag, also allowing mark each as "read" by removing all inbox tags from said document.
this could be done by e.g. swiping or clicking a button.

Switching between documents and scanner duplicates the list of documents

I currently have 3 documents and they are listed propperly on the documents tab. When switching to the scanner tab, do nothing and switch back to the document tab the 3 documents are listed twice. Doing that again will make it 9 document. When I pull down the list, it updates and there are again 3 documents.

[Feature] Add creation mask to saved views

Currently, saved views can only be created based on the current filter criteria. However, the paperless-ng*x API offers many more options, which (at least to my knowledge) cannot all be covered by the regular filter. Therefore, add a proper creation mask which prefills the current filter, keeping the current behavior, but also adding the option to modify the current selection and/or add criteria which are not present in the document filter panel.

Improve app intro slider

Add localization, possibly some pages explaining basics with screenshots, and one page with all important settings (biometric auth, language, theme) once after login.

Some functions are hidden and not very intuitive.

Does not connect to my docker instance

Hello, thanks for your project that looks very promising.
I have a docker installation in my synology NAS. I don't use https connection but instead clear http. It is impossible to connect (Could not reach your Paperless server).

Unable to assign multiple tags

Hi, I encounter a bug when trying to assign multiple tags to a document. Only 1 tag is able to be chosen from the list, with the selected tag overwriting any existing tags chosen. I'm on v1.1.0+5 and server version is 1.9.2.

Missing generated folder for compiling

I tried to compile the app locally with the steps from README:

git clone https://github.com/astubenbord/paperless-mobile.git
flutter pub get
flutter packages pub run build_runner build --delete-conflicting-outputs

After running these commands, the "generated" folder for the l10n translations is still missing. Without it flutter refuses to compile because of missing imports. Maybe there is a command missing in the README?

Thanks after all. Good work :D

More convenient way for tagging

When we have lots of tags, it's difficult to apply tags for documents.

Something like paperless does on it's ui would be nice.

A kind of search box which will filtrer dynamically the list.

It could also be great to be able to add a New tag directly when editing a document (same for New correspondent and type)

PS : this app is wonderfull. A really great companion. Thanks for sharing

[Improvement] Server Address ending with / gives "authentication failed"

Hello,

I encountered an error when you're on the first screen "Connect to Paperless" where you have to enter the server address, username and password you cannot proceed if the server address ends with a slash /.

Does work: http://subdomain.domain.tld
Doesn't work: http://subdomain.domain.tld/

Maybe this can be fixed. I copy and pasted my URL from somewhere else and that's why it had the slash at the end.

If that's too much work maybe just add a simple notice that it should not end with a slash 😉

Regards,
Etarus

Reseting filter also resets sorting

When you reset the filter criterias in version 1.3.0, it will also reset the ordering of documents, which in my opinion shouldn't be done. I often order by creation date descending and do additional filtering. When I reset the filter the ordering switches back to ascending order.

Layout of document details page can be improved

Currently the overview tab of the documents details page uses a large font for each section ("Title", "Created At", "Document Type", etc.) and a small font for the actuall value. I propose to do just other way around. In case of the title I would even skip the word 'Title', because it's obvious that the first line on that overview tab is the title. Especially if it's written in a larger font.

You could even skip those meta data which isn't set. That saves some space and allows to see the meta data (on the overview tab) which is set but not visible. In my case, the Document Type and Correspondent are rarely set, but tags are usually set. Unfortunately, the tags are never visible, because they are pushed done by the empty fields for Document Type and Correspondent. Using less space for the meta data on the overview tab may even allow to use more space for the preview on the top of the page.

Sharing from other apps only working if Paperless mobile is open in background

Expected behavior

Use "share document" from any app to Paperless mobile, which then will open and prompt for file details before upload, regardless if Paperless mobile is running in the background.

Actual behavior

When sharing a document, the detail prompt will only open if you have opened Paperless mobile before.

Steps to reproduce

  1. Close Paperless Mobile
  2. Open a file in an app of your choice and press "Share"
  3. Select Paperless Mobile
  4. The app will open as it would regularly, without prompting for the file upload

Technical details

Paperless server version 1.10.2 (API v2)
Paperless Mobile version 1.3.1+10
Android version 9

In-app scan preview stretched, missing icons

First of all, great app! It's easily the best option for Paperless on Android at the moment.

I have spotted a few issues using 1.2.2 (from Play Store):

Scanning in-app forces some weird stretching, not present in any other camera app. This is in both portrait (compressed) and landscape (expanded).

image

More importantly, no icons are displayed, forcing the user to guess that the dark circle means save, or hold their finger until the tooltip shows up:

image

I've also had issues cropping when the crop points get hidden under the "Crop" bar at the top and it's impossible to grab the point, unless you get lucky and manage to grab it by the edge.

Query for changes of last n days, weeks, month

If you set the filter to 'Last 7 days' your app creates a query with a start date 8 days ago and an end date of tomorrow. If you save that as a view, it will save the dates. If you recall that view tomorrow or even next week it will not return the documents of the last 7 days, but the documents of 7 day period in the past.

The paperless web ui sets the query param to 'added:[-1 week to now]' instead.

No need to put the title 'Content' on the content tab

The 'Content' tab of the document details page has an extra header 'Content'. I suggest to remove it, as it just use space but doesn't add any information. The tab is already titled 'Content' and there is nothing but the documents plain text on that tab.

"You're offline" doesn't disappear

my wifi is a bit flaky, so my mobile phone often disconnects and reconnects. If that happens and the wifi is back, it often still says "You're offline". I can change the filter settings or the ordering and its updating the document list, but I cannot pull down the document list for updating it. The 'Labels' tab also claims that there is no internet connection and doesn't even try to update the
Correspondents, Document Types, etc.

I have to quit the app and start it again to get out of that.

Saved views are not persistent

Saved views are lost when closing the app via app drawer. Aren't those stored persistent?

PS: Thanks for this great app. It has all the features I was missing from the other apps.

Save the grid view

We Can select the grid view. It works and it's nice. But this isnt saved. Each time we come back to document tab. It resets to list view.

PS : this app is wonderfull. A really great companion. Thanks for sharing

Unable to login to paperless when autologin is enabled

In my paperless-ngx docker instance (behind Traefik proxy) I am using the "PAPERLESS_AUTO_LOGIN_USERNAME" environment parameter so I don't have to login to paperless-ngx.

This is because I use a separate authentication software (Authelia).

When autologin is enabled - I cannot login from the mobile app.
Once I disable this option - mobile application logins without issues.

Any way to make this work without forcing username + password ?
I don't know - support autologin and/or tokens ?
Even if autologin isn't safe (again - I use Authelia for authentication) - fingerprint access to the mobile app is always some protection.

Release on public stores

Hello,
now that the app beta has been published, may be it's time to think about deploying it to the stores. I know of the costs for PlayStore, but Fdroid would only require you to add fastlane metadata into the repository, afaik. This would also help with testing on more devices, as you would automatically gain more reach.


Edit by @astubenbord:

  • Add to Google Play
  • Add to F-Droid
  • Add to Apple AppStore

Compatibility with older versions

I can see all documents and their metadata correctly.

As soon as I change something, be it correspondent or tag and save it, I get: 'Document successfully updated' followed by 'Could not update document. Please try again' message.

What could be the reason?

I am 1.0.3+1, installed from Google play store.

Saved views are not updated

I often switch between two paperless ngx server. Both have saved views. Unfortunately, the app shows views from both servers no matter where I'm logged in. Looks like the app caches the list of saved views and doesn't refresh it after connecting to another server.

It also doesn't refresh the list of views after I have created a new one with the paperless ngx web gui client. Aren't views shared between clients?

[Feature] Upload support for files

The scanner feature works great (tested on One Plus 8T). Sometimes i want to upload a file i already have (.pdf, .jpeg). I tried to use my filemanager instead of the camera, but that didn't worked. Maybe a new button to upload local documents would be nice. That is also pretty easy in flutter.

Even better would be a support for the sharing function in Android to directly upload a document without opening the app in the first place.

Maybe i will implement that in a seperat branch if i have time in the weekend. I will report.

I appreciate your work. Very good designed.

build process fails because of missing signingConfigs for release version

The are several solutions to this problem. The easiest is to note in the README that in order to compile the code it is neccessary to change in android/app/build.gradle from

buildTypes {
       release {
           signingConfig signingConfigs.release
       }
   }

to

buildTypes {
       release {
           signingConfig signingConfigs.debug
       }
   }

Clearly it is possible to compile in Debug mode. But then you give up a lot of performance optimization.

Cheers

Document preview wrong

When using the document preview not everything is shown. I normally add signatures to my documents by using PDFXChange Viewer. When viewing those documents in paperless-mobile, I can't see any text fields.
When sharing the pdf with another app to store it on the phone, everything is fine.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.