From 81bed09ced0a12a1dcaf1d8e5eac3e4f0f9e6d90 Mon Sep 17 00:00:00 2001 From: DebaucheryLibrarian Date: Sun, 8 Nov 2026 22:01:05 +0100 Subject: [PATCH] Updated README. --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d92c967d..7280d832 100755 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ **NSFW** - The latest releases from your favorite porn studios in one place. ## Install & run -Use [nvm](https://github.com/creationix/nvm) to install NodeJS v16.8.0 or newer. Download and unpack or clone this repository, and run the following in the root directory: +Use [nvm](https://github.com/creationix/nvm) to install NodeJS v26.13.0, and make sure it's active (`nvm use`). Download and unpack or clone this repository, and run the following in the root directory: -`npm install` +`npm ci` ### Set up database Install PostgreSQL, make sure password authentication is enabled (scram-sha-256). Create a database with a fully privileged user. @@ -18,6 +18,11 @@ Do not modify `config/default.js`, but instead create a copy at `config/local.js You can also use `npm run flush` to run both steps at once, and wipe the database completely later. +### Install browser +Unless configured to use unprint's remote browser server, a browser needs to be installed locally: + +`npx patchright install chromium` + #### Networks and channels To scrape the networks and channels available in the database, you can configure `include` and `exclude` lists. To include all available channels and only use the `exclude` list, leave the `include` parameter unconfigured. The `exclude` lists will exclude channels and child networks from networks on the `include` lists, but not vice versa. That is, if the `include` list includes a network and the `exclude` list excludes one of that network's channels, the channel will not be scraped. However, if the `include` list includes a channel, and the `exclude` list includes its parent network, the channel will be scraped.