index.rst 1.3 KB

12345678910111213141516171819202122232425
  1. .. _vsi:
  2. VSI Virtual File System Support
  3. ===============================
  4. Support for GDAL's virtual file systems, accessible via a `/vsi`-prefixed path.
  5. Configuration
  6. -------------
  7. All configuration parameters are specified in a ``vsi.properties`` file. Any configuration option listed in `GDAL's documentation <https://gdal.org/user/virtual_file_systems.html>`_. is available as a key in this file. You can specify its location on your system with the ``-Dvsi.properties.location`` option. An example configuration providing OpenStack credentials may look like::
  8. OS_IDENTITY_API_VERSION = 3
  9. OS_AUTH_URL = https://swift.provider.com/v3
  10. OS_PROJECT_NAME = test-project
  11. OS_USERNAME = user@example.com
  12. OS_PASSWORD = example-password
  13. OS_USER_DOMAIN_NAME = Default
  14. OS_PROJECT_DOMAIN_NAME = default
  15. Usage
  16. -----
  17. This extension adds 'VSI Virtual File System' as a possible raster data store type. The only values required when choosing this type is a connection path. This is identical to the connection paths specified in `GDAL's documentation <https://gdal.org/user/virtual_file_systems.html>`_. You may also chain GDAL drivers together by concatenating their prefixes, as in the example below.
  18. .. figure:: images/vsiconfig.png
  19. VSI Virtual File System data store configuration