Getting Help

The easiest way to get help is using our interactive help page:

This interactive tool will:

  • πŸ” Diagnose local deployment issues - Docker, containers, port conflicts, etc.

  • πŸ› οΈ Guide through troubleshooting step-by-step

  • πŸ“‹ Help you fill out all required information

  • πŸ“„ Generate a shareable markdown file for support requests

  • 🎯 Ensure you include all necessary details

The interactive tool now covers all local deployment troubleshooting scenarios and provides the same markdown format as the manual process.


πŸ“‹ Quick Reference Guide

🎯 Scenario
πŸ”„ Action

πŸ†• Any issue

🎯 Use Interactive Help Tool first (/help page)

🌐 Public app down

β›” No support provided

🏠 Local deployment issues

🎯 Use Interactive Help Tool first (/help page) β†’ πŸ“– Manual troubleshooting if needed

πŸ› Tool works but has problems

βœ… Interactive Help Tool β†’ OR β†’ βœ… FAQ β†’ βœ… SRTM30 β†’ βœ… Manual checklist β†’ πŸ’¬ Discord/πŸ› GitHub

πŸ—ΊοΈ Non-SRTM30 DTM issues

πŸ‘€ Contact DTM provider author at PyDTMDLarrow-up-right

  • πŸ“‹ Help you fill out all required information

  • πŸ“„ Generate a shareable markdown file for support requests

  • 🎯 Ensure you include all necessary details

If the interactive tool doesn't solve your issue, it will prepare everything you need for manual support below.


Manual Support Process

If you prefer manual support or the interactive tool isn't available, follow the decision tree below step by step.

πŸš€ Step 1: Which version are you using?

🌐 Public App

https://maps4fs.xyz/

πŸ‘‰ Go to Step 2A

🏠 Local Deployment

Docker/Python on your machine

πŸ‘‰ Go to Step 2B

Step 2A: Public App - Is the tool working?

βœ… YES

Tool loads and responds

πŸ‘‰ Go to Step 3

❌ NO

Tool is down/not loading

β›” STOP HERE

I do not accept any reports or questions related to the public app when it's not working. The public app is provided as-is without support guarantees.

Step 2B: Local Deployment - Is the tool working?

βœ… YES

Tool loads and responds

πŸ‘‰ Go to Step 3

❌ NO

Tool won't start/deploy

🎯 RECOMMENDED: Use Interactive Help Tool

Try the Interactive Help Tool first:

OR if interactive tool doesn't work:

πŸ“‹ Manual troubleshooting process:

Before asking for help, you MUST:

  1. βœ… Complete ALL troubleshooting steps

  2. βœ… Include ALL outputs in your help request

πŸ’‘ Note: The Interactive Help Tool now covers local deployment issues and provides the same markdown format for support requests.

Step 3: Tool works but has issues

Tool loads but crashes during generation or produces unexpected results

πŸ“š Have you checked the FAQ?

βœ… YES

I've read the FAQ

πŸ‘‰ Continue to DTM Check

❌ NO

Haven't read it yet

πŸ“– Read the FAQ first

Your issue might already be solved there!

πŸ—ΊοΈ DTM Provider Check

Which DTM provider are you using?

βœ… SRTM30 Provider

The default/supported provider

πŸ‘‰ Go to Pre-submission Checklist

❌ Other DTM Provider

Any provider except SRTM30

β›” STOP HERE

I only support SRTM30 DTM provider.

For other DTM providers:

  1. πŸ‘€ Find the author of your DTM provider

  2. πŸ“§ Contact them directly

I do not provide help or accept reports for non-SRTM30 DTM providers.

Step 4: Pre-submission Checklist

Before submitting your issue, you MUST confirm ALL of the following:

βœ… Knowledge Check

🎯 Ready to Submit?

βœ… All Confirmed

I've checked everything above

πŸ‘‰ Go to Step 5: Information Checklist

❌ Not Ready

Still need to check some items

⬆️ Go back and complete the missing items

This helps ensure you get the best possible help.

Step 5: Information Checklist

Before contacting support, prepare the following information:

πŸ“ Basic Information

πŸ“ Required Files

Gather these files from your map generation:

πŸ“ Issue Description

Prepare answers to these questions:

πŸ” Additional Details (if applicable)

πŸ“ž Choose Your Support Channel

πŸ’‘ TIP: If you used the Interactive Help Tool, you already have a formatted markdown file ready to share!

For most users

βœ… Pros:

  • Fast community help

  • Easy to share files

  • No GitHub account needed

Join Discordarrow-up-right

Post in #support channel with:

  • Your interactive help output (if available)

  • Or your manual checklist information

πŸ› GitHub Issues

For technical users

βœ… Pros:

  • Detailed issue tracking

  • Better for complex bugs

  • Public record for others

Requirements:

  • GitHub account

  • Familiar with issue templates

πŸ› Create GitHub Issuearrow-up-right

Paste your interactive help output or manual information

πŸ“‹ Final Checklist

Before contacting support, confirm:

Ready to get help! πŸš€

πŸ“‹ Quick Reference Guide

🎯 Scenario
πŸ”„ Action

🌐 Public app down

β›” No support provided

🏠 Local deployment issues

πŸ“– Follow troubleshooting guide first

πŸ› Tool works but has problems

βœ… FAQ β†’ βœ… SRTM30 β†’ βœ… Checklist β†’ οΏ½ Gather info β†’ πŸ’¬ Discord/πŸ› GitHub

πŸ—ΊοΈ Non-SRTM30 DTM issues

πŸ‘€ Contact DTM provider author at PyDTMDLarrow-up-right


Last updated