mirror of
https://github.com/hyperknot/openfreemap.git
synced 2026-05-21 22:12:15 +00:00
84 lines
4.4 KiB
Markdown
84 lines
4.4 KiB
Markdown
## What is OpenFreeMap?
|
|
|
|
OpenFreeMap allows you to display custom maps on your website and apps.
|
|
|
|
It's truly **free**: there are no limits on the number of map views or requests you can make, nor on how you use your map. There is no registration page, user database, API keys, or cookies.
|
|
|
|
It's truly **open-source**: everything, including the full production setup, is on [GitHub](https://github.com/hyperknot/openfreemap). Map data is from OpenStreetMap.
|
|
|
|
## How can I use it?
|
|
|
|
<!--map_howto-->
|
|
|
|
## How can I donate or support this project?
|
|
|
|
If this project helps you save on your map hosting costs, please subscribe to one of our support plans here:
|
|
|
|
<!--support_plans-->
|
|
|
|
When subscribing to a support plan, you receive an invoice for each of your payments.
|
|
|
|
On **Gold** level and above, we offer personalised technical support by email.
|
|
|
|
If we ever receive a **Diamond** level supporter, we'll put their logo on this page.
|
|
|
|
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.
|
|
|
|
## Is commercial usage allowed?
|
|
|
|
Yes.
|
|
|
|
## Who is behind this project?
|
|
|
|
I'm Zsolt Ero ([twitter](https://twitter.com/hyperknot), [blog](https://blog.hyperknot.com/)). I built [MapHub](https://maphub.net/) and have been running map hosting in production for 8 years.
|
|
|
|
## Why did you build this project?
|
|
|
|
OpenStreetMap is one of the most important collective projects in history. It began almost 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://twitter.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? How can a one-person project offer unlimited map hosting for free?
|
|
|
|
There is no technical reason why map hosting costs as much as it does today. Vector tiles are just static files. OK, serving 300 million 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.
|
|
|
|
## How can I follow this project?
|
|
|
|
twitter: [hyperknot](https://twitter.com/hyperknot) (more details) and [OpenFreeMapOrg](https://twitter.com/OpenFreeMapOrg) (announcements)
|
|
|
|
GitHub: [openfreemap](https://github.com/hyperknot/openfreemap) and [openfreemap-styles](https://github.com/hyperknot/openfreemap-styles)
|
|
|
|
## What is the tech stack?
|
|
|
|
The map schema is [OpenMapTiles](https://github.com/openmaptiles/openmaptiles), the tiles are generated by [Planetiler](https://github.com/onthegomap/planetiler). The [styles](https://github.com/hyperknot/openfreemap-styles) are forked and heavily modified.
|
|
|
|
There is no tile server running, only BTRFS partition images with 300 million hard-linked files. I haven't heard anyone else doing this in production, but it works really well.
|
|
|
|
There is no cloud, just dedicated servers. The HTTP server is nginx on Ubuntu.
|
|
|
|
Currently, it is behind Cloudflare.
|
|
|
|
## Attribution
|
|
|
|
If you are using MapLibre, attributions are automatically added.
|
|
|
|
If you are using this in printed media or video, please attribute:
|
|
|
|
<a href="https://openfreemap.org" target="_blank">OpenFreeMap</a> <a href="https://www.openmaptiles.org/" target="_blank">© OpenMapTiles</a> Data from <a href="https://www.openstreetmap.org/copyright" target="_blank">OpenStreetMap</a>
|
|
|
|
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).
|