docspell / android-client

Share files from android with Docspell

Docspell Android Client

This is an android app for docspell, a digital document organizer and archive. It can be used to conveniently upload files from your android device.

It works as follows:

• Create a list of docspell urls and store them inside the app: Open Docspell in your browser and go to Collective Settings ‣ Sources. Create a new source or click Show on an existing one. Then add the Public API Upload URL to this app by scanning the QR code.
• Use whatever app, for example a document scanner app, like the free OpenNoteScanner and share the result with the docspell app. It will be uploaded to the configured url and docspell starts processing it immediatly.

A (slightly :)) longer version from the above is available, too.

Installing

Or

Download from the release page.

Building

Using gradle:

gradle assembleRelease

Settings for signing must be made available.

Android 7.0 + TLS

If you run in issues regarding your docspell server and tls, check whether you use android 7.0. It might be this.

Summary: The ssl_ecdh_curve secp384r1; definition in nginx/apache is the problem. Replacing this with ssl_ecdh_curve prime256v1; solved it. Or, if possible, update android to 7.1+.

Screenhots

android-client's Issues

Move to github actions

Travis-CI is shutting down soon.

Upload not working

I scan the Code to my Andriod 11 Smartphone. The shows the url and the api url. If i share a pdf nothing happened. I follow the instructions at the documentation page

Feature request: Allow user/custom certificate CA

My DocSpell is reachable via SSL; when trying to upload data, I get an error that the certificate chain is broken. My certificate is issued by a local CA, the certificate is added in the user store.
I think accepting user SSL certificates has to be explicitly enabled in the manifest (at least that's what Google pointed me to). Not everyone is crazy enough to set up his/her own CA, but self-signed certs might be a more common case. So it would be great to have an option to accept a self-made certificate (or its CA).

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Update actions/setup-java action to v4
• Update dependency com.android.tools.build:gradle to v8
• Update dependency gradle to v8
• Update dependency ubuntu to v22
• Update release-drafter/release-drafter action to v6
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency androidx.test.ext:junit to v1.1.5
• Update actions/checkout action to v3.6.0
• Update dependency androidx.appcompat:appcompat to v1.6.1
• Update dependency androidx.test.espresso:espresso-core to v3.5.1
• Update dependency com.android.tools:desugar_jdk_libs to v1.2.3
• Update dependency com.google.android.material:material to v1.12.0
• Update dependency com.squareup.okhttp3:okhttp to v4.12.0
• Update dependency gradle to v7.6.4
• Update plugin com.github.ben-manes.versions to v0.51.0
• Update actions/checkout action to v4
• Update dependency com.android.tools:desugar_jdk_libs to v2
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yml

• actions/checkout v3.0.2
• actions/setup-java v3
• burrunan/gradle-cache-action v1
• ubuntu 20.04
• ubuntu 20.04

.github/workflows/release-drafter.yml

• release-drafter/release-drafter v5
• ubuntu 20.04

.github/workflows/release-nightly.yml

• actions/checkout v3.0.2
• actions/setup-java v3
• burrunan/gradle-cache-action v1
• r0adkll/sign-android-release v1
• ubuntu 20.04

.github/workflows/release.yml

• actions/checkout v3.0.2
• actions/setup-java v3
• burrunan/gradle-cache-action v1
• r0adkll/sign-android-release v1
• meeDamian/github-release 2.0
• ubuntu 20.04

gradle

gradle.properties

settings.gradle

build.gradle

• com.android.tools.build:gradle 4.2.2
• com.github.sherter.google-java-format 0.9
• com.github.ben-manes.versions 0.42.0

app/build.gradle

• com.android.tools:desugar_jdk_libs 1.1.5
• androidx.appcompat:appcompat 1.3.1
• com.google.android.material:material 1.4.0
• androidx.constraintlayout:constraintlayout 2.1.4
• me.dm7.barcodescanner:zxing 1.9.13
• androidx.swiperefreshlayout:swiperefreshlayout 1.1.0
• com.squareup.okhttp3:okhttp 4.9.3
• junit:junit 4.13.2
• androidx.test.ext:junit 1.1.3
• androidx.test.espresso:espresso-core 3.4.0

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

• gradle 7.4.2

---

• Check this box to trigger a request for Renovate to run again on this repository

NO_ERROR while uploading via app

Hi,

i generated such QR code as docspell source and scanned the second one (API) with my smartphone - i downloaded the latest version from fdroid.

unfortunately, i am getting the following error:

Everything else seems to work. Tried from different smartphones in different connections.

Do i have to take care on something special at my reverse proxy? Websockets are enabled and HTTPS also. All Smartphones are running at least Android 10

UPDATE
I checked the server logs - nothing is appearing there.

Unfortunately, i cannot try the setup without reverse Proxy since HTTP ist blocked by Network Policy. Docspell-Share shows this error :android cleartext communication not permited by network security policy

According to the AndroidManifest.xml HTTP should be allowed:

android-client/app/src/main/AndroidManifest.xml

Line 16 in 184f610

android:usesCleartextTraffic="true"

Problem with uploading on MIUI

I have set up a docspell instance at home which is working fine so far. On that instance I configured a source to upload data via my android device. I've got two devices: a OnePlus 6 with Android 11 and a Redmi Note 9 Pro with MIUI 12.5.1. Both devices are configured to upload to that one share. It is working perfectly fine on the Oneplus and not at all on the Redmi. I wonder if there is a way to debug this. On the Redmi I already removed the app and the data and installed it completely new.

Any help is appreciated. Thanks, Michael

Cache uploads when no network is available and upload once connected

This should be optional, so that users are not required to grant any permission.

Cleartext http traffic not allowed in version 0.5.0

See https://app.element.io/#/room/#eikek_docspell:gitter.im/$efZjWvfIHRddug3LbOSRUhwmL7W-DVcsNMwqXQ-2v9w

The current version ( 0.5.0) enforces https. I'd like to allow http traffic for this app, because I think that the use case of having docspell only in the internal LAN in ones home warrants using http instead of setting up ssl certificates…. It would be nice, if this could be explicitly enabled by the user, but my little android know-how must be expanded for this…:)

Workaround: use version 0.4.0 for now if you need cleartext traffic.

sharing multiple documents does not work

First of all, thank you very much for the great app! I use them very much and regularly;).

But I noticed one problem:
If several files have been selected on the smartphone and are to be shared with "Docspell Share", apparently all files are sent, but Docspell only ever receives one document.

Filename not recognized

Hi,

first of all:
Thank you for the nice tool!

I am coming from paperless and am evaluating docspell as the future alternative.

Here is my Problem:
I've setup all components and everything runs smoothly.
But when i upload a document (e.x. pdf) from my Android Phone, the name is not kept.

e.x. "2021-05-18 hotel recipe.pdf" is beeing converted to sth like 137887.pdf Also in the Uploading dialog of the App this number is displayed.

Later in the WebUI, the converted pdf, the original and the document name are this number (every new document gets a new unique number).

Is this expected or a bug?

Regards!

Publish to fdroid

When no default selected, let user choose where to upload