Version 2.1 as mkdocs (#33)

Author: ciur

docs/img/setup/01-active-venv.png

@@ -1,5 +1,6 @@
 # Backup
 
+
 For peace of mind you always need to backup data. There three aspects of full backup:
 
 * media directory
@@ -23,16 +24,16 @@ named "media" in of same directory where papermerge project was cloned.
 
 !!! note
 
-    `media_dir` has two subfolders *docs* and *results*. :ref:`media_dir`/docs is place where
+    `media_dir` has two subfolders *docs* and *results*. `media_dir`/docs is place where
     original documents are uploaded - it is the location you want to ensure is regularly backed up.
-    Media directory configuration is pure Django webframework thing; in Django it is called [MEDIA_ROOT](https://docs.djangoproject.com/en/3.1/ref/settings/#media-root)
+    Media directory configuration is pure Django web framework thing; in Django it is called <a href="https://docs.djangoproject.com/en/3.1/ref/settings/#media-root" class="external-link" target="_blank">MEDIA_ROOT </a>
 
 !!! note
 
     **Papermerge never overwrites or renames original uploads!**, in that sense, Papermerge is non-destructive :ref:`dms`. Every time you perform changes on document, like :ref:`moving pages around <page_management>` a new document version is created, thus keeping original document version intact.
 
 
-## Database
+### Database
 
 Another important part of whole backup picture - is backing up your Papermerge database. In database, Papermerge stores information like user related information, documents' metadata, documents' tags etc.
 
@@ -44,14 +45,14 @@ Another important part of whole backup picture - is backing up your Papermerge d
 Basically with database backup you can restore "the state" of Papermerge application.
 
 
-## Application Version
+### Application Version
 
 If you want to restore Papermerge backups you need to know for what
 application version that backup is. This is why it is a good idea to append
 Papermerge application version to your backup archives.
 
 
-## Backup Utility
+### Backup Utility
 
 Papermerge is shipped with backup command line utility. You can run it from project current directory:
 
@@ -65,8 +66,9 @@ That command will backup all your documents with preserved directory structure (
 
     provided backup utility does not backup tags and metadata information.
 
+
 In order to restore backup:
 
 ```console
 ./manage.py restore <path-to-tar-file>
-```
+```

docs/img/setup/02-login-screen.png

@@ -0,0 +1,114 @@
+# Docker Compose
+
+This section describes how to setup Papermerge and
+related services using docker compose.
+
+Each docker compose file is used here in combination with one `environment file` usually
+named `.env`.
+
+Make sure you have both `docker`.
+
+This guide was tested with docker version 20.10.6 and
+docker-compose version 1.29.2.
+
+
+## Complete Stack in 2 minutes
+
+
+This setup installs complete {{ extra.project }} stack with all required services.
+
+Save following `docker-compose.yml` file on your local computer.
+
+
+Next, create `.env` file with following content:
+
+```console
+  DB_USER=postgres
+  DB_NAME=postgres
+  DB_PASSWORD=postgres
+  DB_HOST=db
+  DB_PORT=5432
+
+  REDIS_HOST=redis
+  REDIS_PORT=6379
+
+  SECRET_KEY=12345abcdxyz
+
+  SUPERUSER_USERNAME=admin
+  [email protected]
+  SUPERUSER_PASSWORD=admin
+```
+
+Start {{ extra.project }} using following docker compose command:
+
+```console
+    docker compose -f docker-compose.yml --env-file .env up
+```
+
+You can access |project| user interface using a web browser like Firefox.
+Open your web browser and point it to http://localhost:16000 address:
+
+![papermerge login](../img/setup/papermerge-login.png)
+
+Sign in using credentials configured with ``SUPERUSER_USERNAME`` and
+``SUPERUSER_PASSWORD`` options in ``.env`` file.
+
+![papermerge example](../img/setup/papermerge-example.png)
+
+
+## Elastic Search
+
+In previous section, {{ extra.project }} used xapian built in search engine. However, for
+production environments, a full fledged search engine like Elasticsearch makes more sense.
+
+Here is setup which uses Elasticsearch:
+
+```yaml
+  version: '3.7'
+  x-backend: &common  # yaml anchor definition
+    image: papermerge/papermerge:2.1.9
+    volumes:
+      - media_root:/app/media
+    environment:
+      - PAPERMERGE__MAIN__SECRET_KEY=12345SKK
+      - DJANGO_SUPERUSER_PASSWORD=1234
+      - PAPERMERGE__REDIS__HOST=redis
+      - PAPERMERGE__REDIS__PORT=6379
+      - PAPERMERGE__DATABASE__TYPE=postgres
+      - PAPERMERGE__DATABASE__USER=postgres
+      - PAPERMERGE__DATABASE__NAME=postgres
+      - PAPERMERGE__DATABASE__PASSWORD=postgres
+      - PAPERMERGE__DATABASE__HOST=db
+      - PAPERMERGE__DATABASE__PORT=5432
+      - PAPERMERGE__SEARCH__ENGINE=elastic7
+      - PAPERMERGE__SEARCH__URL=http://es:9200
+  services:
+    backend:
+      <<: *common
+    worker:
+      <<: *common
+      command: worker
+    redis:
+      image: redis:6
+      ports:
+        - '6379:6379'
+    db:
+      image: postgres:14.4
+      volumes:
+        - postgres_data:/var/lib/postgresql/data/
+      environment:
+        - POSTGRES_USER=postgres
+        - POSTGRES_DB=postgres
+        - POSTGRES_PASSWORD=postgres
+    es:
+      image: docker.elastic.co/elasticsearch/elasticsearch:7.16.2
+      environment:
+        - discovery.type=single-node
+        - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+      ports:
+        - 9200:9200
+        - 9300:9300
+  volumes:
+    media_root:
+    postgres_data:
+```