Skip to content

Commit cbf6d17

Browse files
committed
rev2 (please squash + merge)
1 parent a219f79 commit cbf6d17

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- `stacked` is now ignored on chart types that cannot stack, instead of displaying an empty chart.
1515
- Screen readers now announce the title of the modal component instead of an unnamed dialog.
1616
- `sqlpage.request_body` and `sqlpage.request_body_base64` now return NULL when the request has no body. A body that cannot be read, such as one exceeding the payload limit, is now reported as an error instead of being silently replaced with an empty body.
17-
- The configuration guide now documents the defaults of `listen_on`, `port`, `database_url`, `max_database_pool_connections`, `https_certificate_cache_dir`, `system_root_ca_certificates` and `max_recursion_depth`.
17+
- The configuration guide now documents the defaults of `database_url`, `max_database_pool_connections`, `https_certificate_cache_dir`, `system_root_ca_certificates` and `max_recursion_depth`, and explains that `https_domain` combined with a non-443 `listen_on` or `port` serves plain HTTP on that port alongside HTTPS on 443.
1818

1919
## v0.45
2020

configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Here are the available configuration options and their default values:
88

99
| variable | default | description |
1010
| --------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
11-
| `listen_on` | 0.0.0.0:8080, or 0.0.0.0:443 when `https_domain` is set | Interface and port on which the web server should listen |
11+
| `listen_on` | 0.0.0.0:8080 | Interface and port on which the web server should listen |
1212
| `database_url` | `sqlite://sqlpage.db?mode=rwc` in the `configuration_directory` | Database connection URL, either `dbengine://user:password@host:port/dbname` or an ODBC connection string. Special characters should be [percent-encoded](https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding). See [Database connection strings](#database-connection-strings) for details and examples. When left unset, SQLPage looks for an existing db or creates `sqlpage.db` in the `configuration_directory`, with a fallback to in-memory if unwritable.|
1313
| `database_password` | | Database password. If set, this will override any password specified in the `database_url`. This allows you to keep the password separate from the connection string for better security. |
14-
| `port` | 8080, or 443 when `https_domain` is set | Like listen_on, but specifies only the port. |
14+
| `port` | 8080 | Like listen_on, but specifies only the port. |
1515
| `unix_socket` | | Path to a UNIX socket to listen on instead of the TCP port. If specified, SQLPage will accept HTTP connections only on this socket and not on any TCP port. This option is mutually exclusive with `listen_on` and `port`.
1616
| `host` | | The web address where your application is accessible (e.g., "myapp.example.com"). Used for login redirects with OIDC. |
1717
| `max_database_pool_connections` | PostgreSQL: 50<BR> MySql: 75<BR> SQLite: 16, or 128 in memory<BR> MSSQL: 100<BR> ODBC: 50 | How many simultaneous database connections to open at most |
@@ -34,7 +34,7 @@ Here are the available configuration options and their default values:
3434
| `oidc_additional_trusted_audiences` | unset | A list of additional audiences that are allowed in JWT tokens, beyond the client ID. When empty or unset, any additional audience is accepted. For increased security, set to an empty list `[]` to only allow the client ID as audience. |
3535
| `max_pending_rows` | 256 | Maximum number of rendered rows that can be queued up in memory when a client is slow to receive them. |
3636
| `compress_responses` | false | When the client supports it, compress the http response body. This can save bandwidth and speed up page loading on slow connections, but can also increase CPU usage and cause rendering delays on pages that take time to render (because streaming responses are buffered for longer than necessary). |
37-
| `https_domain` | | Domain name to request a certificate for. Setting this parameter will automatically make SQLPage listen on port 443 and request an SSL certificate. The server will take a little bit longer to start the first time it has to request a certificate. |
37+
| `https_domain` | | Domain name to request a certificate for. Setting this parameter will automatically make SQLPage listen on port 443 and request an SSL certificate. The server will take a little bit longer to start the first time it has to request a certificate. HTTPS is always served on port 443; if `listen_on` or `port` names a different port, SQLPage also serves plain HTTP there. |
3838
| `https_certificate_email` | contact@<https_domain> | The email address to use when requesting a certificate. |
3939
| `https_certificate_cache_dir` | ./sqlpage/https | A writeable directory where to cache the certificates, so that SQLPage can serve https traffic immediately when it restarts. The default ignores `web_root` and `configuration_directory`. |
4040
| `https_acme_directory_url` | https://acme-v02.api.letsencrypt.org/directory | The URL of the ACME directory to use when requesting a certificate. |
@@ -48,7 +48,7 @@ Here are the available configuration options and their default values:
4848
| `smtp_from` | | Default sender address for `sqlpage.send_mail`, optionally including a display name. Individual messages can override it with their `from` property. |
4949
| `smtp_tls_mode` | `starttls` | Encryption mode for `sqlpage.send_mail`: `starttls` requires a STARTTLS upgrade, `tls` uses TLS from connection start, and `none` permits plaintext only without credentials for trusted local SMTP servers. |
5050
| `max_email_attachment_size` | 10485760 | Maximum combined decoded size, in bytes, of all attachments in one email. Defaults to 10 MiB. This is independent of `max_uploaded_file_size` because attachments may come from sources other than form uploads. |
51-
| `system_root_ca_certificates` | false | Whether to use the system root CA certificates to validate SSL certificates when making http requests with `sqlpage.fetch`. If set to false, SQLPage will use its own set of root CA certificates. If the `SSL_CERT_FILE` or `SSL_CERT_DIR` environment variables are set, they will be used instead of the system root CA certificates. |
51+
| `system_root_ca_certificates` | true when `SSL_CERT_FILE` or `SSL_CERT_DIR` is set, false otherwise | Whether to use the system root CA certificates to validate SSL certificates when making http requests with `sqlpage.fetch`. If set to false, SQLPage will use its own set of root CA certificates. The `SSL_CERT_FILE` and `SSL_CERT_DIR` environment variables define what the system store contains, so setting either of them also turns this option on by default. |
5252
| `max_recursion_depth` | 10 | Maximum depth of recursion allowed in the `run_sql` function. Values above 255 stop the server from starting. |
5353
| `markdown_allow_dangerous_html` | false | Whether to allow raw HTML in markdown content. Only enable this if the markdown content is fully trusted (not user generated). |
5454
| `markdown_allow_dangerous_protocol` | false | Whether to allow dangerous protocols (like javascript:) in markdown links. Only enable this if the markdown content is fully trusted (not user generated). |

0 commit comments

Comments
 (0)