Skip to content

About

KronenPaperless: Paperless Mobile (paperless-ngx client) with a built-in WireGuard tunnel for reaching a home-only server

Topics

Resources

Contributing

Stars

2 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

748 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KronenPaperless

Paperless Mobile with a built-in WireGuard tunnel – reach your Paperless-ngx server from anywhere, even if it is only available inside your home network, without switching a VPN on by hand.

KronenPaperless is a fork of Paperless Mobile by Anton Stubenbord (GPL-3.0). All features of Paperless Mobile are unchanged; the fork only adds the tunnel. The tunnel was offered upstream (#707, #388), but the maintainer prefers to keep it out of the original app, so it lives on in this fork.

How it works

  • Import your WireGuard configuration once (.conf file from your router, e.g. UniFi, Fritz!Box, OPNsense, wg-easy) under Settings → Connection on the go, grant the Android VPN permission and test the connection.
  • Only this app uses the tunnel. Other apps and the rest of your phone are not routed through it, and no separate WireGuard app is needed.
  • Automatic: enter the names of your home Wi-Fi networks. At home the app connects directly, anywhere else it starts the tunnel by itself and stops it again a few minutes after you leave the app (1/5/15/30 minutes or never). Without home Wi-Fi names the app checks whether Paperless answers directly (a reverse proxy answering 403 does not count) and only starts the tunnel if needed.
  • Diagnostics: Check connection in detail shows tunnel handshake, DNS of the VPN configuration vs. your phone, TCP and Paperless checks, home Wi-Fi detection and a plain-language verdict. The report can be copied.
  • Privacy: the configuration is stored encrypted (Android Keystore) and excluded from backups. The location permission is optional and only used because Android requires it to read the Wi-Fi name; no location is stored or sent. The app sends no data to the developer. Privacy policy (German).

Install

  • GitHub: signed APKs are attached to the releases. Works well with Obtainium for automatic updates.
  • Google Play: currently in closed testing. To join, become a member of the Google Group kronenpaperless-tester, then open the opt-in link and install from Google Play (no "unknown sources" needed). Feedback is welcome in the issues.
  • The package name is de.koeddi.kronenpaperless, so it can be installed next to the original Paperless Mobile. The GitHub and the Google Play version are signed differently: stick to one source, otherwise uninstall first.

Kurz auf Deutsch

KronenPaperless ist Paperless Mobile mit eingebautem WireGuard-Tunnel. Die WireGuard-Datei vom Router wird einmal importiert, danach verbindet die App unterwegs automatisch und nur für sich selbst. Im eingetragenen Heim-WLAN wird kein Tunnel gebraucht. Unter „Verbindung genau prüfen“ zeigt die App, woran es hakt.

Building

Flutter 3.35.4: flutter pub get, flutter gen-l10n, dart run build_runner build --delete-conflicting-outputs, then flutter build apk --release (or appbundle). Without android/key.properties the release build is signed with the debug key. Use release builds for testing: debug builds fail to dex the WireGuard library together with core library desugaring (see #707). How to merge upstream changes and which files are changed: docs/FORK.md.


Below: the original README of Paperless Mobile. Store badges and issue links there refer to the original app.


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

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 by sharing files with Paperless Mobile
✔️ Conveniently process new documents in a dedicated inbox
✔️ Search for documents using a wide range of filter criteria
✔️ Easily switch between multiple users
✔️ Secure your data with biometric authentication
✔️ Support for mTLS (client certificates)
✔️ Support for 2FA
✔️ Modern, intuitive UI built to streamline workflows
✔️ 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

Uploading the document silently fails for larger files

Most users run paperless-ngx behind a reverse proxy. Typically, the default upload limit is too low to upload larger files. To resolve this, the upload limit has to be increased (e.g. to 16MB). Also see #502.

I cannot log in since paperless-ngx 1.14.0 (and above)

The app requires information about the current user from the paperless API. As a result, 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.

Heimnetz-Erkennung: WLAN-Namen können hinterlegt werden, damit zu Hause kein Tunnel benötigt wird. Android verlangt Standort-Berechtigung und aktivierte Standortdienste nur zum Lesen des WLAN-Namens; der Standort wird weder gespeichert noch gesendet.

About

KronenPaperless: Paperless Mobile (paperless-ngx client) with a built-in WireGuard tunnel for reaching a home-only server

Topics

Resources

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages