sysadmin/openfreemap
1
0
Fork 0
mirror of https://github.com/hyperknot/openfreemap.git synced 2026-05-21 14:02:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Zsolt Ero
2024-02-23 03:12:52 +01:00
parent 7dea397c29
commit 05a2dded9a
3 changed files with 46 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/dev_setup.md Normal file
View File

@@ -0,0 +1,33 @@
# dev setup
### macOS
On macOS, I recommend [OrbStack](https://orbstack.dev/).
I saved this function into my bash_profile. It sets up a clean x64-based Ubuntu 22 VM in a few seconds.
```
orb_reset() {
orbctl delete -f ubuntu-test
orbctl create -a amd64 ubuntu:jammy ubuntu-test
}
```
I saved the following in `.ssh/config`:
```
Host orb_my
Hostname 127.0.0.1
Port 32222
IdentityFile ~/.orbstack/ssh/id_ed25519
```
Then I run commands like the following:
```
./init-server.py http-host-once orb_my
./init-server.py debug orb_my
```

10
docs/self_hosting.md
View File

@@ -12,6 +12,8 @@ When self-hosting, there are two tasks you can set up on a server (see details i
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.
### System requirements
##### Disk space
@@ -34,7 +36,7 @@ note: Tile generation is 100% optional, as we are providing the processed full p
### Limitations
There is two limitation in the current beta version:
There are two limitations in the current beta version:
- You have to set up Let's Encrypt manually or supply your certs.
@@ -67,9 +69,11 @@ It's recommended to use [direnv](https://direnv.net/), to have automatic venv ac
#### 2. Certs and domains
Currently the domain is hard coded to `tiles.openfreemap.org`. Please search & replace for this string to your custom one.
Currently the domain is hard coded to `tiles.openfreemap.org`. Please search & replace this.
The script is made with long expiry CloudFlare origin certificates in mind, which are placed in the `config/certs` folder. For self-hosting you may want to use Let's Encrypt or similar automated tool. The support for this is coming later.
The script is made with long expiry CloudFlare origin certificates in mind, which are placed in the `config/certs` folder. For self-hosting you may want to use Let's Encrypt or similar automated tool.
If you know how to make Let's Encrypt work with Round Robin DNS, please comment in the Discussions.
#### 3. Deploy a http-host