Skip to content

Commit 3c10481

Browse files
Gregory COCHONGregory COCHON
authored andcommitted
Define the license and add readme.
1 parent eeef4fa commit 3c10481

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 TECH'advantage
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# edc httpd
2+
3+
edc httpd is an embedded httpd server to serve the edc documention in standalone java application.
4+
5+
## Configuration
6+
7+
### Define the path
8+
In the `src/main/java/resources` folder, create the file: `webserver.yml`.
9+
Define the `base`variable to define the path to the published documentation.
10+
11+
```yaml
12+
base: /local/edc-httpd/html
13+
```
14+
15+
*Optional*
16+
17+
It is possible to override the default port (8088). You have to create a `server.yml` file and define its content like this:
18+
19+
```yaml
20+
httpPort: 9000
21+
ip: 0.0.0.0
22+
enableHttp: true
23+
```
24+
25+
Modify the `httpPort` to define the nw port value.
26+
27+
### Add the dependency
28+
29+
**Maven**
30+
31+
Add the dependency in your `pom.xml` for maven
32+
33+
```xml
34+
<dependency>
35+
<groupId>fr.techad.edc</groupId>
36+
<artifactId>httpd-java</artifactId>
37+
<version>1.0.0</version>
38+
</dependency>
39+
```
40+
41+
**Gradle**
42+
43+
```groovy
44+
compile group: 'fr.techad.edc', name: 'httpd-java', version: '1.0.0'
45+
```
46+
47+
### Start the server
48+
49+
To start the start, add
50+
51+
```java
52+
package fr.techad.edc.demo;
53+
54+
import fr.techad.edc.httpd.EdcWebServer;
55+
56+
public class Main {
57+
public static void main(String[] args) {
58+
EdcWebServer.run();
59+
/* ... */
60+
}
61+
}
62+
```
63+
64+
## License
65+
66+
MIT [TECH'advantage](mailto:contact@tech-advantage.com)

0 commit comments

Comments
 (0)