Merge pull request #12 from myusrn/master

migrating use of wwwroot/auth to wwwroot/.auth for al

Author: paule96

.gitignore

@@ -329,5 +329,5 @@ ASALocalRun/
 # MFractors (Xamarin productivity tool) working folder
 .mfractor/
 
-**/wwwroot/auth/**/*.*
+**/wwwroot/.auth/**/*.*
 !tools/GitVersion/**/

README.md

@@ -85,7 +85,7 @@ If you want to add roles to the `User` property you can have a look in `Transfor
 
 ### Local Debugging
 
-For debugging your application you can place a `me.json` in the `wwwroot/auth` folder of your web app and add some configuration to the `AddEasyAuth` call.  
+For debugging your application you can place a `me.json` in the `wwwroot/.auth` folder of your web app and add some configuration to the `AddEasyAuth` call.  
 For example:
 
 ```
@@ -94,15 +94,17 @@ For example:
     {
         if (this.Environment.IsDevelopment())
         {
-            options.AuthEndpoint = "auth/me.json";
+            options.AuthEndpoint = ".auth/me.json";
         }
     }
 );
 ```
 
 > **Info**: You can obtain the content for this file from an Azure Web App with EasyAuth configured by requesting the `/.auth/me` endpoint.
 
-> **Info**: Make sure you added static file handling to your pipeline by adding `app.UseStaticFiles();` to your `public void Configure` method in the `Startup.cs`. Otherwise the file can not be found at runtime.
+> **Info**: Make sure you added static file handling to your pipeline by adding `app.UseStaticFiles();` to your `public void Configure` method in the `Startup.cs`, e.g. just after `app.UseHttpsRedirection();` entry. Otherwise the static file can not be found at runtime.
+
+> **Info**: Using a wwwroot sub-folder name that starts with `'.'` , like the suggested `.auth` folder name, is useful for content relevant only for localhost debugging as these are treated as hidden folders and are not included in publish output.
 
 ## Authors
 

src/KK.AspNetCore.EasyAuthAuthentication.Sample/Startup.cs

@@ -44,10 +44,12 @@ public void ConfigureServices(IServiceCollection services)
                     // Override the AuthEndpoint while developing
                     if (this.Environment.IsDevelopment())
                     {
-                        // The me.json should be placed in 'wwwroot/auth'
+                        // The me.json should be placed in 'wwwroot/.auth'
                         // The Static File Handler will not work with files without extension
-                        // so the endpoint should point to a file with extension
-                        options.AuthEndpoint = "auth/me.json";
+                        // so the endpoint should point to a file with extension. Folders that
+                        // start with '.' are considered hidden folders and do not get included
+                        // in publish site output which is desirable in this case.
+                        options.AuthEndpoint = ".auth/me.json";
                     }
                 }
             );