paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: add no-progress-bar option to importer/exporter (#7477)

Browse Source 
---------

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
This commit is contained in:
Nicola Apicella 2024-08-17 04:57:03 +02:00 committed by GitHub
parent 3ea312e136
commit ad8c60d153
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/administration.md
View File

@ -248,6 +248,7 @@ optional arguments:
-z, --zip -z, --zip
-zn, --zip-name -zn, --zip-name
--data-only --data-only
--no-progress-bar
--passphrase --passphrase
``` ```
@ -310,6 +311,10 @@ value set in `-zn` or `--zip-name`.
If `--data-only` is provided, only the database will be exported. This option is intended If `--data-only` is provided, only the database will be exported. This option is intended
to facilitate database upgrades without needing to clean documents and thumbnails from the media directory. to facilitate database upgrades without needing to clean documents and thumbnails from the media directory.
If `--no-progress-bar` is provided, the progress bar will be hidden, rendering the
exporter quiet. This option is useful for scripting scenarios, such as when using the
exporter with `crontab`.
If `--passphrase` is provided, it will be used to encrypt certain fields in the export. This value If `--passphrase` is provided, it will be used to encrypt certain fields in the export. This value
must be provided to import. If this value is lost, the export cannot be imported. must be provided to import. If this value is lost, the export cannot be imported.
@ -331,11 +336,12 @@ and the script does the rest of the work:
document_importer source document_importer source
``` ```
| Option | Required | Default | Description | | Option | Required | Default | Description |
| -------------- | -------- | ------- | ------------------------------------------------------------------------- | | ------------------- | -------- | ------- | ------------------------------------------------------------------------- |
| source | Yes | N/A | The directory containing an export | | source | Yes | N/A | The directory containing an export |
| `--data-only` | No | False | If provided, only import data, do not import document files or thumbnails | | `--no-progress-bar` | No | False | If provided, the progress bar will be hidden |
| `--passphrase` | No | N/A | If your export was encrypted with a passphrase, must be provided | | `--data-only` | No | False | If provided, only import data, do not import document files or thumbnails |
| `--passphrase` | No | N/A | If your export was encrypted with a passphrase, must be provided |
When you use the provided docker compose script, put the export inside When you use the provided docker compose script, put the export inside
the `export` folder in your paperless source directory. Specify the `export` folder in your paperless source directory. Specify