vault-cortex 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/env.js +29 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -36,6 +36,10 @@ Pull the latest image, re-create the container, and verify health:
|
|
|
36
36
|
npx vault-cortex upgrade
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
Run it from the same directory where you ran `init` — it looks for your
|
|
40
|
+
config in `./vault-cortex/.env` (pass `--dir <path>` if you scaffolded
|
|
41
|
+
somewhere else).
|
|
42
|
+
|
|
39
43
|
Your vault data, search index, and `.env` settings are preserved across
|
|
40
44
|
upgrades — only the server image is replaced. Also applies `.env` changes
|
|
41
45
|
(`docker restart` does not re-read env files).
|
package/dist/env.js
CHANGED
|
@@ -11,12 +11,13 @@ import { REMOTE_IMAGE } from "./docker.js";
|
|
|
11
11
|
// └─────────────────────────────────────────────────────────────────────────┘
|
|
12
12
|
// sync:local-optional:begin
|
|
13
13
|
const LOCAL_OPTIONAL_BLOCK = `# Optional ──────────────────────────────────────────────────
|
|
14
|
-
# To
|
|
15
|
-
# "npx vault-cortex upgrade" (restart alone does not
|
|
14
|
+
# To change a setting: edit its value (uncommenting it first if needed),
|
|
15
|
+
# then apply with "npx vault-cortex upgrade" (restart alone does not
|
|
16
|
+
# re-read this file).
|
|
16
17
|
|
|
17
18
|
# Public URL for OAuth issuer URL in discovery metadata (default: http://localhost:8000).
|
|
18
19
|
# Override if you expose the server on a different URL (e.g. via a reverse proxy).
|
|
19
|
-
|
|
20
|
+
PUBLIC_URL=http://localhost:8000
|
|
20
21
|
|
|
21
22
|
# Your IANA timezone — affects daily note resolution and memory timestamps.
|
|
22
23
|
# TZ=America/New_York
|
|
@@ -27,20 +28,20 @@ const LOCAL_OPTIONAL_BLOCK = `# Optional ─────────────
|
|
|
27
28
|
# similarity fused via RRF. First startup is slow (~5min for 700 notes);
|
|
28
29
|
# subsequent starts are fast via content-hash caching.
|
|
29
30
|
# Set to false to disable model download and use FTS5 search only.
|
|
30
|
-
|
|
31
|
+
EMBEDDING_ENABLED=true
|
|
31
32
|
|
|
32
33
|
# Reranking mode for hybrid search results (default: blended).
|
|
33
34
|
# "blended" uses a cross-encoder to refine result ordering with
|
|
34
35
|
# position-aware score blending (~200ms added latency).
|
|
35
36
|
# "none" skips reranking for lower latency.
|
|
36
37
|
# Only takes effect when EMBEDDING_ENABLED=true.
|
|
37
|
-
|
|
38
|
+
RERANK_MODE=blended
|
|
38
39
|
|
|
39
40
|
# Enable or disable the memory layer (default: true).
|
|
40
41
|
# Set to false to hide memory tools and skip About Me/ creation.
|
|
41
|
-
|
|
42
|
+
MEMORY_ENABLED=true
|
|
42
43
|
# Memory folder name in your vault (default: About Me).
|
|
43
|
-
|
|
44
|
+
MEMORY_DIR=About Me
|
|
44
45
|
|
|
45
46
|
# Comma-separated folders protected from deletion (default: MEMORY_DIR, Daily Notes).
|
|
46
47
|
# If your daily notes folder has a custom name (e.g. "Journal"), override to include it.
|
|
@@ -55,10 +56,10 @@ const LOCAL_OPTIONAL_BLOCK = `# Optional ─────────────
|
|
|
55
56
|
# SERVICE_DOCUMENTATION_URL=https://github.com/youruser/your-fork
|
|
56
57
|
|
|
57
58
|
# Host port to expose (default: 8000).
|
|
58
|
-
|
|
59
|
+
PORT=8000
|
|
59
60
|
|
|
60
61
|
# Log verbosity: debug | info | warn | error (default: info).
|
|
61
|
-
|
|
62
|
+
LOG_LEVEL=info
|
|
62
63
|
|
|
63
64
|
# Directory for persistent log files inside the container.
|
|
64
65
|
# Unset by default — logs go to stdout only. Set a path to also write
|
|
@@ -66,13 +67,13 @@ const LOCAL_OPTIONAL_BLOCK = `# Optional ─────────────
|
|
|
66
67
|
# LOG_DIR=/data/logs
|
|
67
68
|
|
|
68
69
|
# Days to retain persistent log files before cleanup (default: 30).
|
|
69
|
-
|
|
70
|
+
LOG_RETENTION_DAYS=30
|
|
70
71
|
|
|
71
72
|
# Windows users: set this to true. Makes a vault stored on a C: drive work
|
|
72
73
|
# through Docker Desktop (switches the file watcher to polling and note moves
|
|
73
74
|
# to rename-based writes). Only strictly needed when your vault is on a C:
|
|
74
75
|
# drive rather than inside WSL2, but harmless to enable for any Windows setup.
|
|
75
|
-
|
|
76
|
+
WINDOWS_MODE=false
|
|
76
77
|
`;
|
|
77
78
|
// sync:local-optional:end
|
|
78
79
|
// ┌─────────────────────────────────────────────────────────────────────────┐
|
|
@@ -82,8 +83,9 @@ const LOCAL_OPTIONAL_BLOCK = `# Optional ─────────────
|
|
|
82
83
|
// └─────────────────────────────────────────────────────────────────────────┘
|
|
83
84
|
// sync:remote-optional:begin
|
|
84
85
|
const REMOTE_OPTIONAL_BLOCK = `# Optional ──────────────────────────────────────────────────
|
|
85
|
-
# To
|
|
86
|
-
# "npx vault-cortex upgrade" (restart alone does not
|
|
86
|
+
# To change a setting: edit its value (uncommenting it first if needed),
|
|
87
|
+
# then apply with "npx vault-cortex upgrade" (restart alone does not
|
|
88
|
+
# re-read this file).
|
|
87
89
|
|
|
88
90
|
# Your IANA timezone — affects daily note resolution and memory timestamps.
|
|
89
91
|
# TZ=America/New_York
|
|
@@ -94,26 +96,26 @@ const REMOTE_OPTIONAL_BLOCK = `# Optional ────────────
|
|
|
94
96
|
# similarity fused via RRF. First startup is slow (~5min for 700 notes);
|
|
95
97
|
# subsequent starts are fast via content-hash caching.
|
|
96
98
|
# Set to false to disable model download and use FTS5 search only.
|
|
97
|
-
|
|
99
|
+
EMBEDDING_ENABLED=true
|
|
98
100
|
|
|
99
101
|
# Reranking mode for hybrid search results (default: blended).
|
|
100
102
|
# "blended" uses a cross-encoder to refine result ordering with
|
|
101
103
|
# position-aware score blending (~200ms added latency).
|
|
102
104
|
# "none" skips reranking for lower latency.
|
|
103
105
|
# Only takes effect when EMBEDDING_ENABLED=true.
|
|
104
|
-
|
|
106
|
+
RERANK_MODE=blended
|
|
105
107
|
|
|
106
108
|
# Windows bind-mount mode (default: false).
|
|
107
109
|
# Set to true when your vault is on a Windows drive (Docker Desktop).
|
|
108
110
|
# Enables polling for the file watcher and rename-based moves across
|
|
109
111
|
# the Docker Desktop/WSL2 bridge.
|
|
110
|
-
|
|
112
|
+
WINDOWS_MODE=false
|
|
111
113
|
|
|
112
114
|
# Enable or disable the memory layer (default: true).
|
|
113
115
|
# Set to false to hide memory tools and skip About Me/ creation.
|
|
114
|
-
|
|
116
|
+
MEMORY_ENABLED=true
|
|
115
117
|
# Memory folder name in your vault (default: About Me).
|
|
116
|
-
|
|
118
|
+
MEMORY_DIR=About Me
|
|
117
119
|
|
|
118
120
|
# Comma-separated folders protected from deletion (default: MEMORY_DIR, Daily Notes).
|
|
119
121
|
# If your daily notes folder has a custom name (e.g. "Journal"), override to include it.
|
|
@@ -128,31 +130,31 @@ const REMOTE_OPTIONAL_BLOCK = `# Optional ────────────
|
|
|
128
130
|
# SERVICE_DOCUMENTATION_URL=https://github.com/youruser/your-fork
|
|
129
131
|
|
|
130
132
|
# Host port to expose (default: 8000).
|
|
131
|
-
|
|
133
|
+
PORT=8000
|
|
132
134
|
|
|
133
135
|
# Log verbosity: debug | info | warn | error (default: info).
|
|
134
|
-
|
|
136
|
+
LOG_LEVEL=info
|
|
135
137
|
|
|
136
138
|
# Directory for persistent log files inside the container (default: /data/logs).
|
|
137
139
|
# Set to empty to disable file logging (logs still go to stdout either way).
|
|
138
|
-
|
|
140
|
+
LOG_DIR=/data/logs
|
|
139
141
|
|
|
140
142
|
# Days to retain persistent log files before cleanup (default: 30).
|
|
141
|
-
|
|
143
|
+
LOG_RETENTION_DAYS=30
|
|
142
144
|
|
|
143
145
|
# User/group IDs for obsidian-sync (default: 1000).
|
|
144
|
-
|
|
145
|
-
|
|
146
|
+
PUID=1000
|
|
147
|
+
PGID=1000
|
|
146
148
|
|
|
147
149
|
# Device name shown in Obsidian Sync settings.
|
|
148
|
-
|
|
150
|
+
DEVICE_NAME=vault-cortex
|
|
149
151
|
|
|
150
152
|
# Obsidian Sync conflict resolution: merge | conflict (default: merge).
|
|
151
153
|
# 'merge' integrates changes automatically; 'conflict' writes a separate conflict file.
|
|
152
|
-
|
|
154
|
+
CONFLICT_STRATEGY=merge
|
|
153
155
|
|
|
154
156
|
# Sync direction: bidirectional | pull-only | push-only (default: bidirectional).
|
|
155
|
-
|
|
157
|
+
SYNC_MODE=bidirectional
|
|
156
158
|
`;
|
|
157
159
|
// sync:remote-optional:end
|
|
158
160
|
export const buildLocalEnv = (answers) => `# vault-cortex — local quickstart
|