- Introduction
- Tutorials
- User interfaces
- Administrative settings
- Creating/founding a new database project
- Opening page
- Invitations
- Modules
- API documentation
- Install new OBM Server guide
- PWA application
- Mobile application documentation
- Developer hints
- Frequently Asked Questions
- What is OpenBioMaps?
- What is OpenBioMaps Consortium?
- How can I create/find a new database-project?
- How can I upload data?
- How can I access data?
- How can I retrieve data with my mobile phone?
- How can I sign up for an OpenBioMaps project?
- Is there a programmable interface for developers?
- What language support is available?
- How can I contribute to OpenBioMaps?
- Should I pay for anything?
- How and where does the OpenBioMaps store the data?
- Is there any backup solution?
- I lost my password, how can I get a new one?
- Pink squares appear on the map page
- What is the RUM?
- Is it possible to assign a DOI to databases?
- Where can I find the list of the existing OpenBioMaps servers?
- How to use the OpenBioMaps mobile app?
- Where can I find the OpenBioMaps R package?
- What data download options are there?
- How/where can I access photos taken in the field with the mobile app?
- How can I delete data?
- I can’t query/see data which is visible to other users
Install new OBM Server guide¶
New OBM server installation using Docker¶
Common errors and solutions after new installations or updates¶
Server configuration¶
Local variables for a project¶
Several low-level settings coming from the local_vars.php.inc file which can be updated by the server admin
The local_vars.php.inc file¶
Database connection definitions
// Please change the passwords for an other random string
define('gisdb_user','YOUR_PROJECT_ADMIN');
define('gisdb_pass','xxxxxxx');
define('gisdb_name','POSTGRES_DB_NAME');
define('gisdb_host','POSTGRES_HOST_NAME');
Project’s sql table name
define('PROJECTTABLE','your_database_table_name');
//define('PROJECTTABLE',basename(__DIR__));
Project data restriction settings
// `public` data read/mod for everybody
// `login` data read/mod only for logined users
// `group` data read/mod only for group members
define('ACC_LEVEL','public');
define('MOD_LEVEL','group');
Language settings
// the corresponding language file should be exists
// see the language file inclusion in the prepare_vars.php
define('LANG','hu'); # en, ro, ru, ...
Path and URL settings
// On openbiomaps.org is /projects
// else maybe empty
define('PATH','/biomaps/resources');
define('URL',sprintf("%s%s",$_SERVER['SERVER_NAME'],PATH));
mapserver variables
define('PRIVATE_MAPSERV',sprintf("%s/private/proxy.php",URL));
define('PUBLIC_MAPSERV',sprintf("%s/public/proxy.php",URL));
define('PRIVATE_MAPCACHE',sprintf("%s/private/cache.php",URL));
define('PUBLIC_MAPCACHE',sprintf("%s/public/cache.php",URL));
// Standalone installation
define('MAPSERVER','http://localhost/cgi-bin/mapserv.fcgi');
// Docker installation
define('MAPSERVER','http://mapserver/cgi-bin/mapserv');
// Using Mapcache needs further settings, see Mapserver documentation
define('MAPCACHE','http://localhost/mapcache');
define('MAP','PMAP');
// MAP's JS OBJ variables
// should move into postgresql vars
define('PRIVATE_MAPFILE','private.map');
Invitations
// If 0, only admin can send invitations
// otherwise the specified number of active invitation can be, so can't send more the xx invitations at once
// default is 11
define('INVITATIONS',0);
MAIL settings, if no local mail agent…
//define('SMTP_AUTH',true);
// *local smtp server example*
//define('SMTP_HOST','mail.your-smtp-server.org');
//define('SMTP_USERNAME','MAIL USER');
//define('SMTP_PASSWORD','xxxxxx');
//define('SMTP_PORT','PORT-NUMBER');
//define('SMTP_SENDER','mail_user@your-smtp-server.org');
// *Google example, it not works, updates needed!!!*
//define('SMTP_HOST','smtp.gmail.com');
//define('SMTP_USERNAME','your-user@gmail.com');
//define('SMTP_PASSWORD','xxxxxxxxx');
//define('SMTP_SECURE','tls');
//define('SMTP_PORT','587');
// *Deprecated features...*
//define('TURN_OFF_LAYERS','layer_data_points');
//define('SHINYURL',false);
//define('RSERVER',false);
Which page loaded after log in? profile, mainpage, map default is map
define('LOGINPAGE','map');
define('TRAINING',false);
MainPage configuration
define('MAINPAGE',array(
//'custom_skeleton'=>1,
'template'=>'gridbox', //intropage
'content1'=>'map', // map | upload-table | slideshow
'sidebar1'=>'column_dinpi.altema|custom_countries|members|uploads|data|species|species_stat', // members uploads data species species_stat
'system_footer'=>'on',
'system_header'=>'off',
//'restrictaded_pages'=>array('map','id','history','profile','data','table','editrecord','qtable','query','show','LQ','metadata')
));
Which style folder used
define('STYLE',array(
'template'=>'evolvulus'
));
Footer configuration
define('FOOTER',array(
'links'=>'map|upload|about|terms|usage|privacy',
'languages'=>'languages',
'partners' => array(
array('img'=>'obm_logo.png','size'=>'110','url'=>'https://openbiomaps.org'),
array('img'=>'unideb_logo.png','size'=>'','url'=>'https://unideb.hu')
))
);
Encrypt hash
// *used by the read_table module to encrypt the table name, ...*
define('MyHASH','password-string');
Custom cache settings
define('CACHE_HOST', $_ENV['CACHE_HOST'] ?? 'localhost');
define('CACHE_PORT', $_ENV['CACHE_PORT'] ?? 11211);
OpenID-based login settings
define('OPENID_CONNECT', [
'google' => [
'client_id' => 'xxxxx.apps.googleusercontent.com',
'client_secret' => 'xxxxxxx',
'provider_url' => 'https://accounts.google.com/',
],
]);
define('OPENID_CONNECT_CERT_PATH', '/etc/ssl/certs/ca-certificates.crt');
Using PWA app link on mainpage
define('PWA_LINK','on');
Developer options
// *Switch to an other GIT branch*
define('branch','testing');
// *Extra logging for PDS actions*
define('DEBUG_PDS', true);
local_vars.php.inc