LogoLogo
  • OFN Testing Documentation
  • Feature Testing Handbook
    • 1. Background
    • 2. Testing
    • 3. Reporting Feedback
    • 4. Launching the next action
  • Manual Testing Handbook
    • 1. Getting started
    • 2. How to do a sanity check (release testing)?
    • 3. How to do a sanity check in production (after a release)?
    • 4. Test cases
    • 5. Work in Progress
  • Automated Testing Handbook
    • System Specs
    • Automate release testing
    • Some more background
    • (R)Spec Conventions
  • Testers Toolkit
    • Multi-Account Containers
    • Flaky specs
    • Re-running Migrations
    • Enabling Open Street Maps
    • Performance testing with Postman
    • Reverting Database Changes
Powered by GitBook
On this page

Was this helpful?

  1. Testers Toolkit

Enabling Open Street Maps

Quick guide to enable OSM in staging servers

PreviousRe-running MigrationsNextPerformance testing with Postman

Last updated 1 year ago

Was this helpful?

To enable OSM on a staging server, you'll need:

  • ssh access to the server (with admin rights)

  • an OFN user account (with superadmin rights)

  • a geocoder API key

Then, follow the steps:

  • Log in to the staging server via ssh and edit the configuration file for the respective environment. For OFN staging servers that should be ~/apps/openfoodnetwork/current/.env.staging

  • Comment or delete existing Google Maps and replace it with the Mapbox key.

    • #GOOGLE_MAPS_API_KEY=...

    • Add the GEOCODER_API_KEY=pk.eyJ1IjoiZmZ1cnR...<look within the testing section of Bitwarden>

  • restart puma sudo systemctl restart puma.service

  • Log in as superadmin and visit the Content section (under Configuration).

    • Find the MAP section and tick the Open Street Map enabled checkbox

    • Under Open Street Map provider name: add OpenStreetMap.Mapnik

    • Save the changes by clicking Update

You can check it in the bottom-right corner of the map:

Visit /map ; you should be looking at an OSM map

🎉