diff --git a/README.md b/README.md index c38e04e..97bdd16 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ OpenFreeMap lets you display custom maps on your website and apps for free. You can either [self-host](docs/self_hosting.md) or use our public instance. Everything is **open-source**, including the full production setup — there’s no 'open-core' model here. 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. +Using our **public instance** is completely free: there are no limits on the number of map views or requests. 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. We also provide **weekly** full planet downloads both in Btrfs and MBTiles formats. diff --git a/website/src/content/index/after_donate.md b/website/src/content/index/after_donate.md new file mode 100644 index 0000000..6751032 --- /dev/null +++ b/website/src/content/index/after_donate.md @@ -0,0 +1,23 @@ +## What is the tech stack? + +There is no tile server running; only nginx serving a Btrfs image with 300 million hard-linked files. This was my idea; I haven't read about anyone else doing this in production, but it works really well. (You can read more about it on [GitHub](https://github.com/hyperknot/openfreemap).) + +There is no cloud, just dedicated servers. + +Special thanks go to [Michael Barry](https://github.com/msbarry) for developing [Planetiler](https://github.com/onthegomap/planetiler). It made it possible to generate the tiles in 5 hours instead of 5 weeks. The map schema is [OpenMapTiles](https://github.com/openmaptiles/openmaptiles). + +The [styles](https://github.com/hyperknot/openfreemap-styles) are forked and heavily modified. + +## Attribution + +Attribution is required. If you are using MapLibre, they are automatically added, you have nothing to do. + +If you are using alternative clients, or if you are using this in printed media or video, you must add the following attribution: + +OpenFreeMap © OpenMapTiles Data from OpenStreetMap + +You do not need to display the OpenFreeMap part, but it is nice if you do. + +## License + +The license of this project is [MIT](https://www.tldrlegal.com/license/mit-license). Map data is from [OpenStreetMap](https://www.openstreetmap.org/copyright). The licenses for included projects are listed in [LICENSE.md](https://github.com/hyperknot/openfreemap/blob/main/LICENSE.md). diff --git a/website/src/content/index/before_donate.md b/website/src/content/index/before_donate.md new file mode 100644 index 0000000..dd25433 --- /dev/null +++ b/website/src/content/index/before_donate.md @@ -0,0 +1,32 @@ +## Who is behind this project and how can I follow it? + +I'm Zsolt Ero ([blog](https://blog.hyperknot.com/), [email](mailto:zsolt@openfreemap.org)). + +After 9 years of running my own map tile infrastructure for [MapHub](https://maphub.net/), I've open-sourced it and launched OpenFreeMap. + +X: [@hyperknot](https://x.com/hyperknot) (for details) \ +X: [@OpenFreeMapOrg](https://x.com/OpenFreeMapOrg) (for announcements) + +GitHub: [openfreemap](https://github.com/hyperknot/openfreemap) and [openfreemap-styles](https://github.com/hyperknot/openfreemap-styles) + +## Why did you build this project? + +OpenStreetMap is one of the most important collective projects in history. It began 20 years ago, and today, 3 million edits are made each day! + +For a long time, when you wanted to use the map on your website or app, you had to look for a commercial map tile provider and hope your site didn't become too popular. Otherwise, you might end up with a $10,000 bill in a single day, as Hoodmaps [did](https://x.com/levelsio/status/1730659933232730443). + +Self-hosting was an option, but it required a big server and a lot of time to get it right. + +Since I've spent many years developing the map tile infrastructure for [MapHub](https://maphub.net/), I decided to open-source it so anyone can use it. With OpenFreeMap, you now have the option to either set up your own server with just one line of code or use our public instance. + +## How can you offer a free public instance ? + +There is no technical reason why map hosting costs as much as it does today. Vector tiles are just static files. It's true that serving hundreds of millions of files is not easy, but at the end of the day, they are just files. + +Financially, the plan is to keep renting servers until they cover the bandwidth. I believe it can be self-sustainable if enough people subscribe to the support plans. + +If this project helps you save on your map hosting costs, please consider subscribing to a support plan. + +## Is commercial usage allowed? + +Yes. diff --git a/website/src/content/index/rest.md b/website/src/content/index/rest.md deleted file mode 100644 index 6a6bf96..0000000 --- a/website/src/content/index/rest.md +++ /dev/null @@ -1,57 +0,0 @@ -## Is commercial usage allowed? - -Yes - -## Who is behind this project and how can I follow it? - -I'm Zsolt Ero ([X](https://x.com/hyperknot), [blog](https://blog.hyperknot.com/), [email](mailto:zsolt@openfreemap.org)). I built [MapHub](https://maphub.net/) and have been running map hosting in production for 9 years. - -X: [@hyperknot](https://x.com/hyperknot) (for details) \ -X: [@OpenFreeMapOrg](https://x.com/OpenFreeMapOrg) (for announcements) - -GitHub: [openfreemap](https://github.com/hyperknot/openfreemap) \ -GitHub: [openfreemap-styles](https://github.com/hyperknot/openfreemap-styles) - -## Why did you build this project? - -OpenStreetMap is one of the most important collective projects in history. It began 20 years ago, and today, 3 million edits are made each day! - -Unfortunately, when you want to use the map on your website or app, you need to look for a commercial map tile provider and hope your site doesn't become too popular. Otherwise, you might end up with a $10,000 bill in a single day, as Hoodmaps [did](https://x.com/levelsio/status/1730659933232730443). - -You can try self-hosting, but it requires a big server and a lot of time to get it right. - -I waited for years for someone to offer this service but realized that no one was going to do it. So, I thought I might use my map hosting experience and build it myself. - -I'll share more about the reasons in a future [blog post](https://blog.hyperknot.com/). Feel free to subscribe. - -## How can this work [technically and financially]? - -There is no technical reason why map hosting costs as much as it does today. Vector tiles are just static files. It's true that serving hundreds of millions of files is not easy, but at the end of the day, they are just files. - -Financially, the plan is to keep renting servers until they cover the bandwidth. I believe it can be self-sustainable if enough people subscribe to the support plans. - -If this project helps you save on your map hosting costs, please consider subscribing to a support plan. - -## What is the tech stack? - -There is no tile server running; only Btrfs partition images with 300 million hard-linked files. This was my idea; I haven't read about anyone else doing this in production, but it works really well. (You can read more about it on [GitHub](https://github.com/hyperknot/openfreemap).) - -There is no cloud, just dedicated servers. The HTTPS server is nginx on Ubuntu. - -Special thanks go to [Michael Barry](https://github.com/msbarry) for developing [Planetiler](https://github.com/onthegomap/planetiler). It made it possible to generate the tiles in 5 hours instead of 5 weeks. The map schema is [OpenMapTiles](https://github.com/openmaptiles/openmaptiles). - -The [styles](https://github.com/hyperknot/openfreemap-styles) are forked and heavily modified. - -## Attribution - -Attribution is required. If you are using MapLibre, they are automatically added, you have nothing to do. - -If you are using alternative clients, or if you are using this in printed media or video, you must add the following attribution: - -OpenFreeMap © OpenMapTiles Data from OpenStreetMap - -You do not need to display the OpenFreeMap part, but it is nice if you do. - -## License - -The license of this project is [MIT](https://www.tldrlegal.com/license/mit-license). Map data is from [OpenStreetMap](https://www.openstreetmap.org/copyright). The licenses for included projects are listed in [LICENSE.md](https://github.com/hyperknot/openfreemap/blob/main/LICENSE.md). diff --git a/website/src/content/index/whatis.md b/website/src/content/index/whatis.md index 9fc8c8d..686bf05 100644 --- a/website/src/content/index/whatis.md +++ b/website/src/content/index/whatis.md @@ -4,6 +4,6 @@ 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. +Using our **public instance** is completely free: there are no limits on the number of map views or requests. 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. We also provide **weekly** full planet downloads both in Btrfs and MBTiles formats. diff --git a/website/src/pages/index.astro b/website/src/pages/index.astro index b2c5c2c..4e0d402 100644 --- a/website/src/pages/index.astro +++ b/website/src/pages/index.astro @@ -5,7 +5,8 @@ import Logo from '../components/Logo.astro' import Donate from '../components/Donate.astro' import { Content as WhatisText } from '../content/index/whatis.md' -import { Content as RestText } from '../content/index/rest.md' +import { Content as BeforeDonate } from '../content/index/before_donate.md' +import { Content as AfterDonate } from '../content/index/after_donate.md' --- @@ -26,7 +27,8 @@ import { Content as RestText } from '../content/index/rest.md' Quick Start Guide + - +