Skip to content

Commit

Permalink
README.md corrections
Browse files Browse the repository at this point in the history
Signed-off-by: Maxim Nesen <[email protected]>
  • Loading branch information
senivam committed Sep 27, 2023
1 parent 402d818 commit 5514009
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 16 deletions.
2 changes: 1 addition & 1 deletion examples/quickstarts/helidon-quickstart-mp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ curl -X GET http://localhost:8080/greet
curl -X GET http://localhost:8080/greet/Joe
{"message":"Hello Joe!"}
curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
curl -X GET http://localhost:8080/greet/Jose
{"message":"Hola Jose!"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ curl -X GET http://localhost:8080/greet
curl -X GET http://localhost:8080/greet/Joe
{"message":"Hello Joe!"}
curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
curl -X GET http://localhost:8080/greet/Jose
{"message":"Hola Jose!"}
Expand Down
14 changes: 7 additions & 7 deletions examples/security/basic-auth-with-static-content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ There are two examples with exactly the same behavior:

```bash
mvn package
java -jar target/helidon-examples-security-webserver-basic-auth.jar
java -jar target/helidon-examples-security-webserver-basic-uath.jar
```

Try the application:

The application starts on a random port, the following assumes it is `56551`
```bash
curl http://localhost:56551/public
curl -u "jill:password" http://localhost:56551/noRoles
curl -u "john:password" http://localhost:56551/user
curl -u "jack:password" http://localhost:56551/admin
curl -v -u "john:password" http://localhost:56551/deny
curl -u "jack:password" http://localhost:56551/noAuthn
curl http://localhost:[PORT]/public
curl -u "jill:password" http://localhost:[PORT]/noRoles
curl -u "john:password" http://localhost:[PORT]/user
curl -u "jack:password" http://localhost:[PORT]/admin
curl -v -u "john:password" http://localhost:[PORT]/deny
curl -u "jack:password" http://localhost:[PORT]/noAuthn
```
12 changes: 6 additions & 6 deletions examples/security/webserver-digest-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Try the application:

The application starts on a random port, the following assumes it is `56551`
```bash
curl http://localhost:56551/public
curl --digest -u "jill:password" http://localhost:56551/noRoles
curl --digest -u "john:password" http://localhost:56551/user
curl --digest -u "jack:password" http://localhost:56551/admin
curl -v --digest -u "john:password" http://localhost:56551/deny
curl --digest -u "jack:password" http://localhost:56551/noAuthn
curl http://localhost:[PORT]/public
curl --digest -u "jill:password" http://localhost:[PORT]/noRoles
curl --digest -u "john:password" http://localhost:[PORT]/user
curl --digest -u "jack:password" http://localhost:[PORT]/admin
curl -v --digest -u "john:password" http://localhost:[PORT]/deny
curl --digest -u "jack:password" http://localhost:[PORT]/noAuthn
```
19 changes: 19 additions & 0 deletions examples/webserver/fault-tolerance/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Comments As a Service

This application runs fault tolerance service on port 8079.

## Build and run

```bash
mvn package
java -jar target/helidon-examples-webserver-fault-tolerance.jar
```

The output will be like:

```bash
[Wed Sep 26 16:01:16 CEST 2023] INFO: io.helidon.common.LogConfig doConfigureLogging - Logging at initialization configured using classpath: /logging.properties
[Wed Sep 26 16:01:17 CEST 2023] INFO: io.helidon.common.HelidonFeatures features - Helidon SE 3.2.3-SNAPSHOT features: [Config, Fault Tolerance, Tracing, WebServer]
[Wed Sep 26 16:01:17 CEST 2023] INFO: io.helidon.webserver.NettyWebServer lambda$start$9 - Channel '@default' started: [id: 0xb11f6086, L:/[0:0:0:0:0:0:0:0]:8079]
Server started on http://localhost:8079
```
24 changes: 24 additions & 0 deletions examples/webserver/tls/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Comments As a Service

This application starts a web server with TLS support on the port 8081.

## Build and run

```bash
mvn package
java -jar target/helidon-examples-webserver-tls.jar
```

The output will be like:

```bash
[Wed Sep 27 16:11:25 CEST 2023] INFO: io.helidon.common.LogConfig doConfigureLogging - Logging at initialization configured using classpath: /logging.properties
[Wed Sep 27 16:11:25 CEST 2023] INFO: io.helidon.common.HelidonFeatures features - Helidon SE 3.2.3-SNAPSHOT features: [Config, Tracing, WebServer]
[Wed Sep 27 16:11:25 CEST 2023] INFO: io.helidon.webserver.NettyWebServer lambda$start$9 - Channel '@default' started: [id: 0xb28f94e2, L:/[0:0:0:0:0:0:0:0]:8080] with TLS
Started config based WebServer on http://localhost:8080
[Wed Sep 27 16:11:25 CEST 2023] INFO: io.helidon.webserver.NettyWebServer lambda$start$9 - Channel '@default' started: [id: 0x8aed396c, L:/[0:0:0:0:0:0:0:0]:8081] with TLS
Started builder based WebServer on https://localhost:8081
```

The http://localhost:8080 displays static content (in browser) and https://localhost:8081 displays 'Hello!' after accepting
invalid certificate (in browser)
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public static void main(String[] args) {
});
startBuilderBasedServer(config.get("builder-based"))
.thenAccept(ws -> {
System.out.println("Started builder based WebServer on http://localhost:" + ws.port());
System.out.println("Started builder based WebServer on https://localhost:" + ws.port());
});
}

Expand Down
6 changes: 6 additions & 0 deletions examples/webserver/tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,9 @@ This application demonstrates various WebServer use cases together and in its co
mvn package
java -jar target/helidon-examples-webserver-tutorial.jar
```

run
```bash
curl -X POST http://localhost:8080/mgmt/shutdown
```
in order to stop the server

0 comments on commit 5514009

Please sign in to comment.