github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Plugin configuration now lives in datasette.yaml/json

Browse source 
* Checkpoint, moving top-level plugin config to datasette.json
* Support database-level and table-level plugin configuration in datasette.yaml

Refs #2093
This commit is contained in:
Alex Garcia 2023-09-13 14:06:25 -07:00 • committed by GitHub
commit b2ec8717c3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 217 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

97
docs/configuration.rst
View file

@ -1,10 +1,101 @@
.. _configuration:
Configuration
========
=============
Datasette offers many way to configure your Datasette instances: server settings, plugin configuration, authentication, and more.
Datasette offers several ways to configure your Datasette instances: server settings, plugin configuration, authentication, and more.
To facilitate this, You can provide a `datasette.yaml` configuration file to datasette with the ``--config``/ ``-c`` flag:
To facilitate this, You can provide a ``datasette.yaml`` configuration file to datasette with the ``--config``/ ``-c`` flag:
.. code-block:: bash
datasette mydatabase.db --config datasette.yaml
.. _configuration_reference:
``datasette.yaml`` reference
----------------------------
Here's a full example of all the valid configuration options that can exist inside ``datasette.yaml``.
.. tab:: YAML
.. code-block:: yaml
# Datasette settings block
settings:
default_page_size: 50
sql_time_limit_ms: 3500
max_returned_rows: 2000
# top-level plugin configuration
plugins:
datasette-my-plugin:
key: valueA
# Database and table-level configuration
databases:
your_db_name:
# plugin configuration for the your_db_name database
plugins:
datasette-my-plugin:
key: valueA
tables:
your_table_name:
# plugin configuration for the your_table_name table
# inside your_db_name database
plugins:
datasette-my-plugin:
key: valueB
.. _configuration_reference_settings:
Settings configuration
~~~~~~~~~~~~~~~~~~~~~~
:ref:`settings` can be configured in ``datasette.yaml`` with the ``settings`` key.
.. tab:: YAML
.. code-block:: yaml
# inside datasette.yaml
settings:
default_allow_sql: off
default_page_size: 50
.. _configuration_reference_plugins:
Plugin configuration
~~~~~~~~~~~~~~~~~~~~
Configuration for plugins can be defined inside ``datasette.yaml``. For top-level plugin configuration, use the ``plugins`` key.
.. tab:: YAML
.. code-block:: yaml
# inside datasette.yaml
plugins:
datasette-my-plugin:
key: my_value
For database level or table level plugin configuration, nest it under the appropriate place under ``databases``.
.. tab:: YAML
.. code-block:: yaml
# inside datasette.yaml
databases:
my_database:
# plugin configuration for the my_database database
plugins:
datasette-my-plugin:
key: my_value
my_other_database:
tables:
my_table:
# plugin configuration for the my_table table inside the my_other_database database
plugins:
datasette-my-plugin:
key: my_value