Welcome to OpenBioMaps documentation!

OpenBioMaps is a platform for collecting, managing, sharing, and publishing biodiversity data.

New users should begin with the introduction and the getting-started guide. Contributors and data managers can continue with the data-collection, data-management, and data-access documentation. Project and server administrators should use the administration sections. Developers and external-client authors can find technical information under integration and development.

Start here

• Introduction
  • Why OpenBioMaps?
  • What is OpenBioMaps?
  • Connecting data collection and data use
  • The OpenBioMaps approach
  • Main properties
  • Technical implementation
  • OpenBioMaps Consortium
• Getting started
  • Choose how to use OpenBioMaps
  • Create an OpenBioMaps project
  • Understand the observation data model
  • Set up your data
  • Data management and access
  • Connect to your project
  • Start collecting and managing data

Using OpenBioMaps

• User interfaces
  • Web application
  • Login page
  • Profile page
  • Project administration
  • Map page
  • Geometry tester
  • Data upload page
  • Datasheet page
  • Database summary page
  • Welcome page
  • Other user interfaces
  • Error reporting
• Data collection
  • Planning a data collection
  • Main data-collection approaches
  • Representing a collection in OpenBioMaps
  • Recommended core information
  • Field naming and interoperability
  • Practical checklist
  • Example data collections
  • References
• Data management
  • Database structure and metadata
  • Data quality and validation
  • Data processing and harmonisation
  • Data provenance and documentation
  • Queries and derived data
  • Data export and reuse
  • Data lifecycle
• Data access
  • Retrieving data
  • Controlling access to data
• Mobile applications
  • Offline application for Android and iOS devices
  • Online applications for mobile devices

Integration and external clients

• API documentation
  • OpenAPI
  • PDS API
  • PDS examples
• Clients
  • QGIS
  • R usage
  • PostgreSQL clients
  • Mapserver clients
  • Oauth clients
  • Appsmith
  • Nextcloud
  • API clients

Administration

• Project administration
  • Administrative settings
  • Creating a new OpenBioMaps project
  • Data access
  • Landing pages
  • Modules
  • Background jobs
• Server administration
  • Supervisor
  • System variable files
  • Docker service architecture
  • Application service: Apache and PHP
  • MapServer service
  • PostgreSQL and PostGIS service
  • Memcached service
  • API service
  • Database administration service
  • Persistent volumes
  • Configuration workflow
  • Recommended scheduled jobs
  • Operational checks

Development and contribution

• Development
  • Developer hints

Help

• Frequently Asked Questions
  • General information
  • Projects and registration
  • Data upload and access
  • Mobile access
  • Developer interfaces and clients
  • Languages and contributions
  • Storage, backup, and account recovery
  • Troubleshooting
  • Data management
  • RUM openness model
  • DOIs and citation

Offline documentation

Download the documentation as EPUB