Skip to content

Commit

Permalink
Merge pull request #8 from Darnethal0z/main
Browse files Browse the repository at this point in the history
Added default HTTPS server listen port constant + modified web server documentation
  • Loading branch information
Darnethal0z committed Nov 13, 2023
2 parents 65a5d63 + ac6d23b commit 0c0334e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
1 change: 1 addition & 0 deletions anwdlserver/web/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@

# Default values
DEFAULT_RESTWEBSERVER_LISTEN_PORT = 8080
DEFAULT_RESTWEBSERVER_HTTPS_LISTEN_PORT = 4443
DEFAULT_ENABLE_SSL = False
DEFAULT_STOP_ON_SHUTDOWN_SIGNAL = False

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
```{function} anwdlserver.core.sanitize.verifyRequestContent(request_dict)
```

Check if a request dictionary is a valid normalized [Request format](https://anweddol-server.readthedocs.io/en/latest/technical_specifications/core/communication.html#request-format).
Check if a request dictionary is a valid normalized [Request format](../../../technical_specifications/core/communication.md).

**Parameters** :

Expand Down
17 changes: 8 additions & 9 deletions docs/source/developer_section/api_references/web/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ In the module `anwdlserver.web.server` :

### Default values

Constant name | Value | Definition
----------------------------------- | ------- | ----------
*DEFAULT_RESTWEBSERVER_LISTEN_PORT* | 8080 | The default web server listen port.
*DEFAULT_ENABLE_SSL* | `False` | Enable SSL support by default or not.
*DEFAULT_STOP_ON_SHUTDOWN_SIGNAL* | `False` | Stop the web server on shutdown signal by default or not.
Constant name | Value | Definition
----------------------------------------- | ------- | ----------
*DEFAULT_RESTWEBSERVER_LISTEN_PORT* | 8080 | The default web server listen port.
*DEFAULT_RESTWEBSERVER_HTTPS_LISTEN_PORT* | 4443 | The default web server HTTPS listen port.
*DEFAULT_ENABLE_SSL* | `False` | Enable SSL support by default or not.
*DEFAULT_STOP_ON_SHUTDOWN_SIGNAL* | `False` | Stop the web server on shutdown signal by default or not.

## class *RESTWebServerInterface*

Expand Down Expand Up @@ -96,11 +97,9 @@ The container ISO path must point to a valid [ISO image](../../../administration
```

```{warning}
This class inherits of every `ServerInterface` classes attributes.
This class inherits of every `ServerInterface` classes attributes : Every other classes listed below this point is part of it, but can be combined with `ServerInterface` methods as well.
Every other classes listed below this point is part of this class, but can be combined with `ServerInterface` methods as well.
If the parameter `enable_ssl` is set to `True`, the parameters `ssl_pem_private_key_file_path` and `ssl_pem_certificate_file_path` must be set.
If the parameter `enable_ssl` is set to `True`, the parameters `ssl_pem_private_key_file_path` and `ssl_pem_certificate_file_path` must be set. In addition to this, it is better to specify another listen port than the default `8080`. By convention you can use the port `4443` but if you want to use another one, do not forget to communicate it with other potential clients or they won't be able to connect preperly.
```

### Manual handler execution
Expand Down

0 comments on commit 0c0334e

Please sign in to comment.