Ything-RepoMirrors/static-web-server
2
0
Fork 0
mirror of https://github.com/static-web-server/static-web-server.git synced 2026-01-25 05:06:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: control log ANSI output via boolean --log-with-ansi option (#543)

Browse Source 
This PR adds support for controlling ANSI escape codes for colors and other text formatting when logging via a new boolean --log-with-ansi CLI option and its equivalent SERVER_LOG_WITH_ANSI env.

No ANSI by default:
Note that from now on, SWS will be no-ansi by default. If you want colored log output, then use --log-with-ansi.
For example:

```
static-web-server -p 8788 -d ./public/ -g trace -z --log-with-ansi
```
This commit is contained in:
Jose Quintana
2025-05-17 14:39:37 +02:00
committed by GitHub
parent cb1999550e
commit 0236980bc5
6 changed files with 39 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/content/configuration/environment-variables.md
View File

@@ -27,6 +27,9 @@ Defines a grace period in seconds after a `SIGTERM` signal is caught which will
### SERVER_LOG_LEVEL
Specify a logging level in lowercase. Possible values are `error`, `warn`, `info`, `debug` or `trace`. Default `error`.
### SERVER_LOG_WITH_ANSI
Enable or disable ANSI escape codes for colors and other text formatting of the log output.
### SERVER_LOG_REMOTE_ADDRESS
Log incoming request information along with its Remote Address (IP) if available using the `info` log level. Default `false`.

11
docs/content/features/logging.md
View File

@@ -15,6 +15,16 @@ static-web-server \
> Note: The log format is not well defined and is subject to change.
## Log output with ANSI
SWS does not output ANSI escape codes by default. However, If you want ANSI escape for colors and other text formatting when logging then use the boolean `--log-with-ansi` CLI option and its equivalent [SERVER_LOG_WITH_ANSI](./../configuration/environment-variables.md#server_log_with_ansi) env.
For example, if you want colored log output then use the `--log-with-ansi` option as follows:
```sh
static-web-server -p 8788 -d ./public/ -g trace -z --log-with-ansi
```
## Log Remote Addresses
SWS provides *Remote Address (IP)* logging for every request via an `INFO` log level.
@@ -76,6 +86,7 @@ Since the content of the `X-Forwarded-For` header can be changed by all proxies
To restrict the logging to only requests that originate from trusted proxy IPs, you can use the `--trusted-proxies` option, or the equivalent [SERVER_TRUSTED_PROXIES](../configuration/environment-variables.md#server_trusted_proxies) env. This should be a list of IPs, separated by commas. An empty list (the default) indicates that all IPs should be trusted.
Command used for the following examples:
```sh
static-web-server -a "::" --log-forwarded-for=true --trusted-proxies="::1" -p 8080 -d docker/public/ -g info
```