Update documentation

This commit is contained in:
Eike Kettner
2020-03-27 19:47:55 +01:00
parent f9d8016dc9
commit 75405dbcba
6 changed files with 46 additions and 28 deletions

View File

@ -78,7 +78,7 @@ The config file is expected in
`$XDG_CONFIG_HOME/docspell/ds.conf`. `$XDG_CONFIG_HOME` defaults to
`~/.config`.
The config file contains lines with key-value pairs, separated by an
The config file contains lines with key-value pairs, separated by a
`=` sign. Lines starting with `#` are ignored. Example:
```
@ -87,17 +87,21 @@ url.1 = http://localhost:7880/api/v1/open/upload/item/5DxhjkvWf9S-CkWqF3Kr892-Wg
url.2 = http://localhost:7880/api/v1/open/upload/item/6DxhjkvWf9S-CkWqF3Kr892-WgoCspFWDo7-XBykwCyAUxQ
```
The key must start with `url`.
The key must start with `url`. The urls should be [anonymous upload
urls](./uploading.html).
### Usage
The `-h` option shows a help overview.
- The `-c` option allows to specifiy a different config file.
- The `-h` option shows a help overview.
- The `-d` option deletes files after upload was successful
- The `-e` option can be used to check for file existence in docspell.
Instead of uploading, the script only checks whether the file is in
docspell or not.
The script takes a list of files as arguments. It checks the file
types and will raise an error (and quit) if a file is included that is
not a PDF. The `-s` option can be used to skip them instead.
The script takes a list of files as arguments.
The `-c` option allows to specifiy a different config file.
Example:
@ -121,8 +125,8 @@ and the web extension. Both work together.
#### Install `ds.sh`
First install the `ds.sh` tool somewhere, maybe `/usr/local/bin` as
described above.
First copy the `ds.sh` tool somewhere in your `PATH`, maybe
`/usr/local/bin` as described above.
#### Install the native part

View File

@ -6,11 +6,13 @@ title: Features and Limitations
# Features
- Multi-account application
- Multiple users per account
- Multiple users per account (multiple users can access the same
account)
- Handle multiple documents as one unit
- OCR using [tesseract](https://github.com/tesseract-ocr/tesseract)
- Conversion to PDF: all files are converted into a PDF file, while
the original file is preserved
- Conversion to PDF: all files are converted into a PDF file
- Non-destructive: all your uploaded files are never modified and can
always be downloaded untouched
- Text is analysed to find and attach meta data automatically
- Manage document processing (cancel jobs, set priorities)
- Everything available via a documented [REST Api](api)
@ -21,17 +23,19 @@ title: Features and Limitations
can be scaled-out independently
- Everything stored in a SQL database: PostgreSQL, MariaDB or H2
- Files supported:
- PDF
- common MS Office (doc, docx, xls, xlsx)
- OpenDocument (odt, ods)
- RichText (rtf)
- Images (jpg, png, tiff)
- HTML
- text/* (treated as Markdown)
- zip
- [eml](https://en.wikipedia.org/wiki/Email#Filename_extensions)
(e-mail files in plain text MIME)
- Tools:
- Documents:
- PDF
- common MS Office (doc, docx, xls, xlsx)
- OpenDocument (odt, ods)
- RichText (rtf)
- Images (jpg, png, tiff)
- HTML
- text/* (treated as Markdown)
- Archives (extracted automatically, can be nested)
- zip
- [eml](https://en.wikipedia.org/wiki/Email#Filename_extensions)
(e-mail files in plain text MIME)
- Tooling:
- Watch a folder: watch folders for changes and send files to docspell
- Firefox plugin: right click on a link and send the file to docspell
- Simple CLI for uploading files

View File

@ -4,7 +4,7 @@ title: Quickstart
permalink: getit/
---
## Download
## {{ page.title }}
You can download pre-compiled binaries from the [Release
Page](https://github.com/eikek/docspell/releases). There are `deb`

View File

@ -48,9 +48,6 @@ options:
- title: Tools
url: doc/tools.html
- title: Changelog
url : changelog
- title: Development
url: dev.html
@ -67,3 +64,6 @@ options:
- title: REST OpenApi Spec
url: openapi/docspell-openapi.yml
- title: Changelog
url : changelog