Skip to content

Commit

Permalink
Docker FAQ.
Browse files Browse the repository at this point in the history
  • Loading branch information
@iwatkot
iwatkot committed Jan 6, 2025
1 parent ab7363e commit 3f1d8ae
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 14 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
```
And open [http://localhost:8501](http://localhost:8501) in your browser.<br>
If you don't know how to use Docker, navigate to the [Docker version](#option-2-docker-version), it's really simple.<br>
Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>

### 🤯 For developers
**Option 3:** Python package. Install the package using the following command:
Expand Down Expand Up @@ -159,6 +160,7 @@ Using it is easy and doesn't require any guides. Enjoy!
🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.
⚙️ Advanced settings: enabled.
🖼️ Texture dissolving: enabled.
Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:

1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
Expand Down
31 changes: 31 additions & 0 deletions docs/FAQ_docker.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Frequently Asked Questions about Docker

In this section, you will find anwers to the most frequently asked questions about usage of the Docker version of the app. Most of those questions are not related to the app, but to the Docker itself. Please, before asking a question, or opening an issue, check if the answer is already here. Thank you!


### I can't install/launch Docker, it says something about Virtualization, what should I do?

Refer to the Docker documentation, specifically [System requirements](https://docs.docker.com/desktop/setup/install/windows-install/#system-requirements). It's very well explained there.
Complete step by step tutorial can be found [here](https://docs.docker.com/desktop/troubleshoot-and-support/troubleshoot/topics/#virtualization).

### I can't launch Docker, it says something about WSL, what should I do?

By default, Docker Desktop for Windows uses the WSL 2 backend. And it's probably is not installed on your system. While you can install it and use the WSL backend, you can also switch to the Hyper-V backend, which is easier to set up. Note, that Hyper-V should be enabled on your system (check the previous question).

To do it, go to the Docker Desktop, open the **Settings**, then **General**, and switch to the Hyper-V backend. Then restart the Docker Desktop.

![Disable WSL](https://github.com/user-attachments/assets/9a4032c0-b265-49c7-8cbb-b0884e030713)

### It looks like I can not upgrade the software, why?

When working with Docker you should remember that you're working with containers. And when you running a new container, if you already downloaded the image before, it will be used from the cache. So, in that case you'll always get the old version of the software. To get the new version, you should remove the old container and image, and then run the new one.
To do it, go to the Docker Desktop, open the **Containers** tab, select all containers, click **Stop**, then **Remove**. Then go to the **Images** tab and do the same. After that, you can run the new container.

### It looks like the app crashes in Docker, why?

Probably, it's because of the Docker Exit Code 137, which meants OOM (Out of Memory). You can increase the memory limit for the Docker Desktop in the settings if you're using Hyper-V backend. If you're using WSL backend, you can increase the memory limit in the [WSL Settings](https://learn.microsoft.com/en-us/answers/questions/1296124/how-to-increase-memory-and-cpu-limits-for-wsl2-win).

To do it, go to the Docker Desktop, open the **Settings**, then **Resources**, and increase the memory limit. Then restart the Docker Desktop.
Note, that depending on the settings of generation (the map size, resize factors and so on), the app may work with images of enormous sizes, which require a lot of memory. For example, when you downloading the satellite images for a 4 km map, the resulting image is 20K x 20K pixels, which is 400 megapixels. And it requires a lot of memory to process it. And also, when generating mesh for backgrpound terrain, the app uses a lot of memory too. If your machine can't handle it, con sider lowering the generation settings.

![Increase memory limit](https://github.com/user-attachments/assets/c0101e93-0377-4515-aece-210522aa0aa5)
33 changes: 19 additions & 14 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,22 @@ Hey, welcome to the maps4fs documentation! Here you will find all the informatio
Recommended reading order:

1. Check out the frequently asked questions (FAQ) in the [FAQ section](FAQ.md).
2. Learn the short step by step guide in the [Step by step guide](step_by_step.md).
3. Make sure you read the [Tips and Hints](tips_and_hints.md) section.
4. Learn how [DEM](dem.md) works and what it is.
5. Learn how to work with [textures](textures.md) in Giant Editor.
6. Read the detailed description of the [Map Structure](map_structure.md).
7. Learn how to [download satellite images](download_satellite_images.md) for your map.
8. Learn how to [create a background terrain](create_background_terrain.md) for your map.
9. Get familiar with [importing i3d files](import_to_giants_editor.md) into Giants Editor.
10. Learn how to [create water planes](create_water_planes.md) for Giants Editor.
11. Read about working with [fields](fields.md) in Giants Editor.
12. Read about working with [farmlands](farmlands.md) in Giants Editor.
13. Check out the documentation about [usage of custom OSM files](custom_osm.md) in maps4fs.
14. Learn how to work with the [splines](splines.md) and how to use them.
15. Check out the documentation about [creating your own DEM file](custom_dem.md).
2. If you're using local (Docker) version of the app, check out the [Docker FAQ](docker_faq.md).
3. Learn the short step by step guide in the [Step by step guide](step_by_step.md).
4. Make sure you read the [Tips and Hints](tips_and_hints.md) section.
5. Learn how [DEM](dem.md) works and what it is.
6. Learn how to work with [textures](textures.md) in Giant Editor.
7. Read the detailed description of the [Map Structure](map_structure.md).
8. Learn how to [download satellite images](download_satellite_images.md) for your map.
9. Learn how to [create a background terrain](create_background_terrain.md) for your map.
10. Get familiar with [importing i3d files](import_to_giants_editor.md) into Giants Editor.
11. Learn how to [create water planes](create_water_planes.md) for Giants Editor.
12. Read about working with [fields](fields.md) in Giants Editor.
13. Read about working with [farmlands](farmlands.md) in Giants Editor.
14. Check out the documentation about [usage of custom OSM files](custom_osm.md) in maps4fs.
15. Learn how to work with the [splines](splines.md) and how to use them.
16. Check out the documentation about [creating your own DEM file](custom_dem.md).

## For developers

1. How to add your own [DTM Provider](dtm_providers.md) to maps4fs.

0 comments on commit 3f1d8ae

Please sign in to comment.