Allow read-only installation Fix #3453. Thanks to #3499, #3500 and #3521, most of the obstacles to read-only installation have been resolved. This PR addresses the final piece, ensuring that SillyTavern no longer changes directories to `serverDirectory` and outputs files there. Instead, it outputs or copies necessary files to the directory where it is being run. Now, `serverDirectory` is read-only for SillyTavern (i.e., SillyTavern will not attempt to modify `serverDirectory`). Additionally, this PR sets the permissions for copied `default-user` files to be writable, so even if SillyTavern is installed as read-only, the copied `default-user` folder can still be modified.

bf97686dfc99a1b01d10b043b794dd5626083f23

wrvsrx <wrvsrx@outlook.com>

Signed

Parents: 5510e6da31e3798f0262333666bfb91a10fcd4ee

post-install.js+1 -47 Viewed

  */
 import fs from 'node:fs';
 import path from 'node:path';
 -import crypto from 'node:crypto';
 import process from 'node:process';
 import yaml from 'yaml';
 import _ from 'lodash';

+    }
+}
 -/**
 - * Returns the MD5 hash of the given data.
 - * @param {Buffer} data Input data
 - * @returns {string} MD5 hash of the input data
 - */
 -function getMd5Hash(data) {
 -    return crypto
 -        .createHash('md5')
 -        .update(new Uint8Array(data))
 -        .digest('hex');
 -}
+-
 -/**
 - * Copies the WASM binaries from the sillytavern-transformers package to the dist folder.
 - */
 -function copyWasmFiles() {
 -    if (!fs.existsSync('./dist')) {
 -        fs.mkdirSync('./dist');
 -    }
+-
 -    const listDir = fs.readdirSync('./node_modules/sillytavern-transformers/dist');
+-
 -    for (const file of listDir) {
 -        if (file.endsWith('.wasm')) {
 -            const sourcePath = `./node_modules/sillytavern-transformers/dist/${file}`;
 -            const targetPath = `./dist/${file}`;
+-
 -            // Don't copy if the file already exists and is the same checksum
 -            if (fs.existsSync(targetPath)) {
 -                const sourceChecksum = getMd5Hash(fs.readFileSync(sourcePath));
 -                const targetChecksum = getMd5Hash(fs.readFileSync(targetPath));
+-
 -                if (sourceChecksum === targetChecksum) {
 -                    continue;
 -                }
 -            }
+-
 -            fs.copyFileSync(sourcePath, targetPath);
 -            console.log(`${file} successfully copied to ./dist/${file}`);
 -        }
 -    }
 -}
+-
 try {
     // 0. Convert config.conf to config.yaml
     convertConfig();
     // 1. Create default config files
     createDefaultFiles();
     // 2. Copy transformers WASMAdd binariesmissing fromconfig node_modulesvalues
 -    copyWasmFiles();
 -    // 3. Add missing config values
     addMissingConfigValues();
 } catch (error) {
     console.error(error);

server.js+4 -7 Viewed

 import net from 'node:net';
 import dns from 'node:dns';
 import process from 'node:process';
 -import { fileURLToPath } from 'node:url';
 import cors from 'cors';
 import { csrfSync } from 'csrf-sync';

 } from './src/util.js';
 import { UPLOADS_DIRECTORY } from './src/constants.js';
 import { ensureThumbnailCache } from './src/endpoints/thumbnails.js';
 +import { serverDirectory } from './src/server-directory.js';
 // Routers
 import { router as usersPublicRouter } from './src/endpoints/users-public.js';

 util.inspect.defaultOptions.maxStringLength = null;
 util.inspect.defaultOptions.depth = 4;
 -// Set a working directory for the server
 -const serverDirectory = import.meta.dirname ?? path.dirname(fileURLToPath(import.meta.url));
 console.log(`Node version: ${process.version}. Running in ${process.env.NODE_ENV} environment. Server directory: ${serverDirectory}`);
 -process.chdir(serverDirectory);
 // Work around a node v20.0.0, v20.1.0, and v20.2.0 bug. The issue was fixed in v20.3.0.
 // https://github.com/nodejs/node/issues/47822#issuecomment-1564708870

         return response.redirect(redirectUrl);
+    }
     return response.sendFile('index.html', { root: path.join(process.cwd()serverDirectory, 'public') });
 });
 // Callback endpoint for OAuth PKCE flows (e.g. OpenRouter)

 // Host frontend assets
 const webpackMiddleware = getWebpackServeMiddleware();
 app.use(webpackMiddleware);
 app.use(express.static(processpath.cwdjoin() +serverDirectory, '/public'), {}));
 // Public API
 app.use('/api/users', usersPublicRouter);

  * Registers a not-found error response if a not-found error page exists. Should only be called after all other middlewares have been registered.
  */
 function apply404Middleware() {
     const notFoundWebpage = safeReadFileSync('path./join(serverDirectory, 'public/error/url-not-found.html')) ?? '';
     app.use((req, res) => {
         res.status(404).send(notFoundWebpage);
     });

src/endpoints/content-manager.js+27 -3 Viewed

 import fs from 'node:fs';
 import path from 'node:path';
 -import process from 'node:process';
 import { Buffer } from 'node:buffer';
 import express from 'express';

 import { getConfigValue, color } from '../util.js';
 import { write } from '../character-card-parser.js';
 +import { serverDirectory } from '../server-directory.js';
 const contentDirectory = path.join(process.cwd()serverDirectory, 'default/content');
 const scaffoldDirectory = path.join(process.cwd()serverDirectory, 'default/scaffold');
 const contentIndexPath = path.join(contentDirectory, 'index.json');
 const scaffoldIndexPath = path.join(scaffoldDirectory, 'index.json');

+        }
         fs.cpSync(contentPath, targetPath, { recursive: true, force: false });
 +        function setPermissionsSync(targetPath_) {
++
 +            function appendWritablePermission(filepath, stats) {
 +                const currentMode = stats.mode;
 +                const newMode = currentMode | 0o200;
 +                if (newMode != currentMode) {
 +                    fs.chmodSync(filepath, newMode);
 +                }
 +            }
++
 +            const stats = fs.statSync(targetPath_);
++
 +            if (stats.isDirectory()) {
 +                appendWritablePermission(targetPath_, stats);
 +                const files = fs.readdirSync(targetPath_);
++
 +                files.forEach((file) => {
 +                    setPermissionsSync(path.join(targetPath_, file));
 +                });
 +            } else {
 +                appendWritablePermission(targetPath_, stats);
 +            }
 +        }
 +        setPermissionsSync(targetPath);
         console.info(`Content file ${contentItem.filename} copied to ${contentTarget}`);
         anyContentAdded = true;
+    }

src/fetch-patch.js+4 -4 Viewed

 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import mime from 'mime-types';
 +import { serverDirectory } from './server-directory.js';
 const originalFetch = globalThis.fetch;

+    }
     const url = getRequestURL(request);
     const filePath = path.resolve(fileURLToPath(url));
 -    const cwd = path.resolve(process.cwd()) + path.sep;
 +    const isUnderServerDirectory = isPathUnderParent(serverDirectory, filePath);
 -    const isUnderCwd = isPathUnderParent(cwd, filePath);
 +    if (!isUnderServerDirectory) {
 -    if (!isUnderCwd) {
 +        throw new Error('Requested file path is outside of the server directory.');
 -        throw new Error('Requested file path is outside of the current working directory.');
+    }
     const parsedPath = path.parse(filePath);
     if (!ALLOWED_EXTENSIONS.includes(parsedPath.ext)) {

src/server-directory.js+3 -0 Viewed

 +import path from 'node:path';
 +import { fileURLToPath } from 'node:url';
 +export const serverDirectory = path.dirname(import.meta.dirname ?? path.dirname(fileURLToPath(import.meta.url)));

src/transformers.js+3 -1 Viewed

 import { pipeline, env, RawImage } from 'sillytavern-transformers';
 import { getConfigValue } from './util.js';
 +import { serverDirectory } from './server-directory.js';
 configureTransformers();
 function configureTransformers() {
     // Limit the number of threads to 1 to avoid issues on Android
     env.backends.onnx.wasm.numThreads = 1;
 +    console.log(env.backends.onnx.wasm.wasmPaths);
     // Use WASM from a local folder to avoid CDN connections
     env.backends.onnx.wasm.wasmPaths = path.join(process.cwd()serverDirectory, 'node_modules', 'sillytavern-transformers', 'dist') + path.sep;
+}
 const tasks = {

src/users.js+2 -1 Viewed

 import { getConfigValue, color, delay, generateTimestamp } from './util.js';
 import { readSecret, writeSecret } from './endpoints/secrets.js';
 import { getContentOfType } from './endpoints/content-manager.js';
 +import { serverDirectory } from './server-directory.js';
 export const KEY_PREFIX = 'user:';
 const AVATAR_PREFIX = 'avatar:';

@@ -905,7 +906,7 @@ export async function loginPageMiddleware(request, response) {
905	906	console.error('Error during auto-login:', error);
906	907	}
907	908
908	909	return response.sendFile('login.html', { root: path.join(process.cwd()serverDirectory, 'public') });
909	910	}
910	911
911	912	/**

src/util.js+9 -9 Viewed

 import chalk from 'chalk';
 import { LOG_LEVELS } from './constants.js';
 import bytes from 'bytes';
 +import { serverDirectory } from './server-directory.js';
 /**
  * Parsed config object.

     try {
         const require = createRequire(import.meta.url);
         const pkgJson = require(path.join(process.cwd()serverDirectory, './package.json'));
         pkgVersion = pkgJson.version;
         if (commandExistsSync('git')) {
             const git = simpleGit({ baseDir: serverDirectory });
 -            const cwd = process.cwd();
 +            gitRevision = await git.revparse(['--short', 'HEAD']);
             gitRevisiongitBranch = await git.cwd(cwd).revparse(['--shortabbrev-ref', 'HEAD']);
             gitBranchcommitDate = await git.cwd(cwd).revparseshow(['--abbrev-refs', 'HEAD--format=%ci', gitRevision]);
 -            commitDate = await git.cwd(cwd).show(['-s', '--format=%ci', gitRevision]);
             const trackingBranch = await git.cwd(cwd).revparse(['--abbrev-ref', '@{u}']);
             // Might fail, but exception is caught. Just don't run anything relevant after in this block...
             const localLatest = await git.cwd(cwd).revparse(['HEAD']);
             const remoteLatest = await git.cwd(cwd).revparse([trackingBranch]);
             isLatest = localLatest === remoteLatest;
+        }
+    }

webpack.config.js+2 -1 Viewed

 import process from 'node:process';
 import path from 'node:path';
 import isDocker from 'is-docker';
 +import { serverDirectory } from './src/server-directory.js';
 /**
  * Get the Webpack configuration for the public/lib.js file.

     return {
         mode: 'production',
         entry: 'path./join(serverDirectory, 'public/lib.js'),
         cache: {
             type: 'filesystem',
             cacheDirectory: cacheDirectory,