From 4abf2ef021cfda7130fa0361ddfb599b0a79ef68 Mon Sep 17 00:00:00 2001 From: Lightling Date: Sat, 10 Feb 2024 15:08:03 -0500 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a56d3d3..4573b0a 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Max number of concurrent download threads. Only this number of concurrent galler ### `--args={gallery-dl args}` -Additional args to pass to gallery-dl. Note that these aren't currently checked for duplicates that may be used by this repo. +Additional args to pass to gallery-dl. See [gallery-dl CLI options](https://github.com/mikf/gallery-dl/blob/master/docs/options.md#selection-options) for reference. Note that these aren't currently checked for duplicates that may be used by this repo. ## TODO @@ -58,12 +58,21 @@ Args: ### `run-updateDb.js` -Should pull from the user database and update the archive without doing a full download. +Should pull from the user database and update the archive without doing a full download. The DB should save with a lastUpdated field. This should be used as a date for the `/search` API. Preferred if it's been a long time since an update has happened for a user and/or the user has uploaded a significant amount of media since lastUpdated. +Note: if you've updated the DB recently, it may be more performant to run `node run-downloadDb.js` with `--args="-A {#}"` to simply run the `/media` check instead of the `/search` check, where `-A` will abort the user after `{#}` tries. Args: - `--path={/path/to/your/archive}` -- `--mode={search|media}` - - `search`: The DB should save with a lastUpdated field. This should be used as a date for the /search API. Preferred if it's been a long time since an update has happened for a user and/or the user has uploaded a significant amount of media since lastUpdated. - - `media`: This should run /media and stop after hitting skipped files, as skipped files indicate hitting lastUpdated. Preferred in normal circumstances. - `--threads={#}` - `--args={gallery-dl args}` + +### `run-renameUser.js` + +Should rename an existing user in the db, optionally renaming their existing archive and its contents if `--full=true`. + +Args: +- `--from={'username'}` +- `--to={'username'}` +- `--full={true|false}` +- `--path={/path/to/your/archive}` +- `--args={gallery-dl args}`