From d4e1805badb3efbfd3ca774df46bfb55f3d4c883 Mon Sep 17 00:00:00 2001 From: Zsolt Ero Date: Fri, 20 Sep 2024 15:19:19 +0200 Subject: [PATCH] docs --- README.md | 3 --- docs/self_hosting.md | 24 ++++++++---------------- website/src/content/index/donate.md | 2 +- website/src/content/index/whatis.md | 1 - 4 files changed, 9 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3918bc8..ad1ad6a 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,8 @@ You can either self-host or use our public instance. Everything is **open-source Using our public instance is completely **free**: there are no limits on the number of map views or requests, and no restrictions on how you use your map. There’s no registration, no user database, no API keys, and no cookies. We aim to cover the running costs of our public instance through donations. - #### Quick introduction and how to guide: [https://openfreemap.org/](https://openfreemap.org/) - - ## Goals of this project The goal of this project is to provide free, production-quality vector-tile hosting using existing tools. diff --git a/docs/self_hosting.md b/docs/self_hosting.md index 70c70f4..8f3894d 100644 --- a/docs/self_hosting.md +++ b/docs/self_hosting.md @@ -1,6 +1,6 @@ # Self-hosting Howto -_note: For most users, **you don't need to run anything**! The tiles are hosted free of charge, without registration. Read the "How can I use it?" section on https://openfreemap.org_ +You can either self-host or use our public instance. Everything is **open-source**, including the full production setup — there’s no 'open-core' model here. When self-hosting, there are two tasks you can set up on a server (see details in the repo README). @@ -8,31 +8,23 @@ When self-hosting, there are two tasks you can set up on a server (see details i - **tile-gen** -note: Tile generation is 100% optional, as we are providing the processed full planet files for public download. It also requires a beefy machine, see below. +I there is a 99.9% chance you only need **http-host**. Tile-gen is slow, needs a huge machine and is totally pointless, since we upload the processed files every week. ### System requirements -##### Disk space +**http-host**: 300 GB SSD for hosting a single run and 4 GB RAM -- **http-host**: 300 GB for hosting a single run +**tile-gen**: 500 GB SDD and at least 64 GB ram -- **tile-gen**: 500 GB - -##### RAM - -- **http-host**: 4 GB - -- **tile-gen**: 64 GB+ - -##### OS - -- **Ubuntu 22+** +**Ubuntu 22** or newer --- ### Warning -This project is made to run on clean servers or virtual machines dedicated for this project. The scripts need sudo permissions as they mount/unmount disk images. Do not run this on your dev machine without using virtual machines. If you do, please make sure you understand exactly what each script is doing. +This project is made to run on **clean servers** or virtual machines dedicated for this project. The scripts need sudo permissions as they mount/unmount disk images. Do not run this on your dev machine without using virtual machines. If you do, please make sure you understand exactly what each script is doing. + +If you run it on a non-clean server, please understand that this will modify your nginx config! --- diff --git a/website/src/content/index/donate.md b/website/src/content/index/donate.md index 8d794f6..50f6db5 100644 --- a/website/src/content/index/donate.md +++ b/website/src/content/index/donate.md @@ -4,4 +4,4 @@ If we ever receive a **Diamond** level supporter, we'll put their logo on this p When subscribing to a support plan, you receive an invoice for each of your payments. -Note: if you want to make a single donation, feel free to cancel after the first payment. However, please understand that the nature of this project needs recurring donations to cover the server costs. +Note: if you want to make a single donation, you can do this via [GitHub Sponsors](https://github.com/sponsors/hyperknot). However, please understand that the nature of this project needs recurring donations to cover the server costs. diff --git a/website/src/content/index/whatis.md b/website/src/content/index/whatis.md index 1ddddeb..35363a5 100644 --- a/website/src/content/index/whatis.md +++ b/website/src/content/index/whatis.md @@ -5,4 +5,3 @@ OpenFreeMap lets you display custom maps on your website and apps for free. You can either self-host or use our public instance. Everything is **open-source**, including the full production setup — there’s no 'open-core' model here. Check out our [GitHub](https://github.com/hyperknot/openfreemap). The map data comes from OpenStreetMap. Using our public instance is completely **free**: there are no limits on the number of map views or requests, and no restrictions on how you use your map. There’s no registration, no user database, no API keys, and no cookies. We aim to cover the running costs of our public instance through donations. -