-
+
# Read the [Wiki :blue_book:](https://github.com/serilog-contrib/serilog-ui/wiki)
-## Quick Start :dash:
+## Quick Start
### Nuget packages installation
@@ -36,16 +35,16 @@ dotnet add package Serilog.UI
Install-Package Serilog.UI
```
-Install one of the available providers, based upon your sink:
+Install one or more of the available providers, based upon your sink(s):
-| Provider | install: dotnet | install: pkg manager |
-| --- | --- | --- |
-| **Serilog.UI.MsSqlServerProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.MsSqlServerProvider)] | `dotnet add package Serilog.UI.MsSqlServerProvider` | `Install-Package Serilog.UI.MsSqlServerProvider` |
-| **Serilog.UI.MySqlProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.MySqlProvider)] | `dotnet add package Serilog.UI.MySqlProvider` | `Install-Package Serilog.UI.MySqlProvider` |
-| **Serilog.UI.PostgreSqlProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.PostgreSqlProvider)] | `dotnet add package Serilog.UI.PostgreSqlProvider` | `Install-Package Serilog.UI.PostgreSqlProvider` |
-| **Serilog.UI.MongoDbProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.MongoDbProvider)] | `dotnet add package Serilog.UI.MongoDbProvider` | `Install-Package Serilog.UI.MongoDbProvider` |
+| Provider | install: dotnet | install: pkg manager |
+| --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -------------------------------------------------- |
+| **Serilog.UI.MsSqlServerProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.MsSqlServerProvider)] | `dotnet add package Serilog.UI.MsSqlServerProvider` | `Install-Package Serilog.UI.MsSqlServerProvider` |
+| **Serilog.UI.MySqlProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.MySqlProvider)] | `dotnet add package Serilog.UI.MySqlProvider` | `Install-Package Serilog.UI.MySqlProvider` |
+| **Serilog.UI.PostgreSqlProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.PostgreSqlProvider)] | `dotnet add package Serilog.UI.PostgreSqlProvider` | `Install-Package Serilog.UI.PostgreSqlProvider` |
+| **Serilog.UI.MongoDbProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.MongoDbProvider)] | `dotnet add package Serilog.UI.MongoDbProvider` | `Install-Package Serilog.UI.MongoDbProvider` |
| **Serilog.UI.ElasticSearchProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.ElasticSearchProvider)] | `dotnet add package Serilog.UI.ElasticSearchProvider` | `Install-Package Serilog.UI.ElasticSearchProvider` |
-| **Serilog.UI.RavenDbProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.RavenDbProvider)] | `dotnet add package Serilog.UI.RavenDbProvider` | `Install-Package Serilog.UI.RavenDbProvider` |
+| **Serilog.UI.RavenDbProvider** [[NuGet](https://www.nuget.org/packages/Serilog.UI.RavenDbProvider)] | `dotnet add package Serilog.UI.RavenDbProvider` | `Install-Package Serilog.UI.RavenDbProvider` |
### DI registration
@@ -54,16 +53,18 @@ Add `AddSerilogUi()` to `IServiceCollection` in your `Startup.ConfigureServices`
```csharp
public void ConfigureServices(IServiceCollection services)
{
- // Register the serilog UI services
- services.AddSerilogUi(options =>
- // each provider exposes extension methods to configure.
- // example with MSSqlServerProvider:
- options.UseSqlServer("ConnectionString", "LogTableName"));
+ // Register the serilog UI services
+ services.AddSerilogUi(options => options// each provider exposes extension methods to configure.
+ // example with MSSqlServerProvider:
+ .UseSqlServer(opts => opts
+ .WithConnectionString("YOUR_CONNECTION_STRING")
+ .WithTable("YOUR_TABLE")));
}
```
-In the `Startup.Configure` method, enable the middleware to serve the log UI page.
-Note: call to the `UseSerilogUi` middleware must be placed **_after_** any Authentication and Authorization middleware, otherwise the authentication may not work:
+In the `Startup.Configure` method or on the WebApplication builder, enable the middleware to serve the log UI page.
+
+NOTE: call to the `UseSerilogUi` middleware must be placed **_after_** any Authentication and Authorization middleware!
```csharp
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
@@ -73,34 +74,59 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
-
+
// Enable middleware to serve log-ui (HTML, JS, CSS, etc.).
- app.UseSerilogUi();
+ app.UseSerilogUi(opts => [...]);
(...)
-
- app.UseEndpoints(endpoints =>
- {
- endpoints.MapControllerRoute(
- name: "default",
- pattern: "{controller=Home}/{action=Index}/{id?}");
- });
}
```
-### For further configuration: [:fast_forward:](https://github.com/serilog-contrib/serilog-ui/wiki/Install:-Configuration-Options)
-
-## Running the Tests: [:test_tube:](https://github.com/serilog-contrib/serilog-ui/wiki/Development:-Testing)
-
-## License
+### For further configuration: [:fast_forward:](https://github.com/serilog-contrib/serilog-ui/wiki/Configure)
-See [LICENSE](https://github.com/serilog-contrib/serilog-ui/blob/master/LICENSE).
+Do you want to test the package on-the-fly? Try out the [samples](https://github.com/serilog-contrib/serilog-ui/wiki/Develop#sample-applications), with no configuration required!
## Issues and Contribution
Everything is welcome! :trophy: See the [contribution guidelines](https://github.com/serilog-contrib/serilog-ui/blob/master/CONTRIBUTING.md) for details.
-## Support
-Thank you [JetBrains](https://www.jetbrains.com/community/opensource/#support) for supporting this project.
+For details on running the project, start reading from [Develop](https://github.com/serilog-contrib/serilog-ui/wiki/Develop).
+
+## License
+
+See [LICENSE](https://github.com/serilog-contrib/serilog-ui/blob/master/LICENSE).
-
+## Project Sponsors
+
+
+
+## Contributors
+
+
+
+
+ Mohsen Esmailpour 💻 📆 ⚠️ |
+  Matteo Gregoricchio 💻 📖 ⚠️ |
+  sommmen 💻 |
+  Israel Gómez de Celis 💻 |
+  Osama Bashir 💻 |
+  Ricardo 💻 |
+  Caleb Hanson 💻 |
+  Aleksei 💻 |
+  chaadfh 💻 |
+  Phill Duffy 💻 |
+
 Uthman 💻 |
+  jorgevp 💻 |
+
Yarn is a package manager that doubles down as project manager. Whether you work on one-shot projects or large monorepos, as a hobbyist or an enterprise user, we've got you covered.
+///For more details, visit the official website.
+///Yarn is a package manager that doubles down as project manager. Whether you work on one-shot projects or large monorepos, as a hobbyist or an enterprise user, we've got you covered.
+ ///For more details, visit the official website.
+ ///