Skip to content

Commit f0192e8

Browse files
committed
docs: add env templates and README
1 parent c199ba8 commit f0192e8

File tree

4 files changed

+394
-4
lines changed

4 files changed

+394
-4
lines changed

.env.dev.example

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Local dev/test environment configuration (example values).
22
# Copy this file to `.env.dev` and adjust as needed.
33

4+
# Images built locally by the dev compose stack (build + tag with these names)
5+
PDF_PROXY_IMAGE=ghcr.io/joonsoome/on-prem-zotero-webui/pdf-proxy:dev
6+
WEB_LIBRARY_IMAGE=ghcr.io/joonsoome/on-prem-zotero-webui/web-library:dev
7+
48
# Host path for synthetic/sample Zotero WebDAV data used in dev.
59
# The default `./sample-webdav/zotero` will be populated by scripts/generate-sample-webdav.py
610
DEV_ZOTERO_SAMPLE_ROOT=./sample-webdav/zotero
@@ -9,9 +13,6 @@ DEV_ZOTERO_SAMPLE_ROOT=./sample-webdav/zotero
913
DEV_PDF_PROXY_PORT=8280
1014
DEV_WEB_LIBRARY_PORT=8281
1115

12-
# Web Library image built from subtree + overlay (build with scripts/build-web-library-image.sh)
13-
WEB_LIBRARY_IMAGE=zotero-web-library:dev
14-
1516
# Base URL that Web Library should use for opening PDFs via the proxy.
1617
# In local dev this is typically http://localhost:8280/pdf
1718
DEV_PDF_PROXY_BASE_URL=http://localhost:8280/pdf

.env.stage.example

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Staging/NAS environment configuration (example values). Copy to `.env.stage` on the staging host.
2+
3+
# GHCR images to deploy (choose tags built by CI)
4+
PDF_PROXY_IMAGE=ghcr.io/joonsoome/on-prem-zotero-webui/pdf-proxy:main
5+
WEB_LIBRARY_IMAGE=ghcr.io/joonsoome/on-prem-zotero-webui/web-library:main
6+
7+
# Host path for Zotero WebDAV data mounted into the proxy container
8+
ZOTERO_ROOT_HOST_PATH=/volume1/Reference/zotero
9+
10+
# Host ports exposed by the stack
11+
PDF_PROXY_PORT=8280
12+
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

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,9 @@ celerybeat.pid
136136

137137
# Environments
138138
.env
139+
.env.dev
140+
.env.stage
141+
.env.portainer
139142
.envrc
140143
.venv
141144
env/
@@ -212,4 +215,4 @@ README-draft.md
212215
.vscode/
213216
openspec/
214217
sample-webdav/
215-
app/web-library-build/
218+
app/web-library-build/

0 commit comments

Comments
 (0)