Release v0.1.4

Author: joonsoome

.env.dev.example

@@ -16,3 +16,14 @@ DEV_WEB_LIBRARY_PORT=8281
 # Base URL that Web Library should use for opening PDFs via the proxy.
 # In local dev this is typically http://localhost:8280/pdf
 DEV_PDF_PROXY_BASE_URL=http://localhost:8280/pdf
+
+# Metadata source for Web Library (runtime templating)
+# Defaults target zotero.org; set to your account to mirror zotero.org metadata.
+ZOTERO_API_KEY=
+ZOTERO_API_AUTHORITY_PART=api.zotero.org
+ZOTERO_USER_SLUG=changeme-user-slug
+ZOTERO_USER_ID=0
+ZOTERO_INCLUDE_MY_LIBRARY=true
+ZOTERO_INCLUDE_USER_GROUPS=true
+# JSON array of extra libraries/groups to include (e.g., [{"key":"g123","name":"Team","isGroupLibrary":true}])
+ZOTERO_LIBRARIES_INCLUDE_JSON=[]

.env.portainer.example

@@ -14,14 +14,20 @@ WEB_LIBRARY_PORT=8281
 # Base URL that the Web Library should use when linking to the PDF proxy (update to your staging hostname/IP)
 PDF_PROXY_BASE_URL=http://nas.local:8280/pdf
 
-# Metadata source (used at build time for the Web Library image)
+# Metadata source (runtime templating for the Web Library)
 # If you host metadata on zotero.org (default):
 #   ZOTERO_API_KEY: your Zotero API key
 #   ZOTERO_API_AUTHORITY_PART: api.zotero.org
+#   ZOTERO_INCLUDE_USER_GROUPS: true to show your groups from zotero.org
 # If you host metadata on-prem (custom API host):
 #   ZOTERO_API_KEY: on-prem API token (if required)
 #   ZOTERO_API_AUTHORITY_PART: e.g., nas.local:8080 (your on-prem metadata host)
+# You must set ZOTERO_USER_SLUG and ZOTERO_USER_ID to your account to mirror zotero.org data.
 ZOTERO_API_KEY=changeme-zotero-api-key
 ZOTERO_API_AUTHORITY_PART=api.zotero.org
 ZOTERO_USER_SLUG=changeme-user-slug
 ZOTERO_USER_ID=1234567
+ZOTERO_INCLUDE_MY_LIBRARY=true
+ZOTERO_INCLUDE_USER_GROUPS=true
+# JSON array of explicit libraries/groups to include (e.g., [{"key":"g123","name":"Team","isGroupLibrary":true}])
+ZOTERO_LIBRARIES_INCLUDE_JSON=[]

.env.stage.example

@@ -14,14 +14,20 @@ WEB_LIBRARY_PORT=8281
 # Base URL that the Web Library should use when linking to the PDF proxy (update to your staging hostname/IP)
 PDF_PROXY_BASE_URL=http://nas.local:8280/pdf
 
-# Optional: metadata source (used at build time for the Web Library image)
+# Metadata source (runtime templating for the Web Library)
 # If you host metadata on zotero.org (default):
 #   ZOTERO_API_KEY: your Zotero API key
 #   ZOTERO_API_AUTHORITY_PART: api.zotero.org
+#   ZOTERO_INCLUDE_USER_GROUPS: true to show your groups from zotero.org
 # If you host metadata on-prem (custom API host):
 #   ZOTERO_API_KEY: on-prem API token (if required)
 #   ZOTERO_API_AUTHORITY_PART: e.g., nas.local:8080 (your on-prem metadata host)
+# You must set ZOTERO_USER_SLUG and ZOTERO_USER_ID to your account to mirror zotero.org data.
 ZOTERO_API_KEY=changeme-zotero-api-key
 ZOTERO_API_AUTHORITY_PART=api.zotero.org
 ZOTERO_USER_SLUG=changeme-user-slug
 ZOTERO_USER_ID=1234567
+ZOTERO_INCLUDE_MY_LIBRARY=true
+ZOTERO_INCLUDE_USER_GROUPS=true
+# JSON array of explicit libraries/groups to include (e.g., [{"key":"g123","name":"Team","isGroupLibrary":true}])
+ZOTERO_LIBRARIES_INCLUDE_JSON=[]

README.md

@@ -2,6 +2,9 @@
 
 **Self-hosted Zotero WebUI Opensource Library + WebDAV-based PDF viewer **Avoid storage fees, keep privacy, and still enjoy a full browser-based Zotero library.
 
+## It is PoC
+It(v0.1.3) is still fully not properly works, please keep on watching to be ready for production.
+
 ---
 
 ## 🚀 Overview
@@ -38,7 +41,7 @@ You get:
 
 ---
 ## Screenshot
-[WebUI](./docs/assets/screenshot.png)
+![WebUI](./docs/assets/screenshot.png)
 
 ## 🧩 Architecture
 
@@ -180,8 +183,14 @@ The sample data generator creates keys like `SAMPLE1` and `SAMPLE2` under `sampl
 - `.env.stage.example` → `.env.stage`: staging/NAS stack via `docker compose --env-file .env.stage up -d` (defaults to GHCR `:main` tags).
 - `.env.portainer.example` → `.env.portainer`: Portainer stack env file (same vars as staging) when deploying through the UI.
 - `.env` remains ignored; keep real secrets/paths out of the repo.
-- Metadata config (build-time for Web Library): optional `ZOTERO_API_KEY`, `ZOTERO_API_AUTHORITY_PART`, `ZOTERO_USER_SLUG`, `ZOTERO_USER_ID` to point the Web Library at zotero.org or an on-prem metadata source. Set in your env file before building the Web Library image.
+- Metadata config (runtime templating for Web Library): `ZOTERO_API_KEY`, `ZOTERO_API_AUTHORITY_PART`, `ZOTERO_USER_SLUG`, `ZOTERO_USER_ID`, `ZOTERO_INCLUDE_MY_LIBRARY`, `ZOTERO_INCLUDE_USER_GROUPS`, and `ZOTERO_LIBRARIES_INCLUDE_JSON` let you point at zotero.org or an on-prem metadata source. Set these in your env file so the container renders `index.html` with the correct API host/user/groups.
+
+### Metadata configuration & troubleshooting
 
+- Set `ZOTERO_USER_SLUG`/`ZOTERO_USER_ID` and `ZOTERO_API_AUTHORITY_PART` to the metadata host you want (defaults to zotero.org).
+- Control which libraries load with `ZOTERO_INCLUDE_MY_LIBRARY`, `ZOTERO_INCLUDE_USER_GROUPS`, and `ZOTERO_LIBRARIES_INCLUDE_JSON` (JSON array of `{ "key": "g123", "name": "Team", "isGroupLibrary": true }`).
+- Validate templating by viewing page source for `zotero-web-library-config`; wrong host/key/ID typically shows up as `Failed to fetch` in the browser console.
+- For on-prem hosts, ensure the metadata API is reachable from inside the container and that CORS allows the Web Library origin.
 ---
 
 ## 🛠 Components

app/web-library-overlay/scripts/entrypoint.sh

@@ -6,12 +6,15 @@ set -e
 : "${ZOTERO_API_AUTHORITY_PART:=api.zotero.org}"
 : "${ZOTERO_USER_SLUG:=zotero-user}"
 : "${ZOTERO_USER_ID:=0}"
+: "${ZOTERO_INCLUDE_MY_LIBRARY:=true}"
+: "${ZOTERO_INCLUDE_USER_GROUPS:=true}"
+: "${ZOTERO_LIBRARIES_INCLUDE_JSON:=[]}"
 : "${PDF_PROXY_BASE_URL:=http://localhost:8280/pdf}"
 
 # Render index.html with current env vars (placeholders remain if empty)
 if [ -f /usr/share/nginx/html/index.html ]; then
   envsubst \
-    '$ZOTERO_API_KEY $ZOTERO_API_AUTHORITY_PART $ZOTERO_USER_SLUG $ZOTERO_USER_ID $PDF_PROXY_BASE_URL' \
+    '$ZOTERO_API_KEY $ZOTERO_API_AUTHORITY_PART $ZOTERO_USER_SLUG $ZOTERO_USER_ID $ZOTERO_INCLUDE_MY_LIBRARY $ZOTERO_INCLUDE_USER_GROUPS $ZOTERO_LIBRARIES_INCLUDE_JSON $PDF_PROXY_BASE_URL' \
     < /usr/share/nginx/html/index.html \
     > /usr/share/nginx/html/index.html.rendered
   mv /usr/share/nginx/html/index.html.rendered /usr/share/nginx/html/index.html

app/web-library-overlay/src/html/index.html

@@ -23,15 +23,9 @@
 			},
 			"pdfProxyBaseUrl": "$PDF_PROXY_BASE_URL",
 			"libraries": {
-				"include": [
-					{
-						"key": "g729",
-						"name": "All Things Zotero",
-						"isGroupLibrary": true
-					}
-				],
-				"includeMyLibrary": true,
-				"includeUserGroups": false
+				"include": $ZOTERO_LIBRARIES_INCLUDE_JSON,
+				"includeMyLibrary": $ZOTERO_INCLUDE_MY_LIBRARY,
+				"includeUserGroups": $ZOTERO_INCLUDE_USER_GROUPS
 			}
 		}
 	</script>

docker-compose.dev.yml

@@ -19,6 +19,15 @@ services:
     build:
       context: .
       dockerfile: Dockerfile.web-library
+    environment:
+      - PDF_PROXY_BASE_URL=${DEV_PDF_PROXY_BASE_URL:-http://localhost:8280/pdf}
+      - ZOTERO_API_KEY=${ZOTERO_API_KEY:-}
+      - ZOTERO_API_AUTHORITY_PART=${ZOTERO_API_AUTHORITY_PART:-api.zotero.org}
+      - ZOTERO_USER_SLUG=${ZOTERO_USER_SLUG:-zotero-user}
+      - ZOTERO_USER_ID=${ZOTERO_USER_ID:-0}
+      - ZOTERO_INCLUDE_MY_LIBRARY=${ZOTERO_INCLUDE_MY_LIBRARY:-true}
+      - ZOTERO_INCLUDE_USER_GROUPS=${ZOTERO_INCLUDE_USER_GROUPS:-true}
+      - ZOTERO_LIBRARIES_INCLUDE_JSON=${ZOTERO_LIBRARIES_INCLUDE_JSON:-[]}
     ports:
       - "${DEV_WEB_LIBRARY_PORT:-8281}:80"
     depends_on:

docker-compose.yml

@@ -13,6 +13,15 @@ services:
 
   web-library:
     image: ${WEB_LIBRARY_IMAGE:-ghcr.io/joonsoome/on-prem-zotero-webui/web-library:main}
+    environment:
+      - PDF_PROXY_BASE_URL=${PDF_PROXY_BASE_URL:-http://localhost:8280/pdf}
+      - ZOTERO_API_KEY=${ZOTERO_API_KEY:-}
+      - ZOTERO_API_AUTHORITY_PART=${ZOTERO_API_AUTHORITY_PART:-api.zotero.org}
+      - ZOTERO_USER_SLUG=${ZOTERO_USER_SLUG:-zotero-user}
+      - ZOTERO_USER_ID=${ZOTERO_USER_ID:-0}
+      - ZOTERO_INCLUDE_MY_LIBRARY=${ZOTERO_INCLUDE_MY_LIBRARY:-true}
+      - ZOTERO_INCLUDE_USER_GROUPS=${ZOTERO_INCLUDE_USER_GROUPS:-true}
+      - ZOTERO_LIBRARIES_INCLUDE_JSON=${ZOTERO_LIBRARIES_INCLUDE_JSON:-[]}
     ports:
       - "${WEB_LIBRARY_PORT:-8281}:80"
     depends_on: