ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2024-12-18 20:57:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Removed double quotes for port number and added some inline code syntax highlighting with back-ticks. (#1717)

Browse Source 
* Removed double quotes for port number and added some inline code syntax highlighting with back-ticks.

* Added one more inline code syntax highlighting.
This commit is contained in:
Hong Chen 2024-05-23 10:13:50 -05:00 committed by GitHub
parent ee2f824550
commit 27e4264c2a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/documentation/web/Webserver.md
View File

@ -12,17 +12,17 @@ adding a web server to your simulation simply requires including the CivetServer
## Configuration of the Web Server
The following (input.py) parameters are available to configure your web server:
The following (`input.py`) parameters are available to configure your web server:
|Parameter Name | Default Value | Description |
|---------------------------|---------------------------|-----------------------------------------------------------------|
|web.server.enable | False |Must be explicitly enabled |
|web.server.port | "8888" |Web servers “listen” port |
|web.server.document_root | "www" |Web servers document root |
|web.server.debug | False |Print Client/Server Communication. |
|web.server.ssl_enable | False |Encrypt traffic. Uses https instead of http. |
|web.server.path_to_ssl_cert|"~/.ssl/server.pem" |Path to your certificate. This is only used if ssl_enable = True|
|web.server.error_log_file | "civet_server_error.log" |CivetWeb error log file. |
|Parameter Name | Default Value | Description |
|---------------------------|---------------------------|-------------------------------------------------------------------|
|web.server.enable | `False` |Must be explicitly enabled |
|web.server.port | `8888` |Web servers “listen” port |
|web.server.document_root | `"www"` |Web servers document root |
|web.server.debug | `False` |Print Client/Server Communication. |
|web.server.ssl_enable | `False` |Encrypt traffic. Uses https instead of http. |
|web.server.path_to_ssl_cert|`"~/.ssl/server.pem"` |Path to your certificate. This is only used if `ssl_enable = True`|
|web.server.error_log_file |`"civet_server_error.log"` |CivetWeb error log file. |
For your web server to be active, you must at least specify the following :
@ -31,10 +31,10 @@ web.server.enable = True
```
To have your web server listen on port 8890, rather than 8888, you would specify:
To have your web server listen on port `8890`, rather than `8888`, you would specify:
```python
web.server.port = "8890"
web.server.port = 8890
```
To serve files from a directory called ```my_document_root```, rather than ```www```:
@ -50,11 +50,11 @@ web.server.debug = True
```
## When the Web Server Starts
The web server, if enabled, will start during sim initialization. When it does, it will look for the specified document root directory. By default that’s “www”. If root directory doesn’t exist, one will be created with a simple index.html file , a style sheet, and a couple of directories.
The web server, if enabled, will start during sim initialization. When it does, it will look for the specified document root directory. By default that’s `“www”`. If root directory doesn’t exist, one will be created with a simple `index.html` file , a style sheet, and a couple of directories.
## Connecting to Your Web Server
Assuming that you accepted the default port, connect to ```http://localhost:8888/``` (```https://localhost:8888/``` if ssl_enable=True) from your web browser. This will display the index.html file in your root directory.
Assuming that you accepted the default port, connect to ```http://localhost:8888/``` (```https://localhost:8888/``` if `ssl_enable=True`) from your web browser. This will display the `index.html` file in your root directory.
## The Default Document Root Directory
@ -69,7 +69,7 @@ www/
images/
```
**index.html** is the file that’s displayed when you connect to http://localhost:8888/.
**index.html** is the file that’s displayed when you connect to `http://localhost:8888/`.
**style.css** is a CSS style-sheet that’s included by index.html to give it some pizzazz.