Update documentation and fix changelog wording

This commit is contained in:
Eike Kettner 2020-06-28 23:57:27 +02:00
parent 0b7fc66ab3
commit 7b922fec94
5 changed files with 42 additions and 31 deletions

View File

@ -2,7 +2,7 @@
## v0.8.0
*Soon*
*June 29, 2020*
- Adds the [full-text
search](https://docspell.org/doc/finding#full-text-search) feature
@ -13,13 +13,14 @@
search menu.
- Fixes column types for item date and due-date for MariaDB (see #158)
and adds an upper limit for due-dates (which is configurable).
- Fixes a bug when cancelling jobs where stuck jobs were only removed
from the queue, but their cancel routine was not called.
- Changes cancelling process-item jobs, the item will still be created
and not removed.
- Fixes a bug when cancelling jobs. Stuck jobs were only removed from
the queue, but their cancel routine was not called.
- Changes in cancelling process-item jobs: the item will still be
created and not removed.
- Fixes a bug where items could not be deleted if there were sent
mails attached.
- Fixes the openapi spec for the joex component.
- Fixes the openapi spec for the joex component. This made the
generated live documentation unusable.
- Changes to the `consumedir.sh` script:
- Allow to recursively watch or traverse directories
- Allow it to work with the integration endpoint. This allows using
@ -50,6 +51,7 @@
- The `ItemLight` result structure now can contain "highlighting"
information that is provided by the full-text search index.
## v0.7.0
*June 17, 2020*
@ -77,7 +79,7 @@
0.3.0), i.e. it doesn't search item notes anymore, which is now
possible with the *allNames* search field.
- Fixes a bug where a search term was not lower-cased but compared to
a lower-cased value.
a lower-cased value (see #147).
- Allow to change names of attachments.
- Document how to create a SMTP gateway to docspell and provide a
simple docker based setup. This is a SMTP server that delivers mails

View File

@ -9,15 +9,17 @@ permalink: dev/adr
Some early information about certain details can be found in a few
[ADR](https://adr.github.io/) that exist:
- [0001 Components](0001_components)
- [0002 Component Interaction](0002_component_interaction)
- [0003 Encryption](0003_encryption)
- [0004 ISO8601 vs Unix](0004_iso8601vsEpoch)
- [0005 Job Executor](0005_job-executor)
- [0006 More File Types](0006_more-file-types)
- [0007 Convert HTML](0007_convert_html_files)
- [0008 Convert Text](0008_convert_plain_text)
- [0009 Convert Office Files](0009_convert_office_docs)
- [0010 Convert Image Files](0010_convert_image_files)
- [0011 Extract Text](0011_extract_text)
- [0012 Periodic Tasks](0012_periodic_tasks)
- [0001 Components](adr/0001_components)
- [0002 Component Interaction](adr/0002_component_interaction)
- [0003 Encryption](adr/0003_encryption)
- [0004 ISO8601 vs Unix](adr/0004_iso8601vsEpoch)
- [0005 Job Executor](adr/0005_job-executor)
- [0006 More File Types](adr/0006_more-file-types)
- [0007 Convert HTML](adr/0007_convert_html_files)
- [0008 Convert Text](adr/0008_convert_plain_text)
- [0009 Convert Office Files](adr/0009_convert_office_docs)
- [0010 Convert Image Files](adr/0010_convert_image_files)
- [0011 Extract Text](adr/0011_extract_text)
- [0012 Periodic Tasks](adr/0012_periodic_tasks)
- [0013 Archive Files](adr/0013_archive_files)
- [0014 Full-Text Search](adr/0014_fulltext_search_engine)

View File

@ -1,9 +1,10 @@
---
layout: docs
title: Fulltext Search Engine
permalink: dev/adr/0014_fulltext_search_engine
---
# Choose a Fulltext Search Engine
# {{ page.title }}
It should be possible to search the contents of all documents.

View File

@ -134,6 +134,10 @@ details). Note that a collective can also re-index their data using a
similiar endpoint; but this is only deleting their data and doesn't do
a full re-index.
The solr index doesn't contain any new information, it can be
regenerated any time using the above REST call. Thus it doesn't need
to be backed up.
### Bind
The host and port the http server binds to. This applies to both

View File

@ -6,23 +6,21 @@ permalink: getit
# {{ page.title }}
You can download pre-compiled binaries from the [Release
Page](https://github.com/eikek/docspell/releases). There are `deb`
packages and generic zip files. Alternatively, docspell can be
installed via [nix](doc/nix) or docker (see below).
There are the following quick ways to get docspell to run on your
machine:
- [Download, Unpack, Run](#without-docker)
- [Download, Unpack, Run](#without-docker) You can download
pre-compiled binaries from the [Release
Page](https://github.com/eikek/docspell/releases). There are `deb`
packages and generic zip files.
- [With Docker](#with-docker)
- [NixOs Module](doc/nix#docspell-as-a-service-on-nixos)
Check the [early demo video](demo) to see the basic idea. Refer to the
Check the [demo videos](demo) to see the basic idea. Refer to the
[documentation](doc) for more information on how to use docspell.
## Without Docker
## Download, Unpack, Run
### Prerequisite
@ -97,9 +95,13 @@ available in the `/docker` folder.
some containers. You can define whatever you like. Please see the
[`consumedir.sh`](doc/tools/consumedir#docker) docs for additional
info.
4. Goto <http://localhost:7880>, signup and login. Create a folder
`./docs/<collective-name>` and place files in there for importing
them.
4. Goto <http://localhost:7880>, signup and login. When signing up,
you can choose the same name for collective and user. Then login
with this name and the password.
5. (Optional) Create a folder `./docs/<collective-name>` (the name you
chose for the collective at registration) and place files in there
for importing them.
The directory contains a file `docspell.conf` that you can
[modify](doc/configure) as needed.