|
| 1 | +# OSM-Seed taginfo |
| 2 | + |
| 3 | +We build a docker container for taginfo software, the container will start the web service and also process required files to create databases. |
| 4 | + |
| 5 | +## Environment Variables |
| 6 | + |
| 7 | +All environment variables are located at [`.env-taginfo.example`](https://github.com/developmentseed/osm-seed/blob/develop/.env-taginfo.example), make a copy and name it as `.env-tagninfo` to use in osm-seed. |
| 8 | + |
| 9 | +- `URL_PLANET_FILE_STATE`: Url to the state file, that contains the URL for the latest planet PBF file. e.g [`state.txt`](https://planet.openhistoricalmap.org.s3.amazonaws.com/planet/state.txt), This is no required in case you set the `URL_PLANET_FILE` env var |
| 10 | + |
| 11 | +- `URL_HISTORY_PLANET_FILE_STATE`: Url to the full history state file, that contains the URL for the latest full history planet PBF file. e.g [`state.txt`](https://planet.openhistoricalmap.org.s3.amazonaws.com/planet/full-history/state.txt), This is no required in case you set the `URL_HISTORY_PLANET_FILE` env var |
| 12 | + |
| 13 | +- `URL_PLANET_FILE`: URL for the latest planet PBF file. |
| 14 | +- `URL_HISTORY_PLANET_FILE`: URL for the latest full history planet PBF file. |
| 15 | +- `TIME_UPDATE_INTERVAL` Interval time to update the databases, e.g: `50m` = every 50 minutes, `20h` = every 20 hours , `5d` = every 5 days |
| 16 | + |
| 17 | +The following env vars are required in the instance to update the values at: https://github.com/taginfo/taginfo/blob/master/taginfo-config-example.json |
| 18 | + |
| 19 | +- `INSTANCE_URL`: URL prefix for the site. |
| 20 | +- `INSTANCE_NAME`: Used in the title of all HTML pages. |
| 21 | +- `INSTANCE_DESCRIPTION` : Description of this taginfo instance. Will appear on the home page and about page. |
| 22 | +- `INSTANCE_ICON`: URL path to instance icon in the upper left. |
| 23 | +- `INSTANCE_CONTACT`: Contact name and email address. |
| 24 | +- `TAGINFO_PROJECT_REPO` : If you're implementing your own instances of taginfo with you own data, you need to look into the projects, clone the [taginfo-project ](https://github.com/taginfo/taginfo-projects) repo, and pass it in this env var. |
| 25 | + |
| 26 | +- `DOWNLOAD_DB`: Taginfo instances need 7 Sqlite databases to start up the web service, all of them can be downloaded from https://taginfo.openstreetmap.org/download. Or if you can download only some of them you can pass herec. e.g DOWNLOAD_DB=`languages wiki`, or DOWNLOAD_DB=`languages wiki projects chronology`. |
| 27 | + |
| 28 | +- `CREATE_DB`: If you want process you of data using the PBF files, you can pass the values. eg. CREATE_DB=`db projects` or CREATE_DB=`db projects chronology`. |
| 29 | + Note: |
| 30 | + - Value `db` require to pass `URL_PLANET_FILE` or `URL_PLANET_FILE_STATE` |
| 31 | + - Value `projects` require to pass `TAGINFO_PROJECT_REPO` |
| 32 | + - Value `chronology` require to pass `URL_PLANET_FILE` or `URL_HISTORY_PLANET_FILE` |
0 commit comments