Storage Settings - Revision history

SarahK: /* Configurations */

2023-02-06T14:24:17Z

‎Configurations

SarahK: /* Configurations */

2023-02-06T14:23:51Z

‎Configurations

SarahK at 16:37, 5 May 2022

2022-05-05T16:37:02Z

SarahK at 21:42, 14 April 2022

2022-04-14T21:42:54Z

SarahK: /* Configurations */

2022-03-14T14:30:43Z

‎Configurations

SarahK at 19:36, 21 January 2022

2022-01-21T19:36:17Z

SarahK at 18:28, 21 January 2022

2022-01-21T18:28:12Z

SarahK at 14:02, 21 January 2022

2022-01-21T14:02:43Z

SarahK: /* Development/Test Environment */

2022-01-21T13:59:34Z

‎Development/Test Environment

PeterM: Development/Test Environment

2021-05-17T15:18:02Z

Development/Test Environment

@@ Line 23: / Line 23: @@
 <div class="docs-alert-warning">
-Amazon S3 storage locations '''must''' have the required access credentials. For more information and a list of the required settings for Amazon S3 storage locations, see [[Migrating Between Storage Locations]].
+Amazon S3™ storage locations '''must''' have the required access credentials. For more information and a list of the required settings for Amazon S3 storage locations, see [[Migrating Between Storage Locations]].
 </div>

← Older revision		Revision as of 14:23, 6 February 2023
Line 21:		Line 21:

	The '''Configurations''' tab lets you test, duplicate, configure, and delete your individual storage locations. You can also add new storage configurations.		The '''Configurations''' tab lets you test, duplicate, configure, and delete your individual storage locations. You can also add new storage configurations.
		+
		+	<div class="docs-alert-warning">
		+	Amazon S3 storage locations '''must''' have the required access credentials. For more information and a list of the required settings for Amazon S3 storage locations, see [[Migrating Between Storage Locations]].
		+	</div>

	For more information, see [[Testing WHMCS]].		For more information, see [[Testing WHMCS]].

@@ Line 1: / Line 1: @@
 WHMCS includes settings to control storage for various types of files.
-You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings'''.
+You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''' or, prior to WHMCS 8.0, '''Setup > Storage Settings'''.
 ==Settings==

@@ Line 1: / Line 1: @@
-You can manage your storage settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings'''.
+WHMCS includes settings to control storage for various types of files.
 ==Settings==
 The '''Settings''' tab allows you to select storage locations for:
 * '''Client Files'''
 * '''Downloads'''

← Older revision		Revision as of 14:30, 14 March 2022
Line 18:		Line 18:

	The '''Configurations''' tab lets you test, duplicate, configure, and delete your individual storage locations. You can also add new storage configurations.		The '''Configurations''' tab lets you test, duplicate, configure, and delete your individual storage locations. You can also add new storage configurations.
		+
		+	For more information, see [[Testing WHMCS]].

	===Existing Storage===		===Existing Storage===

@@ Line 1: / Line 1: @@
-==Configuration==
+You can manage your storage settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings'''.
-To manage your storage settings, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings'''. Choose one of the following workflows depending on the desired use case:
+==Settings==
-===Local Storage===
+The '''Settings''' tab allows you to select storage locations for:
-To migrate files from an existing local storage location to another local directory:
+To change the current storage location, select the desired location from the menu.
-{{LocalStorage}}
+==Configurations==
-===AWS S3===
+The '''Configurations''' tab lets you test, duplicate, configure, and delete your individual storage locations. You can also add new storage configurations.
-After you configure the storage bucket, you may want to migrate files to an AWS S3 bucket or a compatible service. If you are familiar with AWS S3, follow these steps:
+===Existing Storage===
-#Click the '''Configuration''' tab.
+For existing storage locations:
-You may choose to cancel an ongoing migration. If you do, the system will continue to use the present location. Files that the system already migrated to the new location will remain.
+* Click the play icon to test the storage location.
-Instead of using automated migration, you may opt to migrate your files manually and switch the relevant file types storage setting at once. This will skip automatic migration and you will be responsible for moving the files to the new location. If you use this method, note that WHMCS may store certain file types in the same folder (for example, the system will store client files, email and ticket attachments, and project management files in the <tt>attachments</tt> folder). If you decide to move all the files away from that local folder, you must switch all relevant file types to the new location.
+===Add New Configuration===
-If you made a change by mistake, click '''Revert Changes''' to cancel any changes.
+To add a new storage configuration:
-====Example Security Policy====
+# Choose a type of storage from the menu and click the + icon.
-Consider using the [https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html IAM Policy Generator tool] in the AWS control panel, or the [https://awspolicygen.s3.amazonaws.com/policygen.html public policy generator tool].
+# Enter the requested information.
-For power users, an example AWS S3 policy to assign to the S3 user for use with WHMCS storage settings is below:
+# Click '''Save Changes'''.
+==Migrating to a New Storage Location==
-'''Note for manual migration only''': The system stores files in AWS S3 with a prefix corresponding to the file asset type. For example, it will store file1.png, a client file, as /client_files/file1.png. Use the following sub-folder names per file type:
+You may want to migrate files from one local storage location to another, or from an existing storage location to an AWS S3 bucket or a compatible service.
-* Client Files — client_files
+* For more information about migrating your files, see [[Migrating Between Storage Locations]].
-* Downloads — downloads
+* For steps to troubleshoot '''File Not Found''' errors during migrations, see [[Troubleshooting a File Not Found Error]].

← Older revision		Revision as of 18:28, 21 January 2022
Line 85:		Line 85:

	===Troubleshooting a File Not Found Error===		===Troubleshooting a File Not Found Error===
−	If you experience a '''File not found''' error, this may mean that a file is not present or is not accessible at the expected location. To validate that a file is present in the local storage, check that the file exists and its permissions allow access to the web user. For AWS S3, use AWS (or your compatible storage provider's) console to verify that the file is stored with the indicated key.

−	~~A convenient way to confirm storage location accessibility is to use the~~ '''~~Test Configuration~~''' ~~feature. To do~~ that~~, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''', click '''Configurations''' tab, choose~~ a ~~configuration you want to test, and click~~ the ~~'''Test''' icon~~. For ~~AWS S3 (or compatible providers)~~ this ~~should also indicate whether there are any issues with the provided Access Key / Access Secret~~.	+	If you experience a '''File not found''' error, this may mean that a file is not present or is not accessible at the expected location.
		+
		+	For steps to troubleshoot this, see [[Troubleshooting a File Not Found Error]].

← Older revision		Revision as of 14:02, 21 January 2022
Line 88:		Line 88:

	A convenient way to confirm storage location accessibility is to use the '''Test Configuration''' feature. To do that, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''', click '''Configurations''' tab, choose a configuration you want to test, and click the '''Test''' icon. For AWS S3 (or compatible providers) this should also indicate whether there are any issues with the provided Access Key / Access Secret.		A convenient way to confirm storage location accessibility is to use the '''Test Configuration''' feature. To do that, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''', click '''Configurations''' tab, choose a configuration you want to test, and click the '''Test''' icon. For AWS S3 (or compatible providers) this should also indicate whether there are any issues with the provided Access Key / Access Secret.
−
−	~~===Development and Test Environments===~~
−	~~When you use local storage locations and are switching between development (test) or live environments, it's important to update your storage settings.~~
−
−	~~For more information, see [[Testing WHMCS]].~~

@@ Line 89: / Line 89: @@
 A convenient way to confirm storage location accessibility is to use the '''Test Configuration''' feature. To do that, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''', click '''Configurations''' tab, choose a configuration you want to test, and click the '''Test''' icon. For AWS S3 (or compatible providers) this should also indicate whether there are any issues with the provided Access Key / Access Secret.
-===Development/Test Environment===
+===Development and Test Environments===
-When you use local storage locations and are switching between development (test) or live environments, it's important to update your storage settings. If the configured storage locations are not present on your server, certain features (such as sending emails) may not function correctly.
+When you use local storage locations and are switching between development (test) or live environments, it's important to update your storage settings.
-Please see our documentation on [https://docs.whmcs.com/Moving_Storage_Locations#Local_Storage creating local storage locations] and [https://docs.whmcs.com/Moving_Storage_Locations#Migrate_to_new_Storage_Locations migrating to new storage locations].
+For more information, see [[Testing WHMCS]].

← Older revision		Revision as of 15:18, 17 May 2021
Line 88:		Line 88:

	A convenient way to confirm storage location accessibility is to use the '''Test Configuration''' feature. To do that, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''', click '''Configurations''' tab, choose a configuration you want to test, and click the '''Test''' icon. For AWS S3 (or compatible providers) this should also indicate whether there are any issues with the provided Access Key / Access Secret.		A convenient way to confirm storage location accessibility is to use the '''Test Configuration''' feature. To do that, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Storage Settings''', click '''Configurations''' tab, choose a configuration you want to test, and click the '''Test''' icon. For AWS S3 (or compatible providers) this should also indicate whether there are any issues with the provided Access Key / Access Secret.
		+
		+	===Development/Test Environment===
		+	When you use local storage locations and are switching between development (test) or live environments, it's important to update your storage settings. If the configured storage locations are not present on your server, certain features (such as sending emails) may not function correctly.
		+
		+	Please see our documentation on [https://docs.whmcs.com/Moving_Storage_Locations#Local_Storage creating local storage locations] and [https://docs.whmcs.com/Moving_Storage_Locations#Migrate_to_new_Storage_Locations migrating to new storage locations].