Difference between revisions of "Template:LocalStorage"
From WHMCS Documentation
(Create template for local storage creation for use in multiple pages) |
|||
| Line 1: | Line 1: | ||
| − | # | + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Storage Settings]]''' or, prior to WHMCS 8.0, '''Setup > Storage Settings'''. |
| − | # | + | # Choose the '''Configuration''' tab. |
| − | #Enter path to the new storage location. The directory must exist and be writable | + | # Under '''Add New Configuration''', choose '''Local Storage''' and click '''Add'''. |
| − | # | + | # Enter path to the new storage location and click '''Save'''. The directory must exist and be writable. |
| − | #Select the new storage location for the file type that you wish to migrate to the new location. | + | # Choose the '''Settings''' tab. |
| − | # | + | # Select the new storage location for the file type that you wish to migrate to the new location. |
| + | # Click '''Migrate''' when the system prompts you to migrate the files automatically. | ||
#*For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. | #*For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location. | ||
#*If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. | #*If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location. | ||
| − | #* | + | #* Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file type's storage setting immediately. |
| − | + | #** This will skip automatic migration and assumes your responsibility for moving the files to the new location. | |
| − | + | #** Some file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that folder, all relevant file types must be switched to the new location. | |
| − | #* | + | # After the automatic migration finishes, validate whether the migration was successful. |
| − | #If you | + | # Delete the files in the prior location. The system will not automatically delete these files. |
| + | |||
| + | You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted. | ||
| + | |||
| + | If you make a change by mistake, click "Revert Changes" to cancel any changes. | ||
Revision as of 18:32, 26 April 2022
- Go to Configuration () > System Settings > Storage Settings or, prior to WHMCS 8.0, Setup > Storage Settings.
- Choose the Configuration tab.
- Under Add New Configuration, choose Local Storage and click Add.
- Enter path to the new storage location and click Save. The directory must exist and be writable.
- Choose the Settings tab.
- Select the new storage location for the file type that you wish to migrate to the new location.
- Click Migrate when the system prompts you to migrate the files automatically.
- For smaller scale deployments, migration will take less than a minute, and your files will then be stored at the new location.
- If the migration cannot be completed immediately, it will be scheduled to run in the background. Until it is completed, the former location will continue to be used. Once all files are migrated to the new location, the setting will automatically switch to the new selection and begin using the new location.
- Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file type's storage setting immediately.
- This will skip automatic migration and assumes your responsibility for moving the files to the new location.
- Some file types may be stored by WHMCS in the same folder (for example, client files, email and ticket attachments as well as project management files will be stored in "attachments" folder). If you decide to move all the files away from that folder, all relevant file types must be switched to the new location.
- After the automatic migration finishes, validate whether the migration was successful.
- Delete the files in the prior location. The system will not automatically delete these files.
You may choose to cancel an ongoing migration. The present location will then continue to be used. Files migrated to the new location until this point will not be deleted.
If you make a change by mistake, click "Revert Changes" to cancel any changes.