Skip to content

Commit d4e1805

Browse files
committed
docs
1 parent bce1241 commit d4e1805

File tree

4 files changed

+9
-21
lines changed

4 files changed

+9
-21
lines changed

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,8 @@ You can either self-host or use our public instance. Everything is **open-source
88

99
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.
1010

11-
1211
#### Quick introduction and how to guide: [https://openfreemap.org/](https://openfreemap.org/)
1312

14-
15-
1613
## Goals of this project
1714

1815
The goal of this project is to provide free, production-quality vector-tile hosting using existing tools.

docs/self_hosting.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,30 @@
11
# Self-hosting Howto
22

3-
_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_
3+
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.
44

55
When self-hosting, there are two tasks you can set up on a server (see details in the repo README).
66

77
- **http-host**
88

99
- **tile-gen**
1010

11-
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.
11+
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.
1212

1313
### System requirements
1414

15-
##### Disk space
15+
**http-host**: 300 GB SSD for hosting a single run and 4 GB RAM
1616

17-
- **http-host**: 300 GB for hosting a single run
17+
**tile-gen**: 500 GB SDD and at least 64 GB ram
1818

19-
- **tile-gen**: 500 GB
20-
21-
##### RAM
22-
23-
- **http-host**: 4 GB
24-
25-
- **tile-gen**: 64 GB+
26-
27-
##### OS
28-
29-
- **Ubuntu 22+**
19+
**Ubuntu 22** or newer
3020

3121
---
3222

3323
### Warning
3424

35-
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.
25+
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.
26+
27+
If you run it on a non-clean server, please understand that this will modify your nginx config!
3628

3729
---
3830

website/src/content/index/donate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ If we ever receive a **Diamond** level supporter, we'll put their logo on this p
44

55
When subscribing to a support plan, you receive an invoice for each of your payments.
66

7-
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.
7+
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.

website/src/content/index/whatis.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,3 @@ OpenFreeMap lets you display custom maps on your website and apps for free.
55
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.
66

77
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.
8-

0 commit comments

Comments
 (0)