Skip to content

Commit fb115b3

Browse files
committed
docs: update portainer env example and metadata tasks status
1 parent a940376 commit fb115b3

File tree

2 files changed

+26
-7
lines changed

2 files changed

+26
-7
lines changed

.env.portainer.example

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
# GHCR images (override tags if needed) — default to a pinned release tag
1+
# Portainer stack environment (example values). Copy to `.env.portainer` for Portainer UI deployment.
2+
3+
# GHCR images to deploy (choose tags built by CI) — default to a pinned release tag
24
PDF_PROXY_IMAGE=ghcr.io/joonsoome/on-prem-zotero-webui/pdf-proxy:v0.1.1
35
WEB_LIBRARY_IMAGE=ghcr.io/joonsoome/on-prem-zotero-webui/web-library:v0.1.1
46

5-
# Host bindings
7+
# Host path for Zotero WebDAV data mounted into the proxy container
68
ZOTERO_ROOT_HOST_PATH=/volume1/Reference/zotero
9+
10+
# Host ports exposed by the stack
711
PDF_PROXY_PORT=8280
812
WEB_LIBRARY_PORT=8281
13+
14+
# Base URL that the Web Library should use when linking to the PDF proxy (update to your staging hostname/IP)
15+
PDF_PROXY_BASE_URL=http://nas.local:8280/pdf
16+
17+
# Metadata source (used at build time for the Web Library image)
18+
# If you host metadata on zotero.org (default):
19+
# ZOTERO_API_KEY: your Zotero API key
20+
# ZOTERO_API_AUTHORITY_PART: api.zotero.org
21+
# If you host metadata on-prem (custom API host):
22+
# ZOTERO_API_KEY: on-prem API token (if required)
23+
# ZOTERO_API_AUTHORITY_PART: e.g., nas.local:8080 (your on-prem metadata host)
24+
ZOTERO_API_KEY=changeme-zotero-api-key
25+
ZOTERO_API_AUTHORITY_PART=api.zotero.org
26+
ZOTERO_USER_SLUG=changeme-user-slug
27+
ZOTERO_USER_ID=1234567

openspec/changes/add-onprem-metadata-source/tasks.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
## 1. Discovery
2-
- [ ] 1.1 Review upstream `zotero/web-library` config to identify metadata endpoint/auth settings (zotero.org defaults, API keys, user/group config).
3-
- [ ] 1.2 Check overlay code for existing overrides (e.g., pdf proxy base, userSlug/userId) and note gaps for metadata endpoint selection.
2+
- [x] 1.1 Review upstream `zotero/web-library` config to identify metadata endpoint/auth settings (zotero.org defaults, API keys, user/group config).
3+
- [x] 1.2 Check overlay code for existing overrides (e.g., pdf proxy base, userSlug/userId) and note gaps for metadata endpoint selection.
44

55
## 2. On-prem metadata option
6-
- [ ] 2.1 Define how to point Web Library to an on-prem metadata backend (e.g., Zotero API proxy/self-hosted sync target on Synology) and document required env vars.
7-
- [ ] 2.2 Add overlay config/hooks to select metadata source via env (e.g., `METADATA_BASE_URL`, `ZOTERO_API_KEY`), including zotero.org fallback.
8-
- [ ] 2.3 Provide staging defaults (Synology) in env examples and Compose notes.
6+
- [x] 2.1 Define how to point Web Library to an on-prem metadata backend (e.g., Zotero API proxy/self-hosted sync target on Synology) and document required env vars.
7+
- [x] 2.2 Add overlay config/hooks to select metadata source via env (e.g., `METADATA_BASE_URL`, `ZOTERO_API_KEY`), including zotero.org fallback.
8+
- [x] 2.3 Provide staging defaults (Synology) in env examples and Compose notes.
99

1010
## 3. Validation
1111
- [ ] 3.1 Manual check: Web Library loads collections/items from the chosen metadata source (on-prem vs zotero.org) while attachments remain WebDAV.

0 commit comments

Comments
 (0)