Merge pull request #49 from TBosak/extensions

feat: Chrome extension support +

Author: TBosak

.dockerignore

@@ -35,3 +35,5 @@ truenas/
 # Build artifacts that shouldn't be in Docker
 dist/
 build/
+public/feeds
+configs/

.env.example

@@ -13,6 +13,17 @@ ENCRYPTION_KEY=your_encryption_key_here
 # Optional: Enable SSL (true/false)
 SSL=false
 
+# Optional: Server port (defaults to 5000)
+PORT=5000
+
+# Optional: Path to Chrome extensions directory for advanced scraping
+# Place unpacked extensions in subdirectories within this path
+# Example: /app/extensions/extension1, /app/extensions/extension2
+# Defaults to /app/extensions if not set
+# Docker: /app/extensions (default - no need to set this)
+# Local: /full/path/to/mkfd/extensions
+# CHROME_EXTENSIONS_PATH=/app/extensions
+
 # Optional: Override default 4GB memory allocation for IMAP processes
 # Uncomment and adjust if you have large mailboxes
 # NODE_OPTIONS=--max-old-space-size=8192

.gitignore

@@ -169,4 +169,7 @@ dist
 .pnp.*
 public/feeds/
 configs/
-feed-history/
+feed-history/
+truenas/
+extensions/
+.claude/settings.local.json

README.md

@@ -88,6 +88,57 @@ docker run -p 5000:5000 -v /local/mount/path:/app/configs \
 
 Alternatively, use [Autoheal](https://github.com/willfarrell/docker-autoheal) to automatically restart unhealthy containers in docker-compose setups.
 
+## 🔌 Chrome Extensions for Advanced Scraping
+
+Mkfd supports loading Chrome extensions when using advanced scraping mode (Playwright).
+
+### 📁 Setting Up Extensions
+
+1. **Prepare your extensions**: Create a directory for unpacked Chrome extensions. Each extension should be in its own subdirectory.
+
+   ```
+   extensions/
+   ├── extension1/
+   │   ├── manifest.json
+   │   └── ... (other extension files)
+   └── extension2/
+       ├── manifest.json
+       └── ... (other extension files)
+   ```
+
+2. **Configure the path**: Set the `CHROME_EXTENSIONS_PATH` environment variable to point to your extensions directory.
+This is optional, the default path is "/app/extensions".
+
+### 🐳 Docker Setup
+
+When using Docker or Docker Compose, mount your extensions directory as a volume:
+
+**Docker Run:**
+```bash
+docker run -p 5000:5000 \
+  -v /local/mount/path:/app/configs \
+  -v /path/to/extensions:/app/extensions \
+  -e PASSKEY=your_passkey \
+  -e COOKIE_SECRET=your_cookie_secret \
+  -e ENCRYPTION_KEY=your_encryption_key \
+  tbosk/mkfd:latest
+```
+
+**Docker Compose:**
+
+The included `docker-compose.yml` already has extensions support configured:
+- Extensions directory: `./extensions` (in the same directory as docker-compose.yml)
+- Environment variable is set automatically
+
+Simply place your unpacked extensions in `./extensions/` and they will be loaded when using advanced scraping mode.
+
+### ⚙️ How It Works
+
+- Extensions are automatically discovered and loaded when using advanced scraping mode
+- Each subdirectory in the extensions path is treated as a separate extension
+- Extensions only load when "Advanced Scraping" is enabled for a feed
+- If no extensions are found or the path doesn't exist, advanced scraping works normally without extensions
+
 ## 📧 Email Feeds
 
 Mkfd supports email feeds via IMAP. You can use any email provider that supports IMAP, such as Gmail, Yahoo, or Outlook. To set up an email feed, you need to provide the following information:

docker-compose.yml

@@ -5,14 +5,19 @@ services:
     image: tbosk/mkfd:latest
     container_name: mkfd
     ports:
-      - "0.0.0.0:5000:5000"
+      - "${PORT:-5000}:5000"
     volumes:
       - ./configs:/app/configs
+      # Mount Chrome extensions directory (optional)
+      # Place unpacked extensions in ./extensions/
+      - ./extensions:/app/extensions
     environment:
       - PASSKEY=${PASSKEY:-your_passkey_here}
       - COOKIE_SECRET=${COOKIE_SECRET:-your_cookie_secret_here}
       - ENCRYPTION_KEY=${ENCRYPTION_KEY:-your_encryption_key_here}
       - SSL=${SSL:-false}
+      # Path to Chrome extensions directory for advanced scraping
+      - CHROME_EXTENSIONS_PATH=${CHROME_EXTENSIONS_PATH:-/app/extensions}
       # Uncomment to override default 4GB memory allocation for IMAP processes
       # - NODE_OPTIONS=--max-old-space-size=8192
     restart: unless-stopped

dockerfile

@@ -8,7 +8,7 @@ RUN curl -fsSL https://deb.nodesource.com/setup_23.x | bash - \
  && apt-get install -y nodejs
 
  ENV PLAYWRIGHT_BROWSERS_PATH=/ms-playwright
- RUN bunx patchright install --with-deps chrome
+ RUN bunx patchright install --with-deps chromium
 
 WORKDIR /app
 
@@ -17,9 +17,13 @@ RUN bun install
 
 COPY . .
 
+# Create directories for volumes
+RUN mkdir -p /app/configs /app/extensions && \
+    chmod -R 755 /app/configs /app/extensions
+
 EXPOSE 5000
 
-VOLUME ["/app/configs"]
+VOLUME ["/app/configs", "/app/extensions"]
 
 HEALTHCHECK --interval=5m --timeout=10s --start-period=1m --retries=3 \
   CMD curl -f http://localhost:5000/ || exit 1