Deployed a10404c to 3.0 with MkDocs 1.5.2 and mike 1.1.2

papermerge · Jan 21, 2024 · 21bc358 · 21bc358
1 parent ec2675c
commit 21bc358
Show file tree

Hide file tree

Showing 6 changed files with 192 additions and 153 deletions.
diff --git a/3.0/search/search_index.json b/3.0/search/search_index.json
diff --git a/3.0/setup/add-ocr-langs/index.html b/3.0/setup/add-ocr-langs/index.html
@@ -1228,7 +1228,7 @@ <h1 id="add-ocr-languages">Add OCR Languages</h1>
 <p>By default the Papermerge Docker image includes English, German, French, Italian, Spanish, Romanian and Portugues OCR languages.</p>
 <p>You can install extra languages by creating a new docker image from base <code>papermerge/papermerge</code>.</p>
 <p>Create new docker file with following content:</p>
-<pre><code>FROM papermerge/papermerge:3.0.1
+<pre><code>FROM papermerge/papermerge:3.0.2
 
 # add Danish and Polish OCR languages
 RUN apt install tesseract-ocr-dan tesseract-ocr-pol

diff --git a/3.0/setup/docker-compose/index.html b/3.0/setup/docker-compose/index.html
@@ -1339,11 +1339,11 @@ <h2 id="web-app-worker">Web App + Worker</h2>
 <pre><code class="language-yaml">  version: &quot;3.9&quot;
 
   x-backend: &amp;common
-    image: papermerge/papermerge:3.0.1
+    image: papermerge/papermerge:3.0.2
     environment:
         PAPERMERGE__SECURITY__SECRET_KEY: 12345
-        PAPERMERGE__AUTH__USERNAME: john
-        PAPERMERGE__AUTH__PASSWORD: hohoho
+        PAPERMERGE__AUTH__USERNAME: admin
+        PAPERMERGE__AUTH__PASSWORD: admin
         PAPERMERGE__REDIS__URL: redis://redis:6379/0
     volumes:
         - data:/db
@@ -1365,6 +1365,7 @@ <h2 id="web-app-worker">Web App + Worker</h2>
     data:
     index_db:
     media:
+
 </code></pre>
 <p>You can access Papermerge user interface using any modern web browser (e.g. Firefox, Chrome).
 Open your web browser and point it to http://localhost:12000.</p>
@@ -1374,13 +1375,13 @@ <h2 id="postgresql">PostgreSQL</h2>
 <pre><code class="language-yaml">  version: &quot;3.9&quot;
 
   x-backend: &amp;common
-    image: papermerge/papermerge:3.0.1
+    image: papermerge/papermerge:3.0.2
     environment:
-        PAPERMERGE__SECURITY__SECRET_KEY: 12345
-        PAPERMERGE__AUTH__USERNAME: john
-        PAPERMERGE__AUTH__PASSWORD: hohoho
-        PAPERMERGE__DATABASE__URL: postgresql://scott:tiger@db:5432/mydatabase
-        PAPERMERGE__REDIS__URL: redis://redis:6379/0
+      PAPERMERGE__SECURITY__SECRET_KEY: 12345
+      PAPERMERGE__AUTH__USERNAME: admin
+      PAPERMERGE__AUTH__PASSWORD: admin
+      PAPERMERGE__DATABASE__URL: postgresql://coco:kesha@db:5432/cocodb
+      PAPERMERGE__REDIS__URL: redis://redis:6379/0
     volumes:
       - index_db:/core_app/index_db
       - media:/core_app/media
@@ -1390,21 +1391,29 @@ <h2 id="postgresql">PostgreSQL</h2>
       ports:
        - &quot;12000:80&quot;
       depends_on:
-        - redis
-        - db
+        db:
+          condition: service_healthy
+        redis:
+          condition: service_healthy
     worker:
       &lt;&lt;: *common
       command: worker
     redis:
       image: redis:6
     db:
-      image: bitnami/postgresql:14.4.0
+      image: postgres:16.1
       volumes:
         - postgres_data:/var/lib/postgresql/data/
       environment:
-        POSTGRES_USER: scott
-        POSTGRES_PASSWORD: tiger
-        POSTGRES_DB: mydatabase
+        POSTGRES_PASSWORD: kesha
+        POSTGRES_DB: cocodb
+        POSTGRES_USER: coco
+      healthcheck:
+        test: pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB
+        interval: 5s
+        timeout: 10s
+        retries: 5
+        start_period: 10s
   volumes:
     postgres_data:
     index_db:
@@ -1413,109 +1422,139 @@ <h2 id="postgresql">PostgreSQL</h2>
 <h2 id="solr">Solr</h2>
 <p>By default Papermerge uses Xapian search engine. However, for
 production environments, full fledged search engine like Solr is recommanded.</p>
-<pre><code class="language-yaml">version: &quot;3.9&quot;
-
-x-backend: &amp;common
-  image: papermerge/papermerge:3.0.1
-  environment:
-    PAPERMERGE__SECURITY__SECRET_KEY: 12345
-    PAPERMERGE__AUTH__USERNAME: john
-    PAPERMERGE__AUTH__PASSWORD: hohoho
-    PAPERMERGE__DATABASE__URL: postgresql://scott:tiger@db:5432/mydatabase
-    PAPERMERGE__REDIS__URL: redis://redis:6379/0
-    PAPERMERGE__SEARCH__URL: solr://solr:8983/pmg-index
-  volumes:
-    - media:/core_app/media
+<pre><code class="language-yaml">  version: &quot;3.9&quot;
 
-services:
-  web:
-    &lt;&lt;: *common
-    ports:
-     - &quot;12000:80&quot;
-    depends_on:
-      - redis
-      - db
-      - solr
-  worker:
-    &lt;&lt;: *common
-    command: worker
-  redis:
-    image: redis:6
-  db:
-    image: bitnami/postgresql:14.4.0
-    volumes:
-      - postgres_data:/var/lib/postgresql/data/
+  x-backend: &amp;common
+    image: papermerge/papermerge:3.0.2
     environment:
-      POSTGRES_USER: scott
-      POSTGRES_PASSWORD: tiger
-      POSTGRES_DB: mydatabase
-  solr:
-    image: solr:9.3
-    ports:
-     - &quot;8983:8983&quot;
+      PAPERMERGE__SECURITY__SECRET_KEY: 1234  # top secret
+      PAPERMERGE__AUTH__USERNAME: admin
+      PAPERMERGE__AUTH__PASSWORD: admin
+      PAPERMERGE__DATABASE__URL: postgresql://coco:kesha@db:5432/cocodb
+      PAPERMERGE__REDIS__URL: redis://redis:6379/0
+      PAPERMERGE__SEARCH__URL: solr://solr:8983/pmg-index
     volumes:
-      - solr_data:/var/solr
-    command:
-      - solr-precreate
-      - pmg-index
-
-volumes:
-  postgres_data:
-  solr_data:
-  media:
+      - media_root:/core_app/media
+    depends_on:
+      db:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+
+  services:
+    web:
+      &lt;&lt;: *common
+      ports:
+       - &quot;12000:80&quot;
+    worker:
+      &lt;&lt;: *common
+      command: worker
+    redis:
+      image: redis:6
+      healthcheck:
+        test: redis-cli --raw incr ping
+        interval: 5s
+        timeout: 10s
+        retries: 5
+        start_period: 10s
+    solr:
+      image: solr:9.3
+      ports:
+       - &quot;8983:8983&quot;
+      volumes:
+        - solr_data:/var/solr
+      command:
+        - solr-precreate
+        - pmg-index
+    db:
+      image: postgres:16.1
+      volumes:
+        - postgres_data:/var/lib/postgresql/data/
+      environment:
+        POSTGRES_PASSWORD: kesha
+        POSTGRES_DB: cocodb
+        POSTGRES_USER: coco
+
+      healthcheck:
+        test: pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB
+        interval: 5s
+        timeout: 10s
+        retries: 5
+        start_period: 10s
+
+  volumes:
+    postgres_data:
+    solr_data:
+    media_root:
 </code></pre>
 <h2 id="mysql-mariadb">MySQL / MariaDB</h2>
 <p>Here is an example of docker compose setup with MariaDB:</p>
-<pre><code class="language-yaml">version: &quot;3.9&quot;
+<pre><code class="language-yaml">  version: &quot;3.9&quot;
 
-x-backend: &amp;common
-  image: papermerge/papermerge:3.0.1
-  environment:
+  x-backend: &amp;common
+    image: papermerge/papermerge:3.0.2
+    environment:
       PAPERMERGE__SECURITY__SECRET_KEY: 1234  # top secret
-      PAPERMERGE__AUTH__USERNAME: eugen
-      PAPERMERGE__AUTH__PASSWORD: 1234
-      PAPERMERGE__DATABASE__URL: mysql://myuser:mypass@db:3306/paperdb
+      PAPERMERGE__AUTH__USERNAME: admin
+      PAPERMERGE__AUTH__PASSWORD: admin
+      PAPERMERGE__DATABASE__URL: mysql://coco:kesha@db:3306/cocodb
       PAPERMERGE__REDIS__URL: redis://redis:6379/0
       PAPERMERGE__SEARCH__URL: solr://solr:8983/pmg-index
-  volumes:
-    - media_root:/core_app/media
-  depends_on:
-    - redis
-    - solr
-    - db
-
-services:
-  web:
-    &lt;&lt;: *common
-    ports:
-     - &quot;11000:80&quot;
-  worker:
-    &lt;&lt;: *common
-    command: worker
-  redis:
-    image: redis:6
-  solr:
-    image: solr:9.3
-    ports:
-     - &quot;8983:8983&quot;
     volumes:
-      - solr_data:/var/solr
-    command:
-      - solr-precreate
-      - pmg-index
-  db:
-    image: mariadb:11.2
-    volumes:
-      - maria:/var/lib/mysql
-    environment:
-      MYSQL_ROOT_PASSWORD: mypass
-      MYSQL_DATABASE: paperdb
-      MYSQL_USER: myuser
-      MYSQL_PASSWORD: mypass
-volumes:
-  maria:
-  solr_data:
-  media_root:
+      - media_root:/core_app/media
+    depends_on:
+      db:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+
+  services:
+    web:
+      &lt;&lt;: *common
+      ports:
+       - &quot;12000:80&quot;
+    worker:
+      &lt;&lt;: *common
+      command: worker
+    redis:
+      image: redis:6
+      healthcheck:
+        test: redis-cli --raw incr ping
+        interval: 5s
+        timeout: 10s
+        retries: 5
+        start_period: 10s
+    solr:
+      image: solr:9.3
+      ports:
+       - &quot;8983:8983&quot;
+      volumes:
+        - solr_data:/var/solr
+      command:
+        - solr-precreate
+        - pmg-index
+    db:
+      image: mariadb:11.2
+      volumes:
+        - maria:/var/lib/mysql
+      environment:
+        MYSQL_ROOT_PASSWORD: kesha
+        MYSQL_DATABASE: cocodb
+        MYSQL_USER: coco
+        MYSQL_PASSWORD: kesha
+      ports:
+        - &quot;3306:3306&quot;
+      healthcheck:
+        test: mariadb-admin ping -h 127.0.0.1 -u $$MYSQL_USER --password=$$MYSQL_PASSWORD
+        interval: 5s
+        timeout: 10s
+        retries: 5
+        start_period: 10s
+
+  volumes:
+    postgres_data:
+    solr_data:
+    media_root:
 </code></pre>
 <h2 id="oauth-20">OAuth 2.0</h2>
 <p>...</p>

diff --git a/3.0/setup/docker/index.html b/3.0/setup/docker/index.html
@@ -1323,17 +1323,17 @@ <h2 id="web-app">Web App</h2>
 <p>The only two required environment variables are
 <code>PAPERMERGE__SECURITY__SECRET_KEY</code> and <code>PAPERMERGE__AUTH__PASSWORD</code>. To start
 web ui part use following command:</p>
-<pre><code class="language-console">docker run -p 9400:80 \
+<pre><code class="language-console">docker run -p 12000:80 \
     -e PAPERMERGE__SECURITY__SECRET_KEY=abc \
-    -e PAPERMERGE__AUTH__PASSWORD=123 \
-    papermerge/papermerge:3.0.1
+    -e PAPERMERGE__AUTH__PASSWORD=admin \
+    papermerge/papermerge:3.0.2
 </code></pre>
-<p>Point your web browser to <code>http://localhost:9400</code> and you will see login screen:</p>
+<p>Point your web browser to <code>http://localhost:12000</code> and you will see login screen:</p>
 <p><img alt="login screen" src="../../img/setup/login.png" /></p>
 <p>Credentials are:</p>
 <ul>
 <li>username <code>admin</code></li>
-<li>password <code>123</code></li>
+<li>password <code>admin</code></li>
 </ul>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -1345,7 +1345,7 @@ <h2 id="official-docker-image">Official Docker Image</h2>
 <h2 id="get-docker-image">Get Docker Image</h2>
 <p>The recommended way to get the Papermerge docker image is via
 docker pull command:</p>
-<pre><code class="language-console">docker pull papermerge/papermerge:3.0.1
+<pre><code class="language-console">docker pull papermerge/papermerge:3.0.2
 </code></pre>
 <h2 id="web-app-worker">Web App + Worker</h2>
 <p>For complete setup you need to start one or multiple workers.
@@ -1354,11 +1354,11 @@ <h2 id="web-app-worker">Web App + Worker</h2>
 <pre><code>  version: &quot;3.9&quot;
 
   x-backend: &amp;common
-    image: papermerge/papermerge:3.0.1
+    image: papermerge/papermerge:3.0.2
     environment:
         PAPERMERGE__SECURITY__SECRET_KEY: 12345
-        PAPERMERGE__AUTH__USERNAME: john
-        PAPERMERGE__AUTH__PASSWORD: hohoho
+        PAPERMERGE__AUTH__USERNAME: admin
+        PAPERMERGE__AUTH__PASSWORD: admin
         PAPERMERGE__REDIS__URL: redis://redis:6379/0
     volumes:
         - data:/db