Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hyperknot committed Sep 20, 2024
1 parent bce1241 commit d4e1805
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 21 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
24 changes: 8 additions & 16 deletions docs/self_hosting.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,30 @@
# 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).

- **http-host**

- **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!

---

Expand Down
2 changes: 1 addition & 1 deletion website/src/content/index/donate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 0 additions & 1 deletion website/src/content/index/whatis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit d4e1805

Please sign in to comment.