From 20a3060f66ba05a88c7ddd52a25dba403afe6319 Mon Sep 17 00:00:00 2001
From: Michele Cereda <cereda.michele@gmail.com>
Date: Mon, 5 Aug 2024 00:35:20 +0200
Subject: [PATCH] chore: add starting files for wallabag to the mix

---
 .vscode/settings.json                         |  1 +
 containers/wallabag/.gitignore                |  2 +
 .../wallabag/docker-compose.upstream.yml      | 59 ++++++++++++++
 knowledge base/self-hosting.md                |  2 +
 knowledge base/wallabag.md                    | 77 +++++++++++++++++++
 5 files changed, 141 insertions(+)
 create mode 100644 containers/wallabag/.gitignore
 create mode 100644 containers/wallabag/docker-compose.upstream.yml
 create mode 100644 knowledge base/wallabag.md

diff --git a/.vscode/settings.json b/.vscode/settings.json
index e006b09..084ed03 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -342,6 +342,7 @@
         "vaultwarden",
         "velero",
         "venv",
+        "wallabag",
         "wazuh",
         "whalebrew",
         "winget",
diff --git a/containers/wallabag/.gitignore b/containers/wallabag/.gitignore
new file mode 100644
index 0000000..939f913
--- /dev/null
+++ b/containers/wallabag/.gitignore
@@ -0,0 +1,2 @@
+/data/
+/images/
diff --git a/containers/wallabag/docker-compose.upstream.yml b/containers/wallabag/docker-compose.upstream.yml
new file mode 100644
index 0000000..52d1bed
--- /dev/null
+++ b/containers/wallabag/docker-compose.upstream.yml
@@ -0,0 +1,59 @@
+---
+services:
+  wallabag:
+    image: wallabag/wallabag
+    restart: unless-stopped
+    environment:
+      - MYSQL_ROOT_PASSWORD=wallaroot
+      - SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql
+      - SYMFONY__ENV__DATABASE_HOST=db
+      - SYMFONY__ENV__DATABASE_PORT=3306
+      - SYMFONY__ENV__DATABASE_NAME=wallabag
+      - SYMFONY__ENV__DATABASE_USER=wallabag
+      - SYMFONY__ENV__DATABASE_PASSWORD=wallapass
+      - SYMFONY__ENV__DATABASE_CHARSET=utf8mb4
+      - SYMFONY__ENV__DATABASE_TABLE_PREFIX="wallabag_"
+      - SYMFONY__ENV__MAILER_DSN=smtp://127.0.0.1
+      - SYMFONY__ENV__FROM_EMAIL=wallabag@example.com
+      - SYMFONY__ENV__DOMAIN_NAME=https://your-wallabag-instance.wallabag.org
+      - SYMFONY__ENV__SERVER_NAME="Your wallabag instance"
+    ports:
+      - "80"
+    volumes:
+      - /opt/wallabag/images:/var/www/wallabag/web/assets/images
+    healthcheck:
+      test:
+        - CMD
+        - wget
+        - --no-verbose
+        - --tries=1
+        - --spider
+        - http://localhost/api/info
+      interval: 1m
+      timeout: 3s
+    depends_on:
+      - db
+      - redis
+  db:
+    image: mariadb
+    restart: unless-stopped
+    environment:
+      - MYSQL_ROOT_PASSWORD=wallaroot
+    volumes:
+      - /opt/wallabag/data:/var/lib/mysql
+    healthcheck:
+      test:
+        - CMD
+        - mysqladmin
+        - ping
+        - -h
+        - localhost
+      interval: 20s
+      timeout: 3s
+  redis:
+    image: redis:alpine
+    restart: unless-stopped
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 20s
+      timeout: 3s
diff --git a/knowledge base/self-hosting.md b/knowledge base/self-hosting.md
index 00a1a8f..f331860 100644
--- a/knowledge base/self-hosting.md	
+++ b/knowledge base/self-hosting.md	
@@ -26,6 +26,7 @@ The _art_ of hosting and managing applications on one's own servers instead of c
 | [Semaphore]      | Task runner                | [AWX], [CTFreak], [Rundeck], [Zuul]       |
 | [Uptime Kuma]    | Status page                | [Gatus], [Statping-ng], [Vigil]           |
 | [Zuul]           | Task runner                | [AWX], [CTFreak], [Rundeck], [Semaphore]  |
+| [Wallabag]       | Web page saver             | Pocket                                    |
 
 ## Further readings
 
@@ -50,6 +51,7 @@ The _art_ of hosting and managing applications on one's own servers instead of c
 [photoprism]: photoprism.md
 [rundeck]: rundeck.md
 [uptime kuma]: uptime%20kuma.md
+[wallabag]: wallabag.md
 
 <!-- Others -->
 [awesome-selfhosted]: https://awesome-selfhosted.net/
diff --git a/knowledge base/wallabag.md b/knowledge base/wallabag.md
new file mode 100644
index 0000000..d7c4e54
--- /dev/null
+++ b/knowledge base/wallabag.md	
@@ -0,0 +1,77 @@
+# Wallabag
+
+TODO
+
+Intro
+
+<!-- Remove this line to uncomment if used
+## Table of contents <!-- omit in toc -->
+
+1. [TL;DR](#tldr)
+1. [Further readings](#further-readings)
+   1. [Sources](#sources)
+
+## TL;DR
+
+<details>
+  <summary>Setup</summary>
+
+```sh
+docker pull 'wallabag/wallabag'
+```
+
+</details>
+
+<details>
+  <summary>Usage</summary>
+
+```sh
+docker run -p '80:80' --name 'wallabag' -e 'SYMFONY__ENV__DOMAIN_NAME=http://localhost' 'wallabag/wallabag'
+docker run -p '80:80' --name 'wallabag' -e 'SYMFONY__ENV__DOMAIN_NAME=http://localhost' \
+  -v './data:/var/www/wallabag/data' -v './images:/var/www/wallabag/web/assets/images' \
+  'wallabag/wallabag'
+
+# DB upgrade migrations.
+# Only required for versions that need database migrations.
+docker exec -t 'wallabag' -- /var/www/wallabag/bin/console doctrine:migrations:migrate --env=prod --no-interaction
+```
+
+</details>
+
+<!-- Uncomment if used
+<details>
+  <summary>Real world use cases</summary>
+
+```sh
+```
+
+</details>
+-->
+
+## Further readings
+
+- [Website]
+- [Main repository]
+- [Documentation]
+
+### Sources
+
+- [Docker image]
+- [Docker image repository]
+
+<!--
+  Reference
+  ═╬═Time══
+  -->
+
+<!-- In-article sections -->
+<!-- Knowledge base -->
+<!-- Files -->
+<!-- Upstream -->
+[docker image]: https://hub.docker.com/r/wallabag/wallabag/
+[docker image repository]: https://github.com/wallabag/docker
+[documentation]: https://doc.wallabag.org/en/
+[main repository]: https://github.com/wallabag/wallabag
+[website]: https://wallabag.org/
+
+<!-- Others -->