lightling/gallery-dl-archive-manager
1
0
Fork 0
Code Activity

Update README.md

Browse source
This commit is contained in:
lightling 2024-02-09 23:07:27 -05:00
parent 3c2b9afc13
commit 2eca690d7f
1 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -7,11 +7,22 @@ This repo uses its own `config.json` in order to save media in the same format a
## Scripts
### `node run-initDb.js --path={/path/to/your/archive} --args={gallery-dl args}`
### `node run-initDb.js`
Initializes a user database from existing folders. Useful if you have a pre-existing archive of users.
### `node run-downloadDb.js --path={/path/to/your/archive} --threads={#} --args={gallery-dl args}`
Args:
- `--path={/path/to/your/archive}`
- `--args={gallery-dl args}`
### `node run-downloadDb.js`
Runs a full download of all users listed in the db.json of the archive (the provided `--path`).
Args:
- `--path={/path/to/your/archive}`
- `--threads={#}`
- `--args={gallery-dl args}`
## Args
@ -31,14 +42,23 @@ Additional args to pass to gallery-dl. Note that these aren't currently checked
## TODO
### `run-addUsers.js --path={/path/to/your/archive} --users={string array of user(s)} --threads={#}`
### `run-addUsers.js`
Should add a new user to the db and initiate a full download similar to `run-downloadDb.js`
### `run-updateDb.js --path={/path/to/your/archive} --mode={search|media} --threads={#} --args={gallery-dl args}`
Args:
- `--path={/path/to/your/archive}`
- `--users={string array of user(s)}`
- `--threads={#}`
### `run-updateDb.js`
Should pull from the user database and update the archive without doing a full download.
- `--mode`
- `=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 will run /media and stop after hitting skipped files, as skipped files indicate hitting lastUpdated. Preferred in normal circumstances.
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}`