diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ff93413 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Stichting Bellingcat + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..06416c2 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# osm-search + +This is a tool for allowing user friendly proximity queries from OpenStreetMap data. + +Bellingcat has a hosted version of the tool at https://osm-search.bellingcat.com/. For more information, see [the accompanying article](https://www.bellingcat.com/resources/how-tos/2023/05/08/finding-geolocation-leads-with-bellingcats-openstreetmap-search-tool/). + +![A screenshot of the tool in use](https://www.bellingcat.com/app/uploads/2023/04/image5-3-1200x829.png) + +## Setup and hosting your own + +### Setting up the database + +A Postgres database must be set up with OSM data. This can be done with `osm2pgsql`. + +`osm2pgsql -d osm --hstore-all planet-latest.osm.pbf` + +Next, some additional setup should be done on the database for performance and to create a combined view of all the data: + +``` +psql -d osm clean.sql +psql -d osm cluster.sql +psql -d osm index.sql +psql -d osm analyze.sql +psql -d osm views.sql +``` + +Note that if you run this using the entire planet OSM file, it will require about 700GB of space. + +### Running the API + +The API requires environment variables for connection with Postgres. + +- `PG_DB` +- `PG_HOST` +- `PG_PORT` +- `PG_USER` +- `PG_PASSWORD` + +### Running the frontend + +The frontend requires one environment variable, `VUE_ENV_MAPBOX_KEY` to be set. This Mapbox key is used for geocoding queries.