Initial doc for new android app
@ -57,6 +57,8 @@ description = "A list of features and limitations."
|
||||
- [eml](https://en.wikipedia.org/wiki/Email#Filename_extensions)
|
||||
(e-mail files in plain text MIME)
|
||||
- Tooling:
|
||||
- [Android App](@/docs/tools/android.md) to quickly upload files
|
||||
from your android devices
|
||||
- [Watch a folder](@/docs/tools/consumedir.md): watch folders for
|
||||
changes and send files to docspell
|
||||
- [Simple CLI for uploading files](@/docs/tools/ds.md)
|
||||
|
@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Tools"
|
||||
description = "There are several tools distributed with docspell, like a program to watch a folder and import files to docspell."
|
||||
description = "There are several tools distributed with docspell, like a program to watch a folder and import files or a simple android app."
|
||||
weight = 60
|
||||
insert_anchor_links = "right"
|
||||
template = "pages.html"
|
||||
|
87
website/site/content/docs/tools/android.md
Normal file
@ -0,0 +1,87 @@
|
||||
+++
|
||||
title = "Android Client"
|
||||
description = "A simple Android App to upload files from your devices."
|
||||
weight = 20
|
||||
+++
|
||||
|
||||
# Android Client
|
||||
|
||||
There is a simple Android App available to conveniently upload files
|
||||
from your android devices. Combined with a scanner app, this allows to
|
||||
very quickly scan single page documents like receipts.
|
||||
|
||||
The project lives at a [repository on
|
||||
github](https://github.com/docspell/android-client). It is planned to
|
||||
be available from the [F-Droid](https://f-droid.org) store, meanwhile
|
||||
download the APK from
|
||||
[here](https://github.com/docspell/android-client/releases/latest).
|
||||
|
||||
|
||||
# Usage
|
||||
|
||||
The app is very simple:
|
||||
|
||||
- You maintain a list of upload URLs. These can be inserted
|
||||
conveniently by scanning the QR code. You need to create these
|
||||
upload urls at docspell as described
|
||||
[here](@/docs/webapp/uploading.md#anonymous-upload).
|
||||
- Start this app on your device and add a new URL
|
||||
- Then start some other app, and try to share a file. The *Share with*
|
||||
or *Open with* dialog should contain now the docspell app. Choose
|
||||
it.
|
||||
- You can now either select an URL from the app, or the upload begins
|
||||
immediatly if you set a default URL.
|
||||
|
||||
<div class="columns">
|
||||
<div class="column">
|
||||
{{ imgnormal(file="screenshot-create.jpg", width="") }}
|
||||
<p class="has-text-centered subtitle"> (A) </p>
|
||||
</div>
|
||||
<div class="column">
|
||||
{{ imgnormal(file="screenshot-choose.jpg", width="") }}
|
||||
<p class="has-text-centered subtitle"> (B) </p>
|
||||
</div>
|
||||
<div class="column">
|
||||
{{ imgnormal(file="screenshot-options.jpg", width="") }}
|
||||
<p class="has-text-centered subtitle"> (C) </p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="columns">
|
||||
<div class="column">
|
||||
{{ imgnormal(file="screenshot-default.jpg", width="") }}
|
||||
<p class="has-text-centered subtitle"> (D) </p>
|
||||
</div>
|
||||
<div class="column">
|
||||
{{ imgnormal(file="screenshot-share.jpg", width="") }}
|
||||
<p class="has-text-centered subtitle"> (E) </p>
|
||||
</div>
|
||||
<div class="column">
|
||||
{{ imgnormal(file="screenshot-uploading.jpg", width="") }}
|
||||
<p class="has-text-centered subtitle"> (F) </p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
## Create an URL
|
||||
|
||||
Add a new one With the *Plus* button. The name (A-1) is to distinguish
|
||||
it in the list. The url (A-2) is used to upload files. You can add
|
||||
multiple URLs. You can give permissions to access the camera and use
|
||||
(A-3) to scan a QR code from the screen.
|
||||
|
||||
## Edit and Default
|
||||
|
||||
Tapping an item in the list switches the view that shows some options.
|
||||
You can set one URL as the default (C-1). When uploading a file, the
|
||||
screen to choose an URL is skipped then and the file is uploaded
|
||||
immediately.
|
||||
|
||||
Other actions are editing the url (C-2), going back (C-3) or deleting the
|
||||
item (4).
|
||||
|
||||
The screen (D) shows a default URL with a green background.
|
||||
|
||||
## Upload
|
||||
|
||||
Use some other app, for example OpenNoteScanner, and share the
|
||||
resulting files using the *Share With* menu (E). Then this app opens
|
||||
and uploads the file to your server (F).
|
@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Browser Extension (Firefox)"
|
||||
description = "An extension for firefox to upload files from your browser via right-click → upload to docspell."
|
||||
weight = 30
|
||||
weight = 40
|
||||
+++
|
||||
|
||||
The idea is to click on a file in firefox and send it to docspell. It
|
||||
|
@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "Consume Directory"
|
||||
description = "A script to watch a directory for new files and upload them to docspell."
|
||||
weight = 20
|
||||
weight = 30
|
||||
+++
|
||||
|
||||
# Introduction
|
||||
|
BIN
website/site/content/docs/tools/get-it-on.png
Normal file
After Width: | Height: | Size: 14 KiB |
BIN
website/site/content/docs/tools/screenshot-choose.jpg
Normal file
After Width: | Height: | Size: 84 KiB |
BIN
website/site/content/docs/tools/screenshot-create.jpg
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
website/site/content/docs/tools/screenshot-default.jpg
Normal file
After Width: | Height: | Size: 88 KiB |
BIN
website/site/content/docs/tools/screenshot-options.jpg
Normal file
After Width: | Height: | Size: 86 KiB |
BIN
website/site/content/docs/tools/screenshot-share.jpg
Normal file
After Width: | Height: | Size: 112 KiB |
BIN
website/site/content/docs/tools/screenshot-uploading.jpg
Normal file
After Width: | Height: | Size: 56 KiB |
@ -1,7 +1,7 @@
|
||||
+++
|
||||
title = "SMTP Gateway with Exim"
|
||||
description = "Start a SMTP server that forwards all mails to docspell."
|
||||
weight = 40
|
||||
weight = 50
|
||||
+++
|
||||
|
||||
One possible use case for the [integration
|
||||
|
3
website/site/templates/shortcodes/imgnormal.html
Normal file
@ -0,0 +1,3 @@
|
||||
{% set len = page.components | length %}
|
||||
{% set p = page.components | slice(end=len - 1) | join(sep='/') %}
|
||||
<img src="{{ get_url(path=p ~ "/" ~ file) }}" width="{{ width }}">
|