favicon

some docs changes

Author: brunobritodev

README.md

@@ -1,33 +1,52 @@
 ![image](https://github.com/brunohbrito/JP-Project/blob/master/docs/images/logo.png?raw=true)
 
 [![Build status](https://ci.appveyor.com/api/projects/status/08v6mg6q439x16xt?svg=true)](https://ci.appveyor.com/project/brunohbrito/jp-project)
-[![License](https://img.shields.io/github/license/brunohbrito/jp-project)](LICENSE)
-
+[![License](https://img.shields.io/github/license/brunohbrito/jp-project.svg)](LICENSE)
 
 Jp Project is a Open Source Quickstart for IdentityServer4. 
 
+[<img align="right" width="100px" src="https://dotnetfoundation.org/images/logo_big.svg" />](https://dotnetfoundation.org/projects?q=identityserver&type=project)
 Written in ASP.NET Core and Angular 6.
-
 The main goal of project is to be a Management Ecosystem for IdentityServer4. Helping Startup's and Organization to Speed Up the Setup of User Management. Helping teams and entrepreneurs to achieve the company's primary purpose: Maximize shareholder value.
 
 ## Give a Star! :star:
-------------
 
 Do you love it? give us a Star!
 
+## How to build
+Jp Project is built against ASP.NET Core 2.1.
+
+* [Install](https://www.microsoft.com/net/download/core#/current) the latest .NET Core 2.1 SDK
+* Run `build.ps1` (Powershell) or `build.bat` (cmd)
+
+Wait for ng to complete his proccess then run!
+
+# Expected after start project.
+
+## SSO
+<img src="https://github.com/brunohbrito/JP-Project/blob/master/docs/images/expectedsso.JPG?raw=true" width="480" />
+
+## User managemente API
+<img src="https://github.com/brunohbrito/JP-Project/blob/master/docs/images/expectedusermanagement.JPG?raw=true" width="480" />
+
+## User Management UI
+<img src="https://github.com/brunohbrito/JP-Project/blob/master/docs/images/expectedangular.JPG?raw=true" width="480" />
+
+Any doubts? Go to docs
+
 ## Docs
------
+
 Wanna start? please [Read the docs](https://jp-project.readthedocs.io/en/latest/index.html)
 
 ## Contributing
-------------
+
 We'll love it! Please [Read the docs](https://jp-project.readthedocs.io/en/latest/index.html)
 
 ## Free
-----
+
 If you need help building or running your Jp Project platform
 There are several ways we can help you out.
 
 # What comes next?
-------------------
+
 Admin panel to manage IdentityServer4 configuration.

docs/configuration/certificate.rst

@@ -0,0 +1,14 @@
+Certificate
+===========
+
+Self-signed Certificate
+-----------------------
+To generate certificates, there is a Script ``key\cert.ps1`` that generate Self Signed Certificates.
+You can use it to generate certificate and user against docker, or test in your local.
+
+Open up a PowerShell terminal and run the script. It’ll ask you for a certificate name, password, and then save it for you.
+
+Change Config file
+^^^^^^^^^^^^^^^^^^
+
+If a certificate is generated, to use it, change the appsettings.json. See `docs <quickstarts/ambient_variables.html>`_ for more info

docs/configuration/sql_server.rst

@@ -20,3 +20,13 @@ The file ``Startup.cs`` of **Jp.UI.SSO** and **Jp.UserManagement** has the confi
 
 Both of them must point to the same config Database. You just need to config **Connection String** at Environment or at ``appsettings.json``. For Environment see `docs here <quickstarts/ambient_variables.html>`_
 
+SQL on Docker
+-------------
+
+Don't have the SQL Server on you local machine? Use it from Docker
+
+.. code::
+
+   docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=@Password1' -e 'MSSQL_PID=Express' -p 1433:1433 -d microsoft/mssql-server-linux:latest
+
+As simple as that!

docs/images/expectedangular.JPG

@@ -14,7 +14,13 @@ The main goal of project is to be a Management Ecosystem for IdentityServer4. He
 
 Helping teams and entrepreneurs to achieve the company's primary purpose: Maximize shareholder value.
 
-Liked?
+See it in action
+
+.. raw:: html
+
+    <div style="position: relative; height: 0; overflow: hidden; max-width: 100%; height: auto;">
+        <iframe src="https://player.vimeo.com/video/288481888?color=ff9933&title=0&byline=0" width="800" height="350" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+    </div>
 
 Give a Star!
 ------------
@@ -61,4 +67,5 @@ There are several ways we can help you out.
    configuration/sql_server
    configuration/mysql
    configuration/serilog
-   configuration/application_insights
+   configuration/application_insights
+   configuration/certificate

docs/images/expectedsso.JPG

@@ -43,7 +43,7 @@ Open powershell as Admin. Navigate to build folder. Execute these commands:
 .. raw:: html
 
     <div style="position: relative; height: 0; overflow: hidden; max-width: 100%; height: auto;">
-        <iframe src="https://player.vimeo.com/video/288753436?color=ff9933&title=0&byline=0" width="800" height="600" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+        <iframe src="https://player.vimeo.com/video/288753436?color=ff9933&title=0&byline=0" width="800" height="480" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
     </div>
 
 

docs/images/expectedusermanagement.JPG

@@ -30,7 +30,7 @@ public static class SigninCredentialExtension
         public static IIdentityServerBuilder AddSigninCredentialFromConfig(
             this IIdentityServerBuilder builder, IConfigurationSection options, ILogger logger, IHostingEnvironment env)
         {
-            string keyType = System.Environment.GetEnvironmentVariable("CERTIFICATE_TYPE");
+            string keyType = System.Environment.GetEnvironmentVariable("CERTIFICATE_TYPE") ?? options.GetSection("Type").Value;
             logger.LogInformation($"SigninCredentialExtension keyType is {keyType}");
 
             switch (keyType)

docs/index.rst

@@ -1,9 +1,9 @@
 {
   "ConnectionStrings": {
     // localdb
-    // "SSOConnection":  "Server=(localdb)\\mssqllocaldb;Database=JpProject;Trusted_Connection=True;MultipleActiveResultSets=true",
+     "SSOConnection": "Server=(localdb)\\mssqllocaldb;Database=JpProject;Trusted_Connection=True;MultipleActiveResultSets=true",
     // Sql Server connection
-    "SSOConnection": "Server=.;Initial Catalog=JpProject;Persist Security Info=False;User ID=sa;Password=@Password1;MultipleActiveResultSets=False;Connection Timeout=30;"
+    // "SSOConnection": "Server=.;Initial Catalog=JpProject;Persist Security Info=False;User ID=sa;Password=@Password1;MultipleActiveResultSets=False;Connection Timeout=30;"
     // MySql connection
     //"SSOConnection": "server=localhost;database=JpProject;user=bruno;password=pass"
   },
@@ -16,16 +16,17 @@
     }
   },
   "Storage": {
-    "AccountName": "jzresgate",
-    "AccountKey": "dUOhvevD3xi7KHw2e+yLInqjCncLN9HPAp4ltG2A8ACflbmIqX1/faRUAWLaPhDBcSJKS0McUAeuJkq7e14sng=="
+    "AccountName": "jpproject",
+    // Will be deactivated asap
+    "AccountKey": "WyDWcXZykeX3hA/WteVm3j2w7ryZlBUqBzamxHmohViWs9VQHXlxJNH0BBHn2TSAQ1HE8Ys1+MvsHaUSwZiqDA=="
   },
   "EmailConfiguration": {
     "SmtpServer": "smtp.gmail.com",
     "SmtpPort": 587,
-    "SmtpUsername": "sistemas@jzresgate.com.br",
-    "SmtpPassword": "Sjz23447138",
-    "FromName": "Sistemas",
-    "FromAddress": "sistemas@jzresgate.com.br",
+    "SmtpUsername": "donotreply@jpproject.com",
+    "SmtpPassword": "<secret>",
+    "FromName": "Jp Project Team",
+    "FromAddress": "donotreply@jpproject.com",
     "SendEmail": "false"
-  }
+  },
 }