Merge branch 'docs/new_user' into 'develop'
CLI_tasks/user.md: Fix `pleroma.user new` documentation Closes #1621 See merge request pleroma/pleroma!2286
This commit is contained in:
		
							parent
							
								
									e7837bc14e
								
							
						
					
					
						commit
						2183d8f849
					
				
					 6 changed files with 20 additions and 20 deletions
				
			
		|  | @ -10,11 +10,11 @@ | ||||||
| Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once if the instance was created before Pleroma 1.0.5. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration. | Replaces embedded objects with references to them in the `objects` table. Only needs to be ran once if the instance was created before Pleroma 1.0.5. The reason why this is not a migration is because it could significantly increase the database size after being ran, however after this `VACUUM FULL` will be able to reclaim about 20% (really depends on what is in the database, your mileage may vary) of the db size before the migration. | ||||||
| 
 | 
 | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
| ./bin/pleroma_ctl database remove_embedded_objects [<options>] | ./bin/pleroma_ctl database remove_embedded_objects [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.database remove_embedded_objects [<options>] | mix pleroma.database remove_embedded_objects [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ### Options | ### Options | ||||||
|  | @ -28,11 +28,11 @@ This will prune remote posts older than 90 days (configurable with [`config :ple | ||||||
|     The disk space will only be reclaimed after `VACUUM FULL`. You may run out of disk space during the execution of the task or vacuuming if you don't have about 1/3rds of the database size free. |     The disk space will only be reclaimed after `VACUUM FULL`. You may run out of disk space during the execution of the task or vacuuming if you don't have about 1/3rds of the database size free. | ||||||
| 
 | 
 | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
| ./bin/pleroma_ctl database prune_objects [<options>] | ./bin/pleroma_ctl database prune_objects [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.database prune_objects [<options>] | mix pleroma.database prune_objects [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ### Options | ### Options | ||||||
|  |  | ||||||
|  | @ -5,11 +5,11 @@ | ||||||
| ## Send digest email since given date (user registration date by default) ignoring user activity status. | ## Send digest email since given date (user registration date by default) ignoring user activity status. | ||||||
| 
 | 
 | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
|  ./bin/pleroma_ctl digest test <nickname> [<since_date>] |  ./bin/pleroma_ctl digest test <nickname> [since_date] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.digest test <nickname> [<since_date>] | mix pleroma.digest test <nickname> [since_date] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -5,11 +5,11 @@ | ||||||
| ## Lists emoji packs and metadata specified in the manifest | ## Lists emoji packs and metadata specified in the manifest | ||||||
| 
 | 
 | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
| ./bin/pleroma_ctl emoji ls-packs [<options>] | ./bin/pleroma_ctl emoji ls-packs [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.emoji ls-packs [<options>] | mix pleroma.emoji ls-packs [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | @ -19,11 +19,11 @@ mix pleroma.emoji ls-packs [<options>] | ||||||
| ## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME` | ## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME` | ||||||
| 
 | 
 | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
| ./bin/pleroma_ctl emoji get-packs [<options>] <packs> | ./bin/pleroma_ctl emoji get-packs [option ...] <pack ...> | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.emoji get-packs [<options>] <packs> | mix pleroma.emoji get-packs [option ...] <pack ...> | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ### Options | ### Options | ||||||
|  |  | ||||||
|  | @ -4,11 +4,11 @@ | ||||||
| 
 | 
 | ||||||
| ## Generate a new configuration file | ## Generate a new configuration file | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
|  ./bin/pleroma_ctl instance gen [<options>] |  ./bin/pleroma_ctl instance gen [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.instance gen [<options>] | mix pleroma.instance gen [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
|  | @ -4,11 +4,11 @@ | ||||||
| 
 | 
 | ||||||
| ## Migrate uploads from local to remote storage | ## Migrate uploads from local to remote storage | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
|  ./bin/pleroma_ctl uploads migrate_local <target_uploader> [<options>] |  ./bin/pleroma_ctl uploads migrate_local <target_uploader> [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.uploads migrate_local <target_uploader> [<options>] | mix pleroma.uploads migrate_local <target_uploader> [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ### Options | ### Options | ||||||
|  |  | ||||||
|  | @ -5,11 +5,11 @@ | ||||||
| ## Create a user | ## Create a user | ||||||
| 
 | 
 | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
| ./bin/pleroma_ctl user new <email> [<options>] | ./bin/pleroma_ctl user new <nickname> <email> [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.user new <email> [<options>] | mix pleroma.user new <nickname> <email> [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | @ -33,11 +33,11 @@ mix pleroma.user list | ||||||
| 
 | 
 | ||||||
| ## Generate an invite link | ## Generate an invite link | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
|  ./bin/pleroma_ctl user invite [<options>] |  ./bin/pleroma_ctl user invite [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.user invite [<options>] | mix pleroma.user invite [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
|  | @ -137,11 +137,11 @@ mix pleroma.user reset_password <nickname> | ||||||
| 
 | 
 | ||||||
| ## Set the value of the given user's settings | ## Set the value of the given user's settings | ||||||
| ```sh tab="OTP" | ```sh tab="OTP" | ||||||
|  ./bin/pleroma_ctl user set <nickname> [<options>] |  ./bin/pleroma_ctl user set <nickname> [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ```sh tab="From Source" | ```sh tab="From Source" | ||||||
| mix pleroma.user set <nickname> [<options>] | mix pleroma.user set <nickname> [option ...] | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
| ### Options | ### Options | ||||||
|  |  | ||||||
		Loading…
	
		Reference in a new issue
	
	 rinpatch
						rinpatch