From 3a49cecb7d2b1f6587437418483b439f440d7366 Mon Sep 17 00:00:00 2001 From: 81reap Date: Tue, 1 Sep 2026 21:16:47 -0400 Subject: [PATCH] fix(docs) :: remove DSN=DuckDB from the database_url default `create_default_database` only ever builds a `sqlite://` URL, so this isn't a possible default --- configuration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/configuration.md b/configuration.md index 9e1af1a3..88c0f7d0 100644 --- a/configuration.md +++ b/configuration.md @@ -9,7 +9,7 @@ Here are the available configuration options and their default values: | variable | default | description | | --------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `listen_on` | 0.0.0.0:8080 | Interface and port on which the web server should listen | -| `database_url` | `sqlite://sqlpage.db?mode=rwc` in the `configuration_directory` or `DSN=DuckDB` | 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.| +| `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.| | `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. | | `port` | 8080 | Like listen_on, but specifies only the port. | | `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`. @@ -121,6 +121,8 @@ DATABASE_URL="Driver={SnowflakeDSIIDriver};Server=account.snowflakecomputing.com ODBC drivers must be installed and configured on your system. On Linux, the `unixODBC` driver manager is statically linked into the SQLPage binary, so you usually only need to install and configure the database-specific ODBC driver for your target database (for example Snowflake, Oracle, DuckDB...). +The `-duckdb` [docker image variants](./README.md#install-your-odbc-database-driver) ships with `DATABASE_URL` set to `DSN=DuckDB`so that the container uses a DuckDB file instead of SQLite. + If the `database_password` configuration parameter is set, it will override any password specified in the `database_url`. It does not need to be percent-encoded. This allows you to keep the password separate from the connection string, which can be useful for security purposes, especially when storing configurations in version control systems.