Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
compgeniuses committed Jan 19, 2024
1 parent 21b4adc commit a1bda59
Showing 1 changed file with 11 additions and 17 deletions.
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ns8-paperless ngx
Paperless-ngx is a community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.
# n8n
n8n allows you to build flexible workflows focused on deep data integration

## Install

Expand All @@ -14,11 +14,11 @@ Output example:

## Configure

Let's assume that the paperless instance is named `n8n1`.
Let's assume that the n8n instance is named `n8n1`.

Launch `configure-module`, by setting the following parameters:

- `PAPERLESS_ADMIN_PASSWORD`: Define the Default password Set to = P@perle5$

- `lets_encrypt`: Set LEtsecnrypt to True or False, Default is FALSE
- `http2https`: set redirect to True or False, Default is True
- `host`: the traefik host url for the project
Expand All @@ -31,10 +31,10 @@ Example:

or if modifying another value:

api-cli run module/n8n5/configure-module --data '{"host": "n8n.domain.com","n8n_name": "Myn8n NGX"}'
api-cli run module/n8n5/configure-module --data '{"host": "n8n.domain.com","n8n_name": "Myn8n"}'

api-cli run module/n8n1/configure-module --data '{
"host": "n8n.rocky9-pve2.org",
"host": "n8n.host.org",
"lets_encrypt": false,
"http2https": true,
}'
Expand All @@ -45,11 +45,9 @@ The above command will:
- (describe configuration process)
- ...

Additional Parameters are Described here:
https://docs.paperless-ngx.com/configuration/#hosting-security
WHile they have not been Implemented, if you require more parameters to be defined, kindly free to raise an issue, and define why and how that parameter should be implemented for use

Send a test HTTP request to the ns8-paperless-ngx backend service:

Send a test HTTP request to the ns8-n8n backend service:

curl http://127.0.0.1/n8n/

Expand All @@ -63,11 +61,11 @@ setup](https://nethserver.github.io/ns8-core/core/smarthost/) every time
kickstart starts, the command `bin/discover-smarthost` runs and refreshes
the `state/smarthost.env` file with fresh values from Redis.

Furthermore if smarthost setup is changed when ns8-paperless-ngx is already
Furthermore if smarthost setup is changed when ns8-n8n-ngx is already
running, the event handler `events/smarthost-changed/10reload_services`
restarts the main module service.

See also the `systemd/user/paperless-server.service` file.
See also the `systemd/user/n8n-server.service` file.

This setting discovery is just an example to understand how the module is
expected to work: it can be rewritten or discarded completely.
Expand All @@ -83,7 +81,7 @@ To uninstall the instance:
Test the module using the `test-module.sh` script:


./test-module.sh <NODE_ADDR> ghcr.io/nethserver/ns8-paperless-ngx:latest
./test-module.sh <NODE_ADDR> ghcr.io/compgeniuses/n8n:latest

The tests are made using [Robot Framework](https://robotframework.org/)

Expand All @@ -97,8 +95,4 @@ To setup the translation process:
- add your repository to [hosted.weblate.org]((https://hosted.weblate.org) or ask a NethServer developer to add it to ns8 Weblate project

## To Do
[Optional Services:](https://docs.paperless-ngx.com/configuration/#optional-services)
- Understand and Implement [Apache Tika](https://tika.apache.org/) to your repository
- Understand and Implement Docker [gotenberg](https://gotenberg.dev/) to your repository

Paperless can make use of Tika and Gotenberg for parsing and converting "Office" documents (such as ".doc", ".xlsx" and ".odt"). Tika and Gotenberg are also needed to allow parsing of E-Mails (.eml).

0 comments on commit a1bda59

Please sign in to comment.