Skip to content

Latest commit

 

History

History
158 lines (110 loc) · 8.86 KB

README.md

File metadata and controls

158 lines (110 loc) · 8.86 KB
Raw

openstreetmap-website

Lint Tests Coverage Status

This is openstreetmap-website, the Ruby on Rails application that powers the OpenStreetMap website and API.

This repository consists of:

  • The web site, including user accounts, diary entries, user-to-user messaging.
  • The XML- and JSON-based editing API.
  • The integrated version of the iD editor.
  • The Browse pages - a web front-end to the OpenStreetMap data.
  • The GPX uploads, browsing and API.

A fully-functional openstreetmap-website installation depends on other services, including map tile servers and geocoding services, that are provided by other software. The default installation uses publicly-available services to help with development and testing.

License

This software is licensed under the GNU General Public License 2.0, a copy of which can be found in the LICENSE file.

Installation

openstreetmap-website is a Ruby on Rails application that uses PostgreSQL as its database, and has a large number of dependencies for installation. For full details please see INSTALL.md.

Development

We're always keen to have more developers! Pull requests are very welcome.

More details on contributing to the code are in the CONTRIBUTING.md file.

Maintainers

Docker for local development

For a standalone ohm-website development server, follow the steps below:

  1. Check out this repository to your local machine. Make sure you also have Docker installed. You can get Docker at https://docs.docker.com/get-docker/

  2. Create a config/storage.yml from config/example.storage.yml with

cp config/example.storage.yml config/storage.yml
  1. Create a ohm-docker.env from ohm-docker.env.example. If you are using the database as part the docker setup in this repo, leave the defaults. This command is an easy way to do that:
cp ohm-docker.env.example ohm-docker.env
  1. Create a config/settings.local.yml from config/settings.yml. This command is an easy way to do that:
cp config/settings.yml config/settings.local.yml

  1. Run docker compose up --build. If you encounter any SEGFAULT Code 139 errors, you need to allocate more memory to Docker. Go to the GUI Docker Dashboard > Settings and allocate at least 6GB.

  2. Visit http://localhost:3000

  3. Create an account using the Sign up link.

  4. Follow instructions in the Managing users section of CONFIGURE.md to activate the user, provide admin privileges, and create OAuth2 tokens for iD and Website. That file also shows how to supply these keys in settings.local.yml.

To activate user, you'll need to open a bash session in the container, so you can run the Rails commands in the OSM docs. Do that in a new terminal window with docker exec -it ohm-website-web-1 bash, then follow the Rails specific commands in CONFIGURE.md.

  1. Restart containers by going back to your terminal where they are running, stopping them with ctrl-C to stop the containers, and then doing docker compose up to start them up again.

Populating Local Data

For testing purposes, it is useful to pull in data from the live OHM or staging website so you can see real-world examples of how the system is handling tags, etc.

Rather than importing a whole planet file, an easy way to do this is to find items on the live website you want to test, export them, and then import them locally.

Some good ways to find relevant content are using https://taginfo.openhistoricalmap.org to find specific keys or values, or using Overpass Turbo for the same purpose, at https://openhistoricalmap.github.io/overpass-turbo.

Once you find a item you want to import, navigate to it on the live website, like at https://staging.openhistoricalmap.org/way/198291609

Open your browser's Dev Tools network panel, then open the Map Layers window on the right side of the OHM website. Select "Map Data" to load the map data from OHM database.

Search the network panel for BBOX and you’ll find an API call like this: https://staging.openhistoricalmap.org/api/0.6/map?bbox=-122.3349925875664,47.59867932091805,-122.33449235558511,47.59930511547229.

Putting that as the wget [URL] -O map.osm target of the following shell script would get you all the features in that BBOX.

Alternatively, you can use the NGMDB's Extent Helper to draw your bounding box and copy its corners from the CSV OSM (Decimal Degrees - W, S, E, N) output field.

Know that, however you do it, the bounding box must be smaller than 0.25 square degrees (deg²), contain less than 100,000 nodes, and possibly other limits.

Run this inside the Docker container:

apt update
apt-get install -y wget

#replace this link with whatever BBOX you want to import. Be sure to retain the flag and filename after the URL
wget https://www.openhistoricalmap.org/api/0.6/map?bbox=-122.33347713947298,47.60143384611086,-122.33222991228105,47.60254791359933 -O map.osm

osmosis --read-xml \
        file=map.osm \
        --write-apidb \
        host=$POSTGRES_HOST \
        database=$POSTGRES_DATABASE \
        user=$POSTGRES_USER \
        password=$POSTGRES_PASSWORD \
        validateSchemaVersion=no

#this updates the internal database to recognize the data you just imported with proper IDs
psql -U $POSTGRES_USER -h $POSTGRES_HOST -d $POSTGRES_DATABASE -c "select setval('current_nodes_id_seq', (select max(node_id) from nodes));"
psql -U $POSTGRES_USER -h $POSTGRES_HOST -d $POSTGRES_DATABASE -c "select setval('current_ways_id_seq', (select max(way_id) from ways));"
psql -U $POSTGRES_USER -h $POSTGRES_HOST -d $POSTGRES_DATABASE -c "select setval('current_relations_id_seq', (select max(relation_id) from relations));"

OHM does make its planet files available, daily, at http://planet.openhistoricalmap.org/?prefix=planet/; in Sep 2023 the size of these files hovers around 800Mb. The import process is identical to that outlined above with the exception that the osmosis call would be changed to something like

osmosis --read-pbf \
        file=planet-230918_0002.osm.pbf \
        --write-apidb \
        host=$POSTGRES_HOST \
        database=$POSTGRES_DATABASE \
        user=$POSTGRES_USER \
        password=$POSTGRES_PASSWORD \
        validateSchemaVersion=no

but the default Docker configuration does not allow for that much data.

If you find that you need to reset your database, the command to truncate all current and history tables in an API database is:

osmosis --td \
        host=$POSTGRES_HOST \
        database=$POSTGRES_DATABASE \
        user=$POSTGRES_USER \
        password=$POSTGRES_PASSWORD \
        validateSchemaVersion=no

Updating iD

To update the version of iD that we run on openhistoricalmap.org, do the following:

  • Make sure the staging branch of our iD fork contains the final dist output of npm run all. If you don't commit that there, you won't pull in the latest changes over here.
  • Open a bash session in your local Docker container for the website and do rm -rf vendor/assets/iD/* && vendorer
  • This will pull in the latest and allow you to test locally before you commit and push. See above for importing local data, which is handy for testing.
  • Commit and push the outcome of that in a PR against the staging branch of this repo, and then we can merge and deploy that.