Skip to content
This repository was archived by the owner on Aug 1, 2021. It is now read-only.

Commit 26ac247

Browse files
committed
docs
1 parent 1b89430 commit 26ac247

File tree

8 files changed

+119
-67
lines changed

8 files changed

+119
-67
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ Jp Project is a Open Source Quickstart for IdentityServer4.
1010
Written in ASP.NET Core and Angular 6.
1111
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.
1212

13+
# We are online at Azure. Check it now!
14+
[Jp Project](https://jpproject.azurewebsites.net/sso/)
15+
<small> New users are readonly</small>
16+
1317
## Give a Star! ⭐
1418

1519
Do you love it? give us a Star!
@@ -20,10 +24,13 @@ Jp Project is built against ASP.NET Core 2.1.
2024
* [Install](https://www.microsoft.com/net/download/core#/current) the latest .NET Core 2.1 SDK
2125
* Run `build.ps1` (Powershell) or `build.bat` (cmd)
2226

23-
Wait for ng to complete his proccess then go to http://localhost:4200!
27+
Wait for ng to complete his proccess then go to http://localhost:5000!
2428

2529
# Expected after start project.
2630

31+
## Admin UI
32+
<img src="https://github.com/brunohbrito/JP-Project/blob/master/docs/images/admin-home.jpg?raw=true" width="480" />
33+
2734
## Login page
2835
<img src="https://github.com/brunohbrito/JP-Project/blob/master/docs/images/login.JPG?raw=true" width="480" />
2936

@@ -50,8 +57,6 @@ There are several ways we can help you out.
5057

5158
# What comes next?
5259

53-
Admin panel to manage IdentityServer4 configuration.
54-
55-
Translation
56-
5760
Code coverage
61+
62+
Thinking about create separated repo's for each part of solution.

docs/configuration/mysql.rst

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/configuration/sql_server.rst

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/images/bigpicture.JPG

-7.5 KB
Loading

docs/index.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ The main goal of project is to be a Management Ecosystem for IdentityServer4. He
1414

1515
Helping teams and entrepreneurs to achieve the company's primary purpose: Maximize shareholder value.
1616

17-
See it in action
17+
Now we are online! `See it in action <https://jpproject.azurewebsites.net/signin-google>`_
18+
19+
There is a intro video too!
1820

1921
.. raw:: html
2022

@@ -23,7 +25,7 @@ See it in action
2325
</div>
2426

2527
Give a Star ⭐!
26-
------------
28+
----------------
2729

2830
Do you love it? give us a :yellow:`Star!` ⭐
2931

@@ -33,7 +35,7 @@ Wanna contribute? Feel free to do that!
3335

3436
But remember to check the `Contributing Section <intro/contributing.html>`_
3537

36-
Take you special place in our heart!
38+
Take a special place in our heart!
3739

3840
All contributors has a heart💓! See them in `Contributor list <https://github.com/brunohbrito/JP-Project/blob/master/CONTRIBUTORS.md>`_
3941

@@ -69,8 +71,7 @@ There are several ways we can help you out.
6971
:hidden:
7072
:caption: Configuration
7173

72-
configuration/sql_server
73-
configuration/mysql
74+
configuration/databaseType
7475
configuration/serilog
7576
configuration/application_insights
7677
configuration/certificate

docs/intro/big_picture.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ User Management UI
1818

1919
A SPA application responsible for create and manager users. Send reset links. E-mail validation. Profile validation, and so on.
2020

21-
User Management API
21+
Management API
2222
-------------------
2323

2424
This API serve UI.
25+
26+
Admin UI
27+
--------
28+
It's the Admin user interface to manage identity Server 4.

docs/quickstarts/ambient_variables.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,22 @@ SSO Variables
4545
- http://localhost:4200
4646
-
4747
- The path Url of User Management UI after published
48+
* - IS4_ADMIN_UI
49+
- http://localhost:4300
50+
-
51+
- The path Url of Admin UI
52+
* - RESOURCE_SERVER_URI
53+
- https://localhost:5003
54+
-
55+
- The path Url of Management API
56+
* - CUSTOMCONNSTR_DATABASE_CONNECTION
57+
- <YOUR CONN STRING>
58+
-
59+
- Database Connection String
60+
* - DATABASE_TYPE
61+
- ``MySql`` or ``SqlServer``
62+
-
63+
- Which database will be used.
4864

4965

5066

@@ -80,3 +96,24 @@ User Management API Variables
8096
- https://localhost:5000
8197
-
8298
- The path Url of SSO
99+
* - USER_MANAGEMENT_URI
100+
- http://localhost:4200
101+
-
102+
- The path Url of User Management UI after published
103+
* - IS4_ADMIN_UI
104+
- http://localhost:4300
105+
-
106+
- The path Url of Admin UI
107+
* - RESOURCE_SERVER_URI
108+
- https://localhost:5003
109+
-
110+
- The path Url of Management API
111+
* - CUSTOMCONNSTR_DATABASE_CONNECTION
112+
- <YOUR CONN STRING>
113+
-
114+
- Database Connection String
115+
* - DATABASE_TYPE
116+
- ``MySql`` or ``SqlServer``
117+
-
118+
- Which database will be used.
119+

docs/quickstarts/app_settings.rst

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,34 @@ To take from Facebook, see `docs here <https://developers.facebook.com/docs/face
4141
ApplicationSettings
4242
^^^^^^^^^^^^^^^^^^^
4343

44-
You need to set **UserManagementURL**, so when user cliks on Register link, SSO takes this value to redirect him.
44+
These settings will be override by Environment Variables if set.
45+
46+
.. list-table:: Ambient Variables
47+
:widths: 15 25 60
48+
:header-rows: 1
49+
50+
* - Variable
51+
- Value
52+
- Description
53+
* - Authority
54+
- https://localhost:5000
55+
- The path Url of SSO
56+
* - UserManagementURL
57+
- http://localhost:4200
58+
- The path Url of User Management UI after published
59+
* - IS4AdminUi
60+
- http://localhost:4300
61+
- The path Url of Admin UI
62+
* - ResourceServerURL
63+
- https://localhost:5003
64+
- The path Url of Management API
65+
* - CUSTOMCONNSTR_DATABASE_CONNECTION
66+
- <YOUR CONN STRING>
67+
- Database Connection String
68+
* - DatabaseType
69+
- ``MySql`` or ``SqlServer``
70+
- Which database will be used.
71+
4572

4673
User Management API
4774
-------------------
@@ -63,6 +90,13 @@ EmailConfiguration
6390

6491
E-mail settings to provide the capabilities to send e-mail after a new user and reset link.
6592

93+
ApplicationSettings
94+
^^^^^^^^^^^^^^^^^^^
95+
96+
Need to provide the **DatabaseType**.
97+
98+
This settings will be override by Environment Variables if set.
99+
66100
User Management UI
67101
------------------
68102

@@ -86,4 +120,29 @@ To change settings from UI, you need to open environment file. Located at src/en
86120
* - **IssuerUri**
87121
- Base Url from SSO
88122
* - **RequireHttps**
89-
- True if IsuerUri has a HTTPS.
123+
- True if IsuerUri has a HTTPS.
124+
* - **Uri**
125+
- Final URL of App.
126+
127+
Admin UI
128+
------------------
129+
130+
environment files
131+
^^^^^^^^^^^^^^^^^
132+
133+
To change settings from UI, you need to open environment file. Located at src/environment.
134+
135+
.. list-table:: UI Variables
136+
:widths: 30 70
137+
:header-rows: 1
138+
139+
* - Variable
140+
- Description
141+
* - **ResourceServer**
142+
- Base Url from User Management API
143+
* - **IssuerUri**
144+
- Base Url from SSO
145+
* - **RequireHttps**
146+
- True if IsuerUri has a HTTPS.
147+
* - **Uri**
148+
- Final URL of App.

0 commit comments

Comments
 (0)