mirror of
				https://github.com/paperless-ngx/paperless-ngx.git
				synced 2025-10-31 10:37:12 -04:00 
			
		
		
		
	Fixes up various doc sections (#6883)
This commit is contained in:
		
							parent
							
								
									d2883b83c5
								
							
						
					
					
						commit
						5fc6736666
					
				| @ -192,35 +192,6 @@ You may also use the exporter and importer with the `--data-only` flag, after cr | |||||||
|     You should not change any settings, especially paths, when doing this or there is a |     You should not change any settings, especially paths, when doing this or there is a | ||||||
|     risk of data loss |     risk of data loss | ||||||
| 
 | 
 | ||||||
| ## Downgrading Paperless {#downgrade-paperless} |  | ||||||
| 
 |  | ||||||
| Downgrades are possible. However, some updates also contain database |  | ||||||
| migrations (these change the layout of the database and may move data). |  | ||||||
| In order to move back from a version that applied database migrations, |  | ||||||
| you'll have to revert the database migration _before_ downgrading, and |  | ||||||
| then downgrade paperless. |  | ||||||
| 
 |  | ||||||
| This table lists the compatible versions for each database migration |  | ||||||
| number. |  | ||||||
| 
 |  | ||||||
| | Migration number | Version range   | |  | ||||||
| | ---------------- | --------------- | |  | ||||||
| | 1011             | 1.0.0           | |  | ||||||
| | 1012             | 1.1.0 - 1.2.1   | |  | ||||||
| | 1014             | 1.3.0 - 1.3.1   | |  | ||||||
| | 1016             | 1.3.2 - current | |  | ||||||
| 
 |  | ||||||
| Execute the following management command to migrate your database: |  | ||||||
| 
 |  | ||||||
| ```shell-session |  | ||||||
| $ python3 manage.py migrate documents <migration number> |  | ||||||
| ``` |  | ||||||
| 
 |  | ||||||
| !!! note |  | ||||||
| 
 |  | ||||||
|     Some migrations cannot be undone. The command will issue errors if that |  | ||||||
|     happens. |  | ||||||
| 
 |  | ||||||
| ## Management utilities {#management-commands} | ## Management utilities {#management-commands} | ||||||
| 
 | 
 | ||||||
| Paperless comes with some management commands that perform various | Paperless comes with some management commands that perform various | ||||||
| @ -602,7 +573,7 @@ Enabling encryption is no longer supported. | |||||||
| 
 | 
 | ||||||
| Basic usage to disable encryption of your document store: | Basic usage to disable encryption of your document store: | ||||||
| 
 | 
 | ||||||
| (Note: If [`PAPERLESS_PASSPHRASE`](configuration.md#PAPERLESS_PASSPHRASE) isn't set already, you need to specify | (Note: If `PAPERLESS_PASSPHRASE` isn't set already, you need to specify | ||||||
| it here) | it here) | ||||||
| 
 | 
 | ||||||
| ``` | ``` | ||||||
|  | |||||||
| @ -11,7 +11,7 @@ The API provides the following main endpoints: | |||||||
| - `/api/correspondents/`: Full CRUD support. | - `/api/correspondents/`: Full CRUD support. | ||||||
| - `/api/custom_fields/`: Full CRUD support. | - `/api/custom_fields/`: Full CRUD support. | ||||||
| - `/api/documents/`: Full CRUD support, except POSTing new documents. | - `/api/documents/`: Full CRUD support, except POSTing new documents. | ||||||
|   See [below](#posting-documents-file-uploads). |   See [below](#file-uploads). | ||||||
| - `/api/document_types/`: Full CRUD support. | - `/api/document_types/`: Full CRUD support. | ||||||
| - `/api/groups/`: Full CRUD support. | - `/api/groups/`: Full CRUD support. | ||||||
| - `/api/logs/`: Read-Only. | - `/api/logs/`: Read-Only. | ||||||
|  | |||||||
| @ -676,24 +676,37 @@ commands as well. | |||||||
| 1.  Stop and remove the paperless container | 1.  Stop and remove the paperless container | ||||||
| 2.  If using an external database, stop the container | 2.  If using an external database, stop the container | ||||||
| 3.  Update Redis configuration | 3.  Update Redis configuration | ||||||
|     a) If `REDIS_URL` is already set, change it to [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) | 
 | ||||||
|     and continue to step 4. |     1. If `REDIS_URL` is already set, change it to [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) | ||||||
|     b) Otherwise, in the `docker-compose.yml` add a new service for |        and continue to step 4. | ||||||
|     Redis, following [the example compose | 
 | ||||||
|     files](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) |     1. Otherwise, in the `docker-compose.yml` add a new service for | ||||||
|     c) Set the environment variable [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) so it points to |        Redis, following [the example compose | ||||||
|     the new Redis container |        files](https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose) | ||||||
|  | 
 | ||||||
|  |     1. Set the environment variable [`PAPERLESS_REDIS`](configuration.md#PAPERLESS_REDIS) so it points to | ||||||
|  |        the new Redis container | ||||||
|  | 
 | ||||||
| 4.  Update user mapping | 4.  Update user mapping | ||||||
|     a) If set, change the environment variable `PUID` to `USERMAP_UID` | 
 | ||||||
|     b) If set, change the environment variable `PGID` to `USERMAP_GID` |     1. If set, change the environment variable `PUID` to `USERMAP_UID` | ||||||
|  | 
 | ||||||
|  |     1. If set, change the environment variable `PGID` to `USERMAP_GID` | ||||||
|  | 
 | ||||||
| 5.  Update configuration paths | 5.  Update configuration paths | ||||||
|     a) Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config` | 
 | ||||||
|  |     1. Set the environment variable [`PAPERLESS_DATA_DIR`](configuration.md#PAPERLESS_DATA_DIR) to `/config` | ||||||
|  | 
 | ||||||
| 6.  Update media paths | 6.  Update media paths | ||||||
|     a) Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to | 
 | ||||||
|     `/data/media` |     1. Set the environment variable [`PAPERLESS_MEDIA_ROOT`](configuration.md#PAPERLESS_MEDIA_ROOT) to | ||||||
|  |        `/data/media` | ||||||
|  | 
 | ||||||
| 7.  Update timezone | 7.  Update timezone | ||||||
|     a) Set the environment variable [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to the same | 
 | ||||||
|     value as `TZ` |     1. Set the environment variable [`PAPERLESS_TIME_ZONE`](configuration.md#PAPERLESS_TIME_ZONE) to the same | ||||||
|  |        value as `TZ` | ||||||
|  | 
 | ||||||
| 8.  Modify the `image:` to point to | 8.  Modify the `image:` to point to | ||||||
|     `ghcr.io/paperless-ngx/paperless-ngx:latest` or a specific version |     `ghcr.io/paperless-ngx/paperless-ngx:latest` or a specific version | ||||||
|     if preferred. |     if preferred. | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user