-
Notifications
You must be signed in to change notification settings - Fork 8
Configuration
George Hamilton edited this page Jun 7, 2016
·
6 revisions
The Fieldtrip Open ini configuration file contains build time variables that each instance can modify to adapt the app to their needs. An example can be found here.
The following documents the sections in the file.
This option controls how the app is installed.
| Name | Notes |
|---|---|
| name | The project name |
| location | The source of the configuration file. If the config file is to be shared among developers this value can contain the remote SSH location of the file. This can be in the form name@machine.domain or a git location, e.g: git@git.domain:group/rep.git HEAD /path/to/config.ini. |
| location_port | If location requires a non default SSH port, this can be provided here. |
| project | The git repository of FTOpen project/theme. |
| runtime_dir | The directory of the FTOpen app runtime, e.g it will installed at $HOME/local/<runtime_dir>. To specify the full path, define the target in the install_project task, e.g: fab install_project:/path/to/app
|
| author_email | Defines the author email in cordova config.xml file. |
| url | Defines the access href in cordova config.xml file. |
| access_urls | Defines the access origin in cordova config.xml file. |
The values in the app section becomes config.js in the application, allowing javascript access to configuration values. Note underscores must not be used in variables names in this section.
| Name | Notes |
|---|---|
| enduserlicence | Should the end user license pop up be show on app start up? true of false. |
| mapBaseLayer | Map baselayer to use, either ftgb (Open OS map stack) or osm. |
| mapUrl | URL of the map base layer. |
| package | The java package of the android application. |
| priviligedUsers | Comma separated list of uuids of privileged users (i.e developers). Only applicable to android. |
| weburl | The URL of the project. |
| cacheLimit | In bytes, the maximum size of local saved maps. |
| clientThumbGen | Should app generate thumbnails of photos? true of false. |
| pcapiversion | Version of the pcapi to use. |
| pcapiurl | URL of the PCAPI endpoint. |
| pcapiproviders | PCAPI provider to use: dropbox or local. |
| pcapianonymous | Anonymous PCPI user name. |
Options for the app settings page.
| Name | Notes |
|---|---|
| offline-maps | List of offline map URLs. |
| sync | List of PCAPI URLs. |
This section defines options for releasing the app. Note: this only applies to android.
| Name | Notes |
|---|---|
| url | The public release root URL, where the release apk will be copied to. |
| hosts | Comma separate list of accounts and machine names hosting the released apk. |
| keystore_name | The name of the keystore for signing apk. |
| keystore_location | The location of the keystore. |
| dir | The remote directory where the released apk will be copied to. |
| smtp | SMPTP host for sending email notification of releases. |
| sender | Email from address for sending email notification of releases. |
| email_beta | Recipient of beta releases. |
| email_official | Recipient of official releases. |