Skip to content

Commit

Permalink
Merge pull request #492 from pelias/fix-table-formatting
Browse files Browse the repository at this point in the history
Fix table formatting
  • Loading branch information
orangejulius authored Jun 10, 2019
2 parents d3a6258 + 441629f commit f96c861
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,21 +59,33 @@ See [the config](https://github.com/pelias/config) documentation for details on
}
```

The importer has the possibility to download or not the OSM venues.
This ability is managed by the parameter "importVenues" as described below:
### Configuration Settings

| key | required | default | description |
| `imports.openstreetmap.importVenues` | no | true | set to `true` to include venues in the data download and import process |
#### `imports.openstreetmap.datapath`

### Environment Settings
This is the directory where the OSM importer will look for files to import. If configured it will also download files to this location.

- `imports.openstreetmap.datapath` - this is the directory which you downloaded the pbf file to
- `imports.openstreetmap.download[0].sourceURL` - this is the source URL of the pbf file to be downloaded
- `imports.openstreetmap.import[0].filename` - this is the name of the pbf file you downloaded
- `imports.openstreetmap.leveldbpath` - this is the directory where temporary files will be stored in order to denormalize osm ways, in the case of a planet import it is best to have 100GB free so you don't run out of disk.
#### `imports.openstreetmap.download[0].sourceURL`

> __PRO-TIP:__ If your paths point to an SSD rather than a HDD then you will get a significant speed boost, although this is not required.
A URL to download when the download script (in `./bin/download`) is run. Will be downloaded to the `datapath` dirctory.

#### `imports.openstreetmap.import[0].filename`

The OSM importer will look for a file with a name matching this value in the configured `datapath` directory when importing data.

If downloading from a remote URL, the filename must match the value in `sourceURL`.

#### `imports.openstreetmap.leveldbpath`

This is the directory where temporary files will be stored in order to
denormalize OSM ways and relations. In the case of a planet import it is best
to have at least 100GB free.

Defaults to `tmp`.

#### `imports.openstreetmap.importVenues`

By default, the OSM importer imports both venue records and addresses. If set to false, only address records will be imported.

### Administrative Hierarchy Lookup

Expand All @@ -88,10 +100,10 @@ adminLookup is enabled. To disable, set `imports.adminLookup.enabled` to `false

## Running an import

This will start the import process, it will take around 30 seconds to prime it's in-memory data and then you should see regular debugging output in the terminal.
This will start the import process. It may take a few minutes to load administrative data and begin processing the OSM PBF file, then you should see regular progress updates in the terminal.

```bash
$ PELIAS_CONFIG=<path_to_config_json> npm start
$ npm start
```

## How long does it take?
Expand Down

0 comments on commit f96c861

Please sign in to comment.