Skip to content

Commit c6d8c31

Browse files
committed
Update docs and change log
1 parent f59a39c commit c6d8c31

File tree

2 files changed

+58
-4
lines changed

2 files changed

+58
-4
lines changed

doc/change-log.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,36 @@ currentMenu: change-log
55

66
# Change Log
77

8+
## 2.0.0-alpha5
9+
10+
* Features
11+
* Create Read-Only web app client called [InEngine.NET Dashboard](https://github.com/ethanhann/InEngine.NET-Dashboard).
12+
* Enable Cors, add "Origins" Option to Web API configuration.
13+
* Use Common.Logging with NLog instead of log4net.
14+
* Make Common.Logging NLog adapter configurable via IntegrationEngine.json.
15+
* Validate JobType classes as integration jobs before scheduling them.
16+
17+
## 2.0.0-alpha4
18+
19+
* Bug
20+
* Use correct MySql.Data.Entity dependency in Core package.
21+
22+
## 2.0.0-alpha3
23+
24+
* Chores
25+
* Use shared assembly to streamline package creation
26+
* Remove stale NuGet dependencies
27+
28+
## 2.0.0-alpha2
29+
30+
* Features
31+
* Return list of job keys at /api/Job.
32+
* Schedule a Job with a Trigger, when the Trigger is created via the Web API.
33+
* Reschedule a Job with a Trigger, when the Trigger is updated via the Web API.
34+
* Validate cron expression when creating/updating a CronTrigger.
35+
* Chores
36+
* Use Unity IoC instead of Funq.
37+
838
## 2.0.0-alpha1
939

1040
* Features

doc/configuration.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,18 @@ The configuration file has four sections: _WebApi_, _MessageQueue_, _Mail_, and
1111
### WebApi
1212

1313
The _WebApi_ section contains settings for the InEngine.NET's WebApi.
14-
Namely, the hostname and port of the web API.
14+
Namely, the hostname and port of the web API.
15+
A list of CORS origins can also be specified.
16+
This is useful when accessing the API via the browser with the [InEngine.NET Dashboard](https://github.com/ethanhann/InEngine.NET-Dashboard).
17+
Note that it is not recommended to use "*" wildcard, but a list of specific domains is preferred instead.
1518

1619
```js
1720
{
1821
// ...
1922
"WebApi": {
2023
"HostName": "localhost",
21-
"Port": 9001
24+
"Port": 9001,
25+
"Origins": ["*"]
2226
},
2327
// ...
2428
}
@@ -101,14 +105,30 @@ If these settings are not correct, then a connection exception will be thrown wh
101105
}
102106
```
103107

108+
### NLogAdapter
109+
110+
The _NLogAdapter_ section contains settings for configuring the [NLog Common.Logging adapter](http://netcommon.sourceforge.net/docs/2.1.0/reference/html/ch01.html#logging-adapters-nlog).
111+
112+
```js
113+
{
114+
// ...
115+
"NLogAdapter": {
116+
"ConfigType": "File",
117+
"ConfigFile": "IntegrationEngine.nlog.xml"
118+
}
119+
// ..
120+
}
121+
```
122+
104123
## Sample Configuration
105124
This is a sample configuration.
106125

107126
```js
108127
{
109128
"WebApi": {
110129
"HostName": "localhost",
111-
"Port": 9001
130+
"Port": 9001,
131+
"Origins": ["*"]
112132
},
113133
"MessageQueue": {
114134
"QueueName": "myqueue",
@@ -135,6 +155,10 @@ This is a sample configuration.
135155
"DatabaseName": "IntegrationEngine",
136156
"UserName": "inengine",
137157
"Password": "secret"
138-
}
158+
},
159+
"NLogAdapter": {
160+
"ConfigType": "File",
161+
"ConfigFile": "IntegrationEngine.nlog.xml"
162+
}
139163
}
140164
```

0 commit comments

Comments
 (0)