Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import express from "express";
import rateLimit from "express-rate-limit";
import { existsSync } from "fs";
import path from "path";
import type serveStatic from "serve-static";
import { getHelpAssetDir } from "../in_app_help_provider.js";
import { assetUrlFragment } from "../services/asset_path.js";
import auth from "../services/auth.js";
import port from "../services/port.js";
import { getResourceDir, isDev, isElectron } from "../services/utils.js";
import { doubleCsrfProtection as csrfMiddleware } from "./csrf_protection.js";
// Allow serving assets even if the installation path contains a hidden (dot-prefixed) directory.
const STATIC_OPTIONS: serveStatic.ServeStaticOptions = { dotfiles: "allow" };
const persistentCacheStatic = (root: string, options?: serveStatic.ServeStaticOptions<express.Response<unknown, Record<string, unknown>>>) => {
if (!isDev) {
options = {
maxAge: "1y",
...options
};
}
return express.static(root, { ...STATIC_OPTIONS, ...options });
};
async function register(app: express.Application) {
const srcRoot = path.join(__dirname, "..", "..");
const resourceDir = getResourceDir();
const rootLimiter = rateLimit({
windowMs: 15 * 60 * 1000, // 15 minutes
max: 100 // limit each IP to 100 requests per windowMs
});
const clientFonts = express.static(path.join(getClientDir(), "fonts"), STATIC_OPTIONS);
app.use(`/share/assets/fonts/`, clientFonts);
if (process.env.NODE_ENV === "development") {
const { createServer: createViteServer } = await import("vite");
const clientDir = path.join(srcRoot, "../client");
const vite = await createViteServer({
server: {
middlewareMode: true,
ws: {
// Derive a unique HMR port from the application port so
// multiple dev instances (e.g. server on 8080, desktop on
// 37742) don't all fight over Vite's default port 24678.
port: port + 10,
// Under Electron the page loads from `trilium-app://app/`,
// so Vite's default of using `window.location.hostname`
// would try `ws://app:…` — DNS fails. Pin the HMR client
// to loopback explicitly.
...(isElectron ? { host: "127.0.0.1", protocol: "ws" as const } : {})
}
},
appType: "spa",
configFile: path.join(clientDir, "vite.config.mts"),
base: `/${assetUrlFragment}/`,
// One dep-optimizer cache per dev instance. The client config points
// `cacheDir` at a single repo-level directory, but the optimizer
// invalidates the whole cache whenever its `configHash` changes —
// and that hash differs between the Node-hosted dev server and the
// Electron-hosted one. Sharing the directory therefore made every
// switch between `server:start` and `desktop:start` re-scan and
// re-bundle the whole dependency graph, adding ~3s to startup.
cacheDir: path.join(clientDir, "../..", ".cache", `vite-${port}`)
});
app.use(`/${assetUrlFragment}/`, (req, res, next) => {
if (req.url.startsWith("/images/") || req.url.startsWith("/help/")) {
// Images and the in-app help's assets are served as static assets from the server.
// Anything not listed here is handed to Vite, which answers unknown paths with
// index.html — a 200 that looks fine until you read the body.
next();
return;
}
vite.middlewares(req, res, next);
});
app.get(`/`, [ rootLimiter, auth.checkAuth, csrfMiddleware ], (req, res, next) => {
req.url = `/${assetUrlFragment}/index.html`;
vite.middlewares(req, res, next);
});
app.get(`/src/index.ts`, [ rootLimiter ], (req, res, next) => {
req.url = `/${assetUrlFragment}/src/index.ts`;
vite.middlewares(req, res, next);
});
app.use(`/node_modules/@excalidraw/excalidraw/dist/prod`, persistentCacheStatic(path.join(srcRoot, "../../node_modules/@excalidraw/excalidraw/dist/prod")));
// The client's Vite config answers the share theme's entries from source.
app.get(SHARE_THEME_ENTRIES.map((file) => `/share/assets/${file}`), (req, res, next) => {
req.url = `/${assetUrlFragment}${req.path}`;
vite.middlewares(req, res, next);
});
} else {
const publicDir = path.join(resourceDir, "public");
if (!existsSync(publicDir)) {
throw new Error(`Public directory is missing at: ${path.resolve(publicDir)}`);
}
app.get(`/`, [ rootLimiter, auth.checkAuth, csrfMiddleware ], (_, res) => {
// We force the page to not be cached since on mobile the CSRF token can be
// broken when closing the browser and coming back in to the page.
// The page is restored from cache, but the API call fail.
res.setHeader("Cache-Control", "no-cache, no-store, must-revalidate");
res.sendFile(path.join(publicDir, "index.html"), STATIC_OPTIONS);
});
app.use("/assets", persistentCacheStatic(path.join(publicDir, "assets")));
app.use(`/src`, persistentCacheStatic(path.join(publicDir, "src")));
app.use(`/${assetUrlFragment}/src`, persistentCacheStatic(path.join(publicDir, "src")));
app.use(`/${assetUrlFragment}/stylesheets`, persistentCacheStatic(path.join(publicDir, "stylesheets")));
app.use(`/${assetUrlFragment}/fonts`, persistentCacheStatic(path.join(publicDir, "fonts")));
app.use(`/${assetUrlFragment}/translations/`, persistentCacheStatic(path.join(publicDir, "translations")));
app.use(`/node_modules/`, persistentCacheStatic(path.join(publicDir, "node_modules")));
app.use(`/share/assets/`, express.static(getShareThemeAssetDir(), STATIC_OPTIONS));
app.use(`/share/assets/`, express.static(path.join(publicDir, "assets"), STATIC_OPTIONS));
}
app.use(`/pdfjs/`, persistentCacheStatic(getPdfjsAssetDir()));
app.use(`/${assetUrlFragment}/images`, persistentCacheStatic(path.join(resourceDir, "assets", "images")));
// Images and attachments of the in-app help. They are not committed under the server's assets
// — the User Guide owns them — so in a source checkout they are served straight out of docs/,
// while a packaged build copies them in (see scripts/build.ts).
app.use(`/${assetUrlFragment}/help`, persistentCacheStatic(getHelpAssetDir()));
// `vX` is a version-independent alias so custom themes and scripts can reference built-in assets
// without naming a version they would have to bump on every upgrade. It serves the same files as
// the versioned routes above, but without `maxAge`: the URL no longer changes between releases,
// so a long-lived cache entry would pin the client to the previous version's assets.
app.use(`/assets/vX/stylesheets`, express.static(path.join(getClientDir(), "stylesheets"), STATIC_OPTIONS));
app.use(`/assets/vX/fonts`, express.static(path.join(getClientDir(), "fonts"), STATIC_OPTIONS));
app.use(`/assets/vX/images`, express.static(path.join(resourceDir, "assets", "images"), STATIC_OPTIONS));
}
/** The fixed files of the share theme that every shared page loads. */
const SHARE_THEME_ENTRIES = [ "scripts.js", "tree.js", "scripts.css" ];
/**
* Where the client build writes the share theme, beside its own chunks: `src/` of the client's
* build output.
*/
export function getShareThemeAssetDir() {
return path.join(getClientBuildDir(), "src");
}
/** The client's build output: `public/` in a packaged app, `apps/client/dist` in development. */
export function getClientBuildDir() {
if (process.env.NODE_ENV === "development") {
return path.join(getClientDir(), "..", "dist");
}
return getClientDir();
}
export function getPdfjsAssetDir() {
if (process.env.NODE_ENV === "development") {
const srcRoot = path.join(__dirname, "..", "..");
return path.join(srcRoot, "../../packages/pdfjs-viewer/dist");
}
const resourceDir = getResourceDir();
return path.join(resourceDir, "pdfjs-viewer");
}
export function getClientDir() {
if (process.env.NODE_ENV === "development") {
const srcRoot = path.join(__dirname, "..", "..");
return path.join(srcRoot, "../client/src");
}
const resourceDir = getResourceDir();
return path.join(resourceDir, "public");
}
export default {
register
};