From 50ba88231f3b3d1ed3794b91191733ed54383438 Mon Sep 17 00:00:00 2001 From: jonaswinkler Date: Tue, 12 Jan 2021 00:29:05 +0100 Subject: [PATCH] documentation --- docs/administration.rst | 5 ++--- docs/setup.rst | 17 +++++++---------- docs/usage_overview.rst | 2 +- 3 files changed, 10 insertions(+), 14 deletions(-) diff --git a/docs/administration.rst b/docs/administration.rst index c3d1d07a6..80f57d849 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -48,9 +48,6 @@ Options available to bare-metal and non-docker installations: Restoring ========= - - - .. _administration-updating: Updating Paperless @@ -84,9 +81,11 @@ B. If you built the image yourself, do the following: .. code:: shell-session $ git pull + $ ./compile-frontend.sh $ docker-compose build $ docker-compose up +Running `docker-compose up` will also apply any new database migrations. If you see everything working, you can start paperless-ng with "-d" to have it run in the background. diff --git a/docs/setup.rst b/docs/setup.rst index 48569a04c..1e46608ae 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -97,9 +97,10 @@ run the above mentioned components yourself. Install Paperless from Docker Hub ================================= -1. Go to the `project page `_ +1. Go to the `/docker/hub directory on the project page `_ and download one of the ``docker-compose.*.yml`` files, depending on which database backend you - want to use. Download the ``docker-compose.env`` file and the ``.env`` file as well and store them + want to use. Rename this file to `docker-compose.yml`. + Download the ``docker-compose.env`` file and the ``.env`` file as well and store them in the same directory. .. hint:: @@ -124,7 +125,6 @@ Install Paperless from Docker Hub .. _Docker installation guide: https://docs.docker.com/engine/installation/ .. _docker-compose installation guide: https://docs.docker.com/compose/install/ - 3. Modify ``docker-compose.yml`` to your preferences. You may want to change the path to the consumption directory in this file. Find the line that specifies where to mount the consumption directory: @@ -201,7 +201,9 @@ Build the docker image yourself depending on which database backend you want to use. Copy ``docker-compose.env.example`` to ``docker-compose.env``. -3. Follow steps 2 to 7 of :ref:`setup-docker_hub`. When asked to run +3. Run the `compile-frontend.sh` script. This requires `node` and `npm`. + +4. Follow steps 2 to 7 of :ref:`setup-docker_hub`. When asked to run ``docker-compose up -d`` to start the containers, do .. code:: shell-session @@ -422,12 +424,7 @@ Migration to paperless-ng is then performed in a few simple steps: 5. Adjust ``docker-compose.yml`` and ``docker-compose.env`` to your needs. See :ref:`setup-docker_hub` for details on which edits are advised. -6. Since ``docker-compose`` would just use the the old paperless image, we need to - manually build a new image: - - .. code:: shell-session - - $ docker-compose build +6. :ref:`Update paperless. ` 7. In order to find your existing documents with the new search feature, you need to invoke a one-time operation that will create the search index: diff --git a/docs/usage_overview.rst b/docs/usage_overview.rst index 7a4fd7740..6c34b2823 100644 --- a/docs/usage_overview.rst +++ b/docs/usage_overview.rst @@ -118,7 +118,7 @@ to share any documents with paperless. This can be combined with any of the mobi scanning apps out there, such as Office Lens. Furthermore, there is the `Paperless App `_ as well, -which no only has document upload, but also document editing and browsing. +which not only has document upload, but also document browsing and download features. .. _usage-email: