Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

Commit

Permalink
Move docker-compose.env to docker-compose.env.example & adjust docs
Browse files Browse the repository at this point in the history
This file, like `docker-compose.yml`, should be edited by the user. To
avoid merge conflicts when pulling updates, the edited version should
not be committed to the repository.
  • Loading branch information
tikitu committed Feb 19, 2016
1 parent 147f8f7 commit 438b161
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ db.sqlite3
virtualenv
.vagrant
docker-compose.yml
docker-compose.env

# Used for development
scripts/import-for-development
Expand Down
File renamed without changes.
19 changes: 13 additions & 6 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,15 @@ Docker Method
.. _Docker installation guide: https://docs.docker.com/engine/installation/
.. _docker-compose installation guide: https://docs.docker.com/compose/install/

3. Create a copy of ``docker-compose.yml.example`` as ``docker-compose.yml``.
4. Modify ``docker-compose.env`` and adapt the following environment variables:
3. Create a copy of ``docker-compose.yml.example`` as ``docker-compose.yml`` and
a copy of ``docker-compose.env.example`` as ``docker-compose.env``. You'll be
editing both these files: taking a copy ensures that you can ``git pull`` to
receive updates without risking merge conflicts with your modified versions
of the configuration files.
4. Modify ``docker-compose.yml`` to your preferences, following the instructions
in comments in the file. The only change that is a hard requirement is to
specify where the consumption directory should mount.
5. Modify ``docker-compose.env`` and adapt the following environment variables:

``PAPERLESS_PASSPHRASE``
This is the passphrase Paperless uses to encrypt/decrypt the original
Expand Down Expand Up @@ -186,9 +193,9 @@ Docker Method
and thus the one of the consumption directory. Furthermore, you can change
the id of the default user as well using ``USERMAP_UID``.

5. Run ``docker-compose up -d``. This will create and start the necessary
6. Run ``docker-compose up -d``. This will create and start the necessary
containers.
6. To be able to login, you will need a super user. To create it, execute the
7. To be able to login, you will need a super user. To create it, execute the
following command:

.. code-block:: shell-session
Expand All @@ -197,11 +204,11 @@ Docker Method
This will prompt you to set a username (default ``paperless``), an optional
e-mail address and finally a password.
7. The default ``docker-compose.yml`` exports the webserver on your local port
8. The default ``docker-compose.yml`` exports the webserver on your local port
8000. If you haven't adapted this, you should now be able to visit your
`Paperless webserver`_ at ``http://127.0.0.1:8000``. You can login with the
user and password you just created.
8. Add files to consumption directory the way you prefer to. Following are two
9. Add files to consumption directory the way you prefer to. Following are two
possible options:

1. Mount the consumption directory to a local host path by modifying your
Expand Down

0 comments on commit 438b161

Please sign in to comment.