Welcome to FreeField!

This is the official documentation for FreeField. If you are setting up FreeField and are looking for installation help, please see “Installation guide” below.

Getting started

• Installation guide
  • Prerequisites
  • Downloading FreeField
  • Setting up the web server
  • Installation wizard
  • Post-installation steps
• Authentication
  • Discord authentication
  • Telegram authentication
  • Reddit authentication
  • Facebook authentication
  • LINE authentication
  • GroupMe authentication

Administration

• User accounts
  • User account details
  • Manual user approval
• Permissions and groups
  • Default groups
  • Group settings
  • Adding and removing groups
  • Default group for new members
  • Managing permissions
• Map settings
  • Map providers
• Pokéstops
  • Adding a new Pokéstop
  • Moving a Pokéstop
  • Removing Pokéstops
  • Clearing field research
  • Renaming Pokéstops
  • Managing Pokéstops
  • Exporting and importing Pokéstops
• Geofencing
  • Defining a boundary
  • Limiting Pokéstop submission
  • Applying geofences to webhooks
• Webhooks
  • Webhook basics
  • Common webhook targets
  • Webhook properties
  • Payload
  • Task-based filtering
• Site appearance
  • Site name
  • Message of the Day
  • Search indexing
  • Group labels and colors
  • PWA theming
  • Favicon
  • Title bar theme color
  • Site theme color
  • UI and map themes
  • Map markers
• Progressive Web Apps (PWA)
  • How it works
  • Configuration
  • Installation preview
• Installing updates
  • Update branches
  • Installing an update
  • Troubleshooting

For players

• Reporting field research
  • Submitting a report
  • Reporting unlisted research objectives
• Filtering Pokéstops
• Searching for Pokéstops
• Frequently asked questions
  • Why are some markers hidden from the map?

Developer documentation

• API Reference
  • Authentication
  • Response format
  • Object reference
  • Method reference
• Adding research data
  • Objectives
  • Common objectives
  • Rewards
  • Research parameters
  • Icons and categories
• Code style
  • Non-compliance
  • Indentation
  • Spacing
  • Code blocks
  • Wrapping
  • Naming
  • Miscellaneous
  • Commenting
• Configuration
  • Internationalization
  • Domains and sections
  • Options and data types
• Internationalization
  • String assignment
  • Usage
  • Localization file structure
• Icon sets
  • Location
  • File structure
  • The pack.ini metadata file
  • List of icon IDs
• Security in FreeField
  • Cross-site scripting (XSS)
  • Cross-site request forgery (CSRF)
  • Securing authentication
  • Permissions
• Translating FreeField
  • Getting started
  • Files to translate
  • Questions