Merge pull request #4 from jcdcdev/dev

0.1.1

Author: jcdcdev

.github/README.md

@@ -64,8 +64,8 @@ services:
     environment:
       - SERVICES=s3
       - DEBUG=1
-      - AWS_ACCESS_KEY_ID=test
-      - AWS_SECRET_ACCESS_KEY=test
+      - AWS_ACCESS_KEY_ID=test-id
+      - AWS_SECRET_ACCESS_KEY=test-key
     volumes:
       - ./s3:/persisted-data/
       - ./aws:/etc/localstack/init/ready.d

docs/healthchecks.md

@@ -0,0 +1,31 @@
+# Health Checks
+
+The package includes a suite of health checks to verify the connection to the S3 compatible bucket.
+
+## BucketName
+
+The name of the bucket to use for the S3 compatible service.
+
+Media will be stored withing this bucket under the prefix `media/`.
+Cached image crops will be stored within this bucket under the prefix `cache/`.
+
+## ApplicationKey
+
+Also known as `Access Secret` this is your secret key used to authenticate with the S3 compatible service.
+
+## KeyId
+
+Also known as `Access Key` this is your public key used to authenticate with the S3 compatible service.
+
+## ServiceUrl
+
+The URL of the S3 compatible service.
+
+## Api
+
+1. Ensure the bucket exists
+2. Ensure the Application Key and Key Id are valid
+    - Check the Application Key has read and write permissions to the bucket
+3. Ensure the Service URL is valid
+
+If you can confirm the S3 compatible bucket is accessible but the health check is failing, please raise an [issue](https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2/issues/new?assignees=&labels=bug&projects=&template=bug.yml)

src/TestSite.10/appsettings.json

@@ -18,8 +18,8 @@
           "ServiceUrl": "http://localhost:4566",
           "UseAccelerateEndpoint": false,
           "Credentials": {
-            "ApplicationKey": "test",
-            "KeyId": "test"
+            "ApplicationKey": "test-key",
+            "KeyId": "test-id"
           }
         }
       }
@@ -37,4 +37,4 @@
       }
     }
   }
-}
+}

src/TestSite.12/appsettings.json

@@ -18,8 +18,8 @@
           "ServiceUrl": "http://localhost:4566",
           "UseAccelerateEndpoint": false,
           "Credentials": {
-            "ApplicationKey": "test",
-            "KeyId": "test"
+            "ApplicationKey": "test-key",
+            "KeyId": "test-id"
           }
         }
       }
@@ -37,4 +37,4 @@
       }
     }
   }
-}
+}

src/TestSite.13/appsettings.json

@@ -18,8 +18,8 @@
                     "ServiceUrl": "http://localhost:4566",
                     "UseAccelerateEndpoint": false,
                     "Credentials": {
-                        "ApplicationKey": "test",
-                        "KeyId": "test"
+                        "ApplicationKey": "test-key",
+                        "KeyId": "test-id"
                     }
                 }
             }

src/Umbraco.Community.FileSystemProviders.B2/Constants.cs

@@ -6,13 +6,15 @@ public class Constants
 
     public class HealthChecks
     {
+        public const string DocsLink = "https://github.com/jcdcdev/Umbraco.Community.FileSystemProviders.B2/blob/main/docs/healthchecks.md";
+
         public class BucketName
         {
             public const string Id = "D4D3D3D3-4D3D-4D3D-4D3D-4D3D3D3D3D3D";
             public const string Name = "B2 Bucket Name";
             public const string Description = "Checks if the B2 bucket name is set.";
             public const string ItemPath = $"{Section}:BucketName";
-            public const string ReadMoreLink = "https://our.umbraco.com/Documentation/Extending/FileSystemProviders/B2/";
+            public const string ReadMoreLink = $"{DocsLink}#bucketname";
         }
 
         public class ApplicationKey
@@ -21,7 +23,7 @@ public class ApplicationKey
             public const string Name = "B2 Secret Key";
             public const string Description = "Checks if the B2 secret key is set.";
             public const string ItemPath = $"{Section}:Credentials:KeyId";
-            public const string ReadMoreLink = "https://our.umbraco.com/Documentation/Extending/FileSystemProviders/B2/";
+            public const string ReadMoreLink = $"{DocsLink}#applicationkey";
         }
 
         public class KeyId
@@ -30,7 +32,7 @@ public class KeyId
             public const string Name = "B2 Access Key";
             public const string Description = "Checks if the B2 access key is set.";
             public const string ItemPath = $"{Section}:Credentials:ApplicationKey";
-            public const string ReadMoreLink = "https://our.umbraco.com/Documentation/Extending/FileSystemProviders/B2/";
+            public const string ReadMoreLink = $"{DocsLink}#keyid";
         }
 
         public class ServiceUrl
@@ -39,24 +41,15 @@ public class ServiceUrl
             public const string Name = "B2 Service Url";
             public const string Description = "Checks if the B2 service URL is set.";
             public const string ItemPath = $"{Section}:ServiceUrl";
-            public const string ReadMoreLink = "https://our.umbraco.com/Documentation/Extending/FileSystemProviders/B2/";
-        }
-
-        public class UseAccelerateEndpoint
-        {
-            public const string Id = "9D3D3D3D-4D3D-4D3D-4D3D-4D3D3D3D3D3D";
-            public const string Name = "B2 Use Accelerate Endpoint";
-            public const string Description = "Checks if the B2 use accelerate endpoint is set.";
-            public const string ItemPath = $"{Section}:UseAccelerateEndpoint";
-            public const string ReadMoreLink = "https://our.umbraco.com/Documentation/Extending/FileSystemProviders/B2/";
+            public const string ReadMoreLink = $"{DocsLink}#serviceurl";
         }
 
         public class Api
         {
             public const string Id = "8D3D3D3D-4D3D-4D3D-4D3D-4D3D3D3D3D3D";
             public const string Name = "B2 API";
             public const string Description = "Checks if the B2 API is healthy.";
-            public const string ReadMoreLink = "https://our.umbraco.com/Documentation/Extending/FileSystemProviders/B2/";
+            public const string ReadMoreLink = $"{DocsLink}#api";
         }
 
         public class Groups

src/Umbraco.Community.FileSystemProviders.B2/Models/B2Options.cs

@@ -13,5 +13,5 @@ public class B2Options
     [MemberNotNullWhen(true, nameof(ServiceUrl), nameof(Credentials))]
     public bool Enabled => !string.IsNullOrWhiteSpace(BucketName) && !string.IsNullOrWhiteSpace(ServiceUrl) && (Credentials?.Valid ?? false);
 
-    public AWSCredentials ToCredentials() => new BasicAWSCredentials(Credentials?.KeyId, Credentials?.KeyId);
+    public AWSCredentials ToCredentials() => new BasicAWSCredentials(Credentials?.KeyId, Credentials?.ApplicationKey);
 }

src/Umbraco.Community.FileSystemProviders.B2/Umbraco.Community.FileSystemProviders.B2.csproj

@@ -30,7 +30,6 @@
         <PackageReference Include="Umbraco.Cms.Web.BackOffice" Version="[10.4.0,11.0.0)"/>
         <PackageReference Include="Umbraco.Cms.Web.Common" Version="[10.4.0,11.0.0)"/>
         <PackageReference Include="Our.Umbraco.StorageProviders.AWSS3" Version="1.3.0"/>
-
     </ItemGroup>
 
     <ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
@@ -39,7 +38,6 @@
         <PackageReference Include="Umbraco.Cms.Web.Common" Version="[11.0.0,13.0.0)"/>
         <PackageReference Include="Umbraco.Cms.Imaging.ImageSharp" Version="[11.0.0,13.0.0)"/>
         <PackageReference Include="Our.Umbraco.StorageProviders.AWSS3" Version="1.3.0"/>
-
     </ItemGroup>
 
     <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
@@ -48,7 +46,6 @@
         <PackageReference Include="Umbraco.Cms.Web.Common" Version="[13.0.0,14.0.0)"/>
         <PackageReference Include="Umbraco.Cms.Imaging.ImageSharp" Version="[13.0.0,14.0.0)"/>
         <PackageReference Include="Our.Umbraco.StorageProviders.AWSS3" Version="1.3.0"/>
-
     </ItemGroup>
 
     <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
@@ -61,4 +58,4 @@
         <None Include="..\..\docs\icon.png" Pack="true" PackagePath="images\icon.png"/>
         <None Include="..\..\.github\README.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
-</Project>
+</Project>