Mapeo Support Materials
English
English
  • Introduction
  • Overview
    • About Mapeo
      • Mapeo tools
      • Peer-to-peer & Mapeo sync
      • How Mapeo is being used
    • Is Mapeo right for me?
    • FAQs
  • Quick start guide
    • Getting started
    • Mapeo Mobile
    • Mapeo Desktop
  • Complete Reference guide
    • Welcome – Introduction
    • 🗒️Essentials for a successful Mapeo project
      • Planning a Mapeo project
        • What is the project goal?
        • What outputs do you want?
        • What information to collect?
          • Data types within Mapeo
        • Who should be involved and how?
        • What are the parameters?
      • Security & risk assessment
      • Creating user protocols
    • ✔️Will Mapeo work out-of-the-box for me?
      • Default configuration
      • Default background map
    • ⚙️Customization options
      • Translating Mapeo & default configurations
      • Custom configurations
        • Creating custom configurations
          • Planning configuration & data structure
            • Categories
            • Icons
            • Details fields
          • Coding configuration
            • Adding icon files
              • Creating and exporting SVG files using Adobe Illustrator
              • Creating and exporting SVG files using Inkscape
            • Creating details fields
            • Creating categories
            • Defining geometry defaults
            • Adding a project key
            • Adding project name and version
            • Building configuration file
              • Via the command line
              • Using GitHub Actions
          • Testing and iterating
      • Custom background maps
        • Creating custom background maps
          • Generating map files in .mbtiles format for the experimental Background Maps feature
    • 📱Mapeo Mobile installation & setup
      • Installing Mapeo Mobile
      • Choosing Mapeo Mobile settings
      • Experiments: Turning on experimental features
        • Directional Arrow
        • P2P (peer-to-peer) App Updates
        • Background Maps
        • Security
          • App Passcode
          • Obscure Passcode
      • Importing configurations into Mapeo Mobile
      • Adding custom background maps to Mapeo Mobile
      • Updating Mapeo Mobile
    • 📱Mapeo Mobile use
      • Activating GPS and viewing current location
      • Creating observations
      • Viewing observations
      • Editing and deleting observations
      • Sharing data externally
      • Syncing data via Wi-Fi
    • 💻Mapeo Desktop installation & setup
      • Installing Mapeo Desktop
      • Choosing Mapeo Desktop language
      • Importing configurations to Mapeo Desktop
      • Adding custom background maps to Mapeo Desktop
      • Updating Mapeo Desktop
    • 💻Mapeo Desktop use
      • Mapeo Desktop for managing Mapeo Mobile data (Observations mode)
        • Synchronizing data
          • Synchronizing via Wi-Fi
          • Synchronizing with a file
        • Viewing observations
        • Editing and deleting observations
        • Exporting data & sharing externally
      • Mapeo Desktop for creating territory data (Territory mode)
        • Navigating around the map
        • Creating and editing territory data
        • Changing background maps in Territory mode
        • Importing and using external geospatial data
        • Exporting and syncing data
      • Synchronizing data with Mapeo Desktop
    • 💡Mapeo trainings
      • Defining goals and format
      • Structuring a training
        • Best practices for planning a training
        • Structuring the agenda, content and activities
          • Suggestions for the different sections of a training event
          • Tips and suggested activities for training key features of Mapeo
          • Materials and resources available for the training event
      • Preparing equipment and supplies for a training
        • Recommended equipment and supplies
        • Tech preparation before doing in-person training
    • 🔧Troubleshooting
      • I can't start Mapeo
      • Mapeo closes automatically
      • I have problems with the GPS in Mapeo
        • GPS is not activated in Mapeo
        • My GPS signal is very weak
      • I have problems with the camera in Mapeo
        • I get a black screen when using the camera
      • I want to update Mapeo Mobile permissions
      • I have sync issues
        • I want to connect to Wi-Fi
        • I want to create local Wi-Fi networks
          • With a portable router
          • With a smartphone
        • The device I want to sync with does not show up on my Synchronize screen
        • I get an error when I try to sync with another device
        • I can't sync with the sync file
        • The person I want to sync with has deleted valuable data
      • Sharing files between devices
      • Saving and printing Mapeo reference materials
      • How do I back up Mapeo Desktop data?
    • Glossary & quick reference sheets
      • Glossary of Mapeo related terms
      • Overview of Mapeo Desktop Territory mode screen
  • For developers
    • Mapeo architecture overview
    • Mapeo repositories
    • Localization
  • Support
  • Additional references
  • Digital Democracy website
Powered by GitBook
On this page
  • What is a Project Key?
  • Creating a Project Key
  • Using mapeo-settings-builder
Export as PDF
  1. Complete Reference guide
  2. Customization options
  3. Custom configurations
  4. Creating custom configurations
  5. Coding configuration

Adding a project key

What is a Project Key?

In the metadata.json file in your Mapeo configuration, you can include a projectKey, which is a random cryptographic string of characters to prevent unwanted devices from getting access to the data.

Once a Mapeo Mobile or Mapeo Desktop device has imported a configuration with a project key, it can only sync with another Mapeo Mobile or Mapeo Desktop device that has the same project key.

You can edit the project key (for example, if you want to make first 4 characters identifiable to a project) but it can only contain letters a-f and numbers 0-9.

It can also only be 64 characters long -- no more, no less.

Creating a Project Key

To create a projectKey, first open the Terminal.

Using mapeo-settings-builder

For instructions on how to install mapeo-settings-builder, see Building configuration file Via the command line.

Copy and paste the following command into the terminal

mapeo-settings-builder generate-key

You'll see something like this (but with x replaced with real characters and numbers)

'380c02d32xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx1d'

Copy this string and add it to the metadata.json file so it looks like this:

{
  "dataset_id": "mapeo-jungle",
  "projectKey": "380c02d32xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx1d"
}

Notice that there are double quotes " around each value.

PreviousDefining geometry defaultsNextAdding project name and version

Last updated 3 years ago

⚙️