TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-22 02:18:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Website redesign

Browse Source
This commit is contained in:
eikek
2022-01-27 20:23:15 +01:00
parent 3fc7f54f1a
commit 261d2af9bb
248 changed files with 3519 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/site/content/docs/tools/_index.md
View File

@ -6,6 +6,4 @@ insert_anchor_links = "right"
template = "pages.html"
redirect_to = "docs/tools/cli/"
sort_by = "weight"
[extra]
mktoc = false
+++

43
website/site/content/docs/tools/android.md
View File

@ -10,17 +10,22 @@ 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.
<div class="columns is-vcentered is-centered">
<div class="column">
<div class="grid grid-cols-2 gap-8 divide-x ">
<div class="flex items-center justify-center">
<a href="https://f-droid.org/packages/org.docspell.docspellshare">
<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
style="height:120px;"/>
class="w-56"
/>
</a>
</div>
<div class="column">
Download the APK from <a href="https://github.com/docspell/android-client/releases/latest">here</a>
<div class="flex items-center justify-center text-xl">
<i class="fa fa-download mr-2"></i>
<span>
<a href="https://github.com/docspell/android-client/releases/latest">Download the APK</a>
</span>
</div>
</div>
@ -43,32 +48,30 @@ The app is very simple:
- 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">
<div class="grid grid-cols-3 gap-4 mx-6 my-4">
<div class="shadow dark:shadow-stone-600">
{{ imgnormal(file="screenshot-create.jpg", width="") }}
<p class="has-text-centered subtitle"> (A) </p>
<p class="text-center font-mono"> (A) </p>
</div>
<div class="column">
<div class="box-shadow">
{{ imgnormal(file="screenshot-choose.jpg", width="") }}
<p class="has-text-centered subtitle"> (B) </p>
<p class="text-center font-mono"> (B) </p>
</div>
<div class="column">
<div class="box-shadow">
{{ imgnormal(file="screenshot-options.jpg", width="") }}
<p class="has-text-centered subtitle"> (C) </p>
<p class="text-center font-mono"> (C) </p>
</div>
</div>
<div class="columns">
<div class="column">
<div class="box-shadow">
{{ imgnormal(file="screenshot-default.jpg", width="") }}
<p class="has-text-centered subtitle"> (D) </p>
<p class="text-center font-mono"> (D) </p>
</div>
<div class="column">
<div class="box-shadow">
{{ imgnormal(file="screenshot-share.jpg", width="") }}
<p class="has-text-centered subtitle"> (E) </p>
<p class="text-center font-mono"> (E) </p>
</div>
<div class="column">
<div class="box-shadow">
{{ imgnormal(file="screenshot-uploading.jpg", width="") }}
<p class="has-text-centered subtitle"> (F) </p>
<p class="text-center font-mono"> (F) </p>
</div>
</div>

84
website/site/content/docs/tools/browserext.md
View File

@ -1,84 +0,0 @@
+++
title = "Browser Extension (Firefox)"
description = "An extension for firefox to upload files from your browser via right-click → upload to docspell."
weight = 40
+++
The idea is to click on a file in firefox and send it to docspell. It
is downloaded in the context of your current page. Then handed to an
application that pushes it to docspell. There is a browser add-on
implementing this in `tools/webextension`. This add-on only works with
firefox.
Installation is a bit complicated, since you need to install external
tools and the web extension. Both work together.
# Install `dsc`
First copy the [dsc](@/docs/tools/cli.md) tool somewhere in your
`PATH`, maybe `/usr/local/bin`.
# Install the native part
Then install the "native" part of the web extension:
Copy or symlink the `native.py` script into some known location. For
example:
``` bash
ln -s ~/docspell-checkout/tools/webextension/native/native.py /usr/local/share/docspell/native.py
```
Then copy the `app_manifest.json` to
`$HOME/.mozilla/native-messaging-hosts/docspell.json`. For example:
``` bash
cp ~/docspell-checkout/tools/webextension/native/app_manifest.json ~/.mozilla/native-messaging-hosts/docspell.json
```
See
[here](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests#manifest_location)
for details.
And you might want to modify this json file, so the path to the
`native.py` script is correct (it must be absolute).
If the `dsc` tool is in your `$PATH`, then this should work. You need
to provide a default source id in your `~/.config/dsc/config.toml` so
that the upload command can be used without further arguments.
Otherwise, edit the `native.py` script and change the path to the tool
and/or the arguments. Or create a file
`$HOME/.config/docspell/dsc.cmd` whose content is the path to the
`dsc` tool.
# Install the extension
An extension file can be build using the `make-xpi.sh` script. But
installing it in "standard" firefox won't work, because [Mozilla
requires extensions to be signed by
them](https://wiki.mozilla.org/Add-ons/Extension_Signing). This means
creating an account and going through some process…. So here are two
alternatives:
1. Open firefox and type `about:debugging` in the addressbar. Then
click on *'Load Temporary Add-on...'* and select the
`manifest.json` file. The extension is now installed. The downside
is, that the extension will be removed once firefox is closed.
2. Use Firefox ESR, which allows to install Add-ons not signed by
Mozilla. But it has to be configured: Open firefox and type
`about:config` in the address bar. Search for key
`xpinstall.signatures.required` and set it to `false`. This is
described on the last paragraph on [this
page](https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox).
When you right click on a file link, there should be a context menu
entry *'Docspell Upload Helper'*. The add-on will download this file
using the browser and then send the file path to the `native.py`
script. This script will in turn call `dsc` which finally uploads it
to your configured URLs.
Open the Add-ons page (`Ctrl`+`Shift`+`A`), the new add-on should be
there.

13
website/site/content/docs/tools/cli.md
View File

@ -4,7 +4,8 @@ description = "A command line interface to."
weight = 5
+++
# Introduction
# Docspell CLI
## Introduction
The **d**oc**s**pell **c**lient, short
[dsc](https://github.com/docspell/dsc), is a tool to use
@ -17,7 +18,7 @@ directory.
It is a work in progress; eventually most of the
[api](@/docs/api/_index.md) will be covered.
# Usage
## Usage
Download the binary for your architecture from the [release
page](https://github.com/docspell/dsc/releases/latest) and rename it
@ -86,11 +87,9 @@ you need to `login` again.
## Demo
<div class="columns is-centered is-full-width">
<div class="column">
<script id="asciicast-427679" src="https://asciinema.org/a/427679.js" async></script>
</div>
</div>
<figure>
<script id="asciicast-427679" src="https://asciinema.org/a/427679.js" async></script>
</figure>
# Use Cases / Examples

8
website/site/content/docs/tools/paperless-import.md
View File

@ -4,7 +4,9 @@ description = "Import your data from paperless."
weight = 60
+++
# Introduction
# Import from Paperless
## Introduction
Coming from
[paperless](https://github.com/the-paperless-project/paperless/), the
@ -15,7 +17,7 @@ importing your data from paperless into docspell.
The script imports the files and also tags and correspondents.
{% infobubble(mode="info", title="⚠ Please note") %}
{% infobubble(title="Note") %}
The script was written some while ago. It currently doesn't work out
of the box, but is a good starting point as the issues are most
@ -25,7 +27,7 @@ issue](https://github.com/eikek/docspell/issues/1241).
{% end %}
# Usage
## Usage
Copy the script to the machine where paperless is running. Run it with
the following arguments:

2
website/site/content/docs/tools/smtpgateway.md
View File

@ -4,6 +4,8 @@ description = "Start a SMTP server that forwards all mails to docspell."
weight = 50
+++
# SMTP Gateway with Exim
One possible use case for the [integration
endpoint](@/docs/api/upload.md#integration-endpoint) is a SMTP server
that forwards all local mail to docspell. This way there is no