From fe2aa2bbf391e057f84e2c1747f8ea618417b38d Mon Sep 17 00:00:00 2001 From: Simon Siebert Date: Tue, 15 Feb 2022 14:43:42 +0100 Subject: [PATCH 1/5] Update README.md (#11) Co-authored-by: Simon Siebert --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c51c6f24..2d25ed347 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Docker Hub Pulls](https://img.shields.io/docker/pulls/jonaswinkler/paperless-ng.svg)](https://hub.docker.com/r/jonaswinkler/paperless-ng) [![Coverage Status](https://coveralls.io/repos/github/jonaswinkler/paperless-ng/badge.svg?branch=master)](https://coveralls.io/github/jonaswinkler/paperless-ng?branch=master) -# Paperless-ng +# Paperless-ngx [Paperless (click me)](https://github.com/the-paperless-project/paperless) is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents. @@ -17,7 +17,17 @@ Paperless-ng is a fork of the original project, adding a new interface and many * Resource usage: Paperless-ng does use a bit more resources than Paperless. Running the web server requires about 300MB of RAM or more, depending on the configuration. While adding documents, it requires about 300MB additional RAM, depending on the document. It still runs on Raspberry Pi (many users do that), but it has been generally geared to better use the resources of more powerful systems. * API changes: If you rely on the REST API of paperless, some of its functionality has been changed. -For a detailed list of changes, have a look at the [change log](https://paperless-ng.readthedocs.io/en/latest/changelog.html) in the documentation, especially the section about the [0.9.0 release](https://paperless-ng.readthedocs.io/en/latest/changelog.html#paperless-ng-0-9-0). +For a detailed list of changes done in paperless-ng, have a look at the [change log](https://paperless-ng.readthedocs.io/en/latest/changelog.html) in the documentation, especially the section about the [0.9.0 release](https://paperless-ng.readthedocs.io/en/latest/changelog.html#paperless-ng-0-9-0). + +Paperless-ngx forked from paperless-ng to continue the great work already done and distribute responsibility among a team of people. + +Discussion around that can be found in the issues in the paperless-ng repository: +[1599](https://github.com/jonaswinkler/paperless-ng/issues/1599) +[1632](https://github.com/jonaswinkler/paperless-ng/issues/1632) +## Get in Touch + +People interested in continuing the work on paperless-ng(x) and form the organisation connected here on github and created a +[Matrix Room](https://matrix.to/#/#paperless:adnidor.de) for realtime communication. # How it Works From 41bdf1bcc92348980b290b9048241ca4134649a3 Mon Sep 17 00:00:00 2001 From: kpj Date: Thu, 17 Feb 2022 00:40:52 +0100 Subject: [PATCH 2/5] Rename script to paperless-ngx --- install-paperless-ng.sh => install-paperless-ngx.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename install-paperless-ng.sh => install-paperless-ngx.sh (100%) diff --git a/install-paperless-ng.sh b/install-paperless-ngx.sh similarity index 100% rename from install-paperless-ng.sh rename to install-paperless-ngx.sh From 95309ad4aed99e80413fe71ac508abb7cdf7e785 Mon Sep 17 00:00:00 2001 From: kpj Date: Thu, 17 Feb 2022 00:42:47 +0100 Subject: [PATCH 3/5] Use paperless-ngx in install script --- install-paperless-ngx.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/install-paperless-ngx.sh b/install-paperless-ngx.sh index a31c9203f..06f09a722 100755 --- a/install-paperless-ngx.sh +++ b/install-paperless-ngx.sh @@ -78,11 +78,11 @@ default_time_zone=$(timedatectl show -p Timezone --value) set -e echo "" -echo "############################################" -echo "### Paperless-ng docker installation ###" -echo "############################################" +echo "#############################################" +echo "### paperless-ngx docker installation ###" +echo "#############################################" echo "" -echo "This script will download, configure and start paperless-ng." +echo "This script will download, configure and start paperless-ngx." echo "" echo "1. Folder configuration" @@ -94,7 +94,7 @@ echo "You will need this folder whenever you want to start, stop, update or " echo "maintain your paperless instance." echo "" -ask "Target folder" "$(pwd)/paperless-ng" +ask "Target folder" "$(pwd)/paperless-ngx" TARGET_FOLDER=$ask_result echo "" @@ -277,8 +277,8 @@ if [[ $TIKA_ENABLED == "yes" ]] ; then DOCKER_COMPOSE_VERSION="$DOCKER_COMPOSE_VERSION-tika" fi -wget "https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml -wget "https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/docker/compose/.env" -O .env +wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/docker/compose/docker-compose.$DOCKER_COMPOSE_VERSION.yml" -O docker-compose.yml +wget "https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/docker/compose/.env" -O .env SECRET_KEY=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1) From e4859412bc5532537dfd1d334ca0f36e9ff6fb8a Mon Sep 17 00:00:00 2001 From: kpj Date: Thu, 17 Feb 2022 00:45:50 +0100 Subject: [PATCH 4/5] Update installation url in setup docs to new repo --- docs/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index 99c910cf2..a869bd1bf 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -116,7 +116,7 @@ performs all the steps described in :ref:`setup-docker_hub` automatically. .. code:: shell-session - $ curl -L https://raw.githubusercontent.com/jonaswinkler/paperless-ng/master/install-paperless-ng.sh | bash + $ curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ng.sh | bash .. _setup-docker_hub: From 51be0f07a5700d9250b9f6c49493dcf9a226c6b3 Mon Sep 17 00:00:00 2001 From: Kim Date: Thu, 17 Feb 2022 09:18:01 +0100 Subject: [PATCH 5/5] Use command substitution instead of piping in easy-install docs --- docs/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setup.rst b/docs/setup.rst index a869bd1bf..ee500c164 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -116,7 +116,7 @@ performs all the steps described in :ref:`setup-docker_hub` automatically. .. code:: shell-session - $ curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ng.sh | bash + $ bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/master/install-paperless-ng.sh)" .. _setup-docker_hub: