mirror of
				https://github.com/TheAnachronism/docspell.git
				synced 2025-11-03 18:00:11 +00:00 
			
		
		
		
	@@ -1,8 +1,7 @@
 | 
			
		||||
let
 | 
			
		||||
  nixpkgs = builtins.fetchTarball {
 | 
			
		||||
    #url = "channel:nixos-21.05";
 | 
			
		||||
    url = "https://github.com/NixOS/nixpkgs/archive/2d6ab6c6b92f7aaf8bc53baba9754b9bfdce56f2.tar.gz";
 | 
			
		||||
    #sha256 = "0l975q132x08qvw73qj391dl6qk9a661my8njcg5sl5rcmna3bmj";
 | 
			
		||||
    url = "https://github.com/NixOS/nixpkgs/archive/e6badb26fc0d238fda2432c45b7dd4e782eb8200.tar.gz";
 | 
			
		||||
  };
 | 
			
		||||
  pkgs = import nixpkgs { };
 | 
			
		||||
in
 | 
			
		||||
 
 | 
			
		||||
@@ -4,14 +4,14 @@ base_url = "https://docspell.org"
 | 
			
		||||
# Whether to automatically compile all Sass files in the sass directory
 | 
			
		||||
compile_sass = true
 | 
			
		||||
 | 
			
		||||
[markdown]
 | 
			
		||||
# Whether to do syntax highlighting
 | 
			
		||||
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
 | 
			
		||||
highlight_code = true
 | 
			
		||||
highlight_theme = "gruvbox-dark"
 | 
			
		||||
 | 
			
		||||
# Whether to build a search index to be used later on by a JavaScript library
 | 
			
		||||
build_search_index = true
 | 
			
		||||
default_language = "en"
 | 
			
		||||
 | 
			
		||||
[markdown]
 | 
			
		||||
highlight_code = true
 | 
			
		||||
highlight_theme = "gruvbox-dark"
 | 
			
		||||
 | 
			
		||||
[link_checker]
 | 
			
		||||
skip_prefixes = [
 | 
			
		||||
 
 | 
			
		||||
@@ -112,7 +112,7 @@ command doesn't require to be logged in, it can also upload via a
 | 
			
		||||
A source id can be given in the config file, then there are no
 | 
			
		||||
additional options required. The simplest form is this:
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc upload *.pdf
 | 
			
		||||
File already in Docspell: article-velo.pdf
 | 
			
		||||
Adding to request: test-ocr.pdf
 | 
			
		||||
@@ -142,7 +142,7 @@ in a separate request, so the `--single-item` option cannot be used.
 | 
			
		||||
There are options to exclude/include files based on a [glob
 | 
			
		||||
pattern](https://docs.rs/glob/0.3.0/glob/struct.Pattern.html).
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc upload --traverse .
 | 
			
		||||
File already in Docspell: article-velo.pdf
 | 
			
		||||
File already in Docspell: demo/dirc/scan.21-03-12.15-50-54.pdf
 | 
			
		||||
@@ -175,7 +175,7 @@ It detects file creations and skips a rename within a watched folder.
 | 
			
		||||
The flag `-r` or `--recursive` is required to recursively watch a
 | 
			
		||||
directory.
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc watch -r .
 | 
			
		||||
Watching directory (Recursive): .
 | 
			
		||||
Press Ctrl-C to quit.
 | 
			
		||||
@@ -204,7 +204,7 @@ query. It is possible to download them all flat into some directory or
 | 
			
		||||
directly into a zip file. For example, download all files that are
 | 
			
		||||
tagged with `todo` into a zip file:
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc download --zip 'tag:todo'
 | 
			
		||||
Zipping 2 attachments into docspell-files.zip
 | 
			
		||||
Downloading DOC-20191223-155707.jpg.pdf …
 | 
			
		||||
@@ -214,7 +214,7 @@ Downloading DOC-20200803-174448.jpg.pdf …
 | 
			
		||||
It downloads the converted PDF files by default, which can be changed
 | 
			
		||||
via some options.
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc download --zip --original 'tag:todo'
 | 
			
		||||
Zipping original files of 2 attachments into docspell-files.zip
 | 
			
		||||
Downloading DOC-20191223-155707.jpg …
 | 
			
		||||
@@ -296,7 +296,7 @@ into recursive paths (as shown in the example output above) using the
 | 
			
		||||
resulting in `Finance-Institute`.
 | 
			
		||||
 | 
			
		||||
Example run (producing output shown above):
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc export --all --date-links --folder-links --folder-delimiter "/" --tag-links --target exports
 | 
			
		||||
Exported item: test3.zip
 | 
			
		||||
Exported item: README.md
 | 
			
		||||
@@ -329,7 +329,7 @@ config file or as an argument.
 | 
			
		||||
 | 
			
		||||
### Reset user password
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc admin reset-password --account demo
 | 
			
		||||
┌─────────┬──────────────┬──────────────────┐
 | 
			
		||||
│ success │ new password │ message          │
 | 
			
		||||
@@ -340,7 +340,7 @@ config file or as an argument.
 | 
			
		||||
 | 
			
		||||
### Recreate fulltext index
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc admin --admin-secret admin123 recreate-index
 | 
			
		||||
┌─────────┬─────────────────────────────────────┐
 | 
			
		||||
│ success │ message                             │
 | 
			
		||||
@@ -350,7 +350,7 @@ config file or as an argument.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Convert all files to PDF
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc admin --admin-secret admin123 convert-all-pdf
 | 
			
		||||
┌─────────┬─────────────────────────────────┐
 | 
			
		||||
│ success │ message                         │
 | 
			
		||||
@@ -364,7 +364,7 @@ enabling it now.
 | 
			
		||||
 | 
			
		||||
### Regenerate preview images
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc admin --admin-secret admin123 convert-all-pdf
 | 
			
		||||
┌─────────┬───────────────────────────────────────┐
 | 
			
		||||
│ success │ message                               │
 | 
			
		||||
@@ -382,7 +382,7 @@ config.
 | 
			
		||||
The `search` command takes a [query](@/docs/query/_index.md) and
 | 
			
		||||
prints the results.
 | 
			
		||||
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc search 'corr:*'
 | 
			
		||||
┌──────────┬────────────────────────────┬───────────┬────────────┬─────┬───────────────────────────┬───────────────┬────────┬─────────────┬────────────┬───────┐
 | 
			
		||||
│ id       │ name                       │ state     │ date       │ due │ correspondent             │ concerning    │ folder │ tags        │ fields     │ files │
 | 
			
		||||
@@ -399,7 +399,7 @@ prints the results.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
The same can be formatted as json and, for example, only print the ids:
 | 
			
		||||
``` shell
 | 
			
		||||
```
 | 
			
		||||
❯ dsc -f json search 'corr:*' | jq '.groups[].items[].id'
 | 
			
		||||
"HVK7JuCFt4W-qxkcwq1cWCV-dvpGo4DpZzU-Q16Xoujojas"
 | 
			
		||||
"3odNawKE1Ek-YJrWfPzekAq-47cjt14sexd-GK35JAEAanx"
 | 
			
		||||
 
 | 
			
		||||
@@ -4,10 +4,11 @@
 | 
			
		||||
        {% include "meta.html" %}
 | 
			
		||||
        <title>Docspell – Simple document organizer</title>
 | 
			
		||||
        <link rel="stylesheet" href="styles.css">
 | 
			
		||||
        <script type="application/javascript" src="js/bundle.js"></script>
 | 
			
		||||
        <script type="text/javascript" src="{{ get_url(path="/js/bundle.js") }}"></script>
 | 
			
		||||
    </head>
 | 
			
		||||
    <body id="app">
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
        <script type="application/javascript">
 | 
			
		||||
         var elmFlags = {
 | 
			
		||||
             "version": "{{ config.extra.version }}"
 | 
			
		||||
@@ -17,6 +18,7 @@
 | 
			
		||||
             flags: elmFlags
 | 
			
		||||
         });
 | 
			
		||||
        </script>
 | 
			
		||||
 | 
			
		||||
        {% include "fathom.html" %}
 | 
			
		||||
    </body>
 | 
			
		||||
</html>
 | 
			
		||||
 
 | 
			
		||||
@@ -4,7 +4,6 @@
 | 
			
		||||
        {% include "meta.html" %}
 | 
			
		||||
        <title>{{ section.title }} – Docspell Documentation</title>
 | 
			
		||||
        <link rel="stylesheet" href="/styles.css">
 | 
			
		||||
        {% include "search-head.html" %}
 | 
			
		||||
    </head>
 | 
			
		||||
    <body>
 | 
			
		||||
        <section class="hero is-info is-small">
 | 
			
		||||
@@ -63,6 +62,7 @@
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
        {% include "footer.html" %}
 | 
			
		||||
        {% include "search-head.html" %}
 | 
			
		||||
        {% include "search-part.html" %}
 | 
			
		||||
        {% include "fathom.html" %}
 | 
			
		||||
    </body>
 | 
			
		||||
 
 | 
			
		||||
@@ -4,7 +4,6 @@
 | 
			
		||||
        {% include "meta.html" %}
 | 
			
		||||
        <title>{{ page.title }} – Docspell Documentation</title>
 | 
			
		||||
        <link rel="stylesheet" href="/styles.css">
 | 
			
		||||
        {% include "search-head.html" %}
 | 
			
		||||
    </head>
 | 
			
		||||
    <body>
 | 
			
		||||
        <section class="hero is-info is-small">
 | 
			
		||||
@@ -98,6 +97,7 @@
 | 
			
		||||
        </section>
 | 
			
		||||
 | 
			
		||||
        {% include "footer.html" %}
 | 
			
		||||
        {% include "search-head.html" %}
 | 
			
		||||
        {% include "search-part.html" %}
 | 
			
		||||
        {% include "fathom.html" %}
 | 
			
		||||
    </body>
 | 
			
		||||
 
 | 
			
		||||
@@ -4,7 +4,6 @@
 | 
			
		||||
        {% include "meta.html" %}
 | 
			
		||||
        <title>{{ section.title }} – Docspell Documentation</title>
 | 
			
		||||
        <link rel="stylesheet" href="/styles.css">
 | 
			
		||||
        {% include "search-head.html" %}
 | 
			
		||||
    </head>
 | 
			
		||||
    <body>
 | 
			
		||||
        <section class="hero is-info is-small">
 | 
			
		||||
@@ -71,6 +70,8 @@
 | 
			
		||||
        </div>
 | 
			
		||||
 | 
			
		||||
        {% include "footer.html" %}
 | 
			
		||||
 | 
			
		||||
        {% include "search-head.html" %}
 | 
			
		||||
        {% include "search-part.html" %}
 | 
			
		||||
        {% include "fathom.html" %}
 | 
			
		||||
    </body>
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
<script type="application/javascript" src="/search_index.en.js"></script>
 | 
			
		||||
<script type="application/javascript" src="/elasticlunr.min.js"></script>
 | 
			
		||||
<script type="application/javascript" src="/js/bundle.js"></script>
 | 
			
		||||
<script type="application/javascript" src="/js/searchhelper.js"></script>
 | 
			
		||||
<script type="text/javascript" src="{{ get_url(path="elasticlunr.min.js") }}"></script>
 | 
			
		||||
<script type="text/javascript" src="{{ get_url(path="search_index.en.js") }}"></script>
 | 
			
		||||
<script type="text/javascript" src="{{ get_url(path="/js/searchhelper.js") }}"></script>
 | 
			
		||||
<script type="text/javascript" src="{{ get_url(path="/js/bundle.js") }}"></script>
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user