Skip to content

Commit bc296d7

Browse files
Author technical note on local servers (ALD-25)
Local servers are a typical use case and may not work as intended without some additional setup.
1 parent 1d4cb2b commit bc296d7

File tree

3 files changed

+61
-3
lines changed

3 files changed

+61
-3
lines changed

MCMaps.xcodeproj/xcuserdata/marquis.xcuserdatad/xcschemes/xcschememanagement.plist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<key>Sanity Tests.xcscheme_^#shared#^_</key>
1818
<dict>
1919
<key>orderHint</key>
20-
<integer>4</integer>
20+
<integer>3</integer>
2121
</dict>
2222
</dict>
2323
<key>SuppressBuildableAutocreation</key>
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# TN0002: Bluemap Integration with a Local Server
2+
3+
@Metadata {
4+
@TitleHeading("Technical Note")
5+
@PageColor(orange)
6+
@Redirected(from: "RedWindow")
7+
}
8+
9+
Read and understand common pitfalls or gotchas when using the Bluemap
10+
integration on a local server.
11+
12+
## Overview
13+
14+
In Alidade v2025.2, a new feature was introduced that allows players to
15+
fetch player locations and server markers from Minecraft servers with the
16+
Bluemap plugin installed. However, if you are hosting this server locally,
17+
you may run into some additional problems or need to perform extra steps
18+
to ensure it works correctly.
19+
20+
> SeeAlso: For more information on how to set this up at a basic level,
21+
> refer to <doc:Guide-Bluemap>.
22+
23+
## Alidade expectations
24+
25+
For the Bluemap integration to work correctly, Alidade expects the
26+
following to be true:
27+
28+
- The server is hosted on a standard port or can be access with a valid
29+
domain name.
30+
- The server can be accessed securely via HTTPS.
31+
32+
Most of this can be handled easily by putting Bluemap behind a reverse
33+
proxy using a service like Nginx or Caddy. The Bluemap documentation
34+
provides an excellent resource for learning how to set this up.
35+
36+
[Set up a reverse proxy for Bluemap &rsaquo;](https://bluemap.bluecolored.de/wiki/webserver/ReverseProxy.html)
37+
38+
### SSL certificates
39+
40+
You will need to provide SSL certificates, either self-signed or from a
41+
trusted certificate authority (CA). If you are planning to host your
42+
Bluemap externally, you can do this easily with the `certbot` utility and
43+
using certificates provided by Let's Encrypt.
44+
45+
Self-signed certificates are also an option, but you will need to ensure
46+
that your devices have the certificate installed locally and trust your
47+
certificate.
48+
49+
[Create self-signed certificates in Keychain Access on Mac &rsaquo;](https://support.apple.com/guide/keychain-access/create-self-signed-certificates-kyca8916/mac)
50+
[Trust manually installed certificate profiles in iOS, iPadOS, and visionOS &rsaquo;](https://support.apple.com/en-us/102390)
51+
52+
### Internal DNS server
53+
54+
If you have set your server with an internal DNS server so that your
55+
domain maps both locally and externally, you may run into difficulties
56+
with connecting to Bluemap through Alidade on iOS and iPadOS. Turning off
57+
the **Limit IP Address Tracking** for your WiFi network that maps to the
58+
internal DNS server might restore this functionality.

MCMaps/Resources/Alidade.docc/User Guide/Guide-Bluemap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,5 +117,5 @@ local copy wherever possible.
117117

118118
## Additional resources
119119

120-
[Bluemap &rsaquo;](https://bluemap.bluecolored.de)
121-
120+
[Bluemap &rsaquo;](https://bluemap.bluecolored.de)
121+
<doc:BluemapLocal>

0 commit comments

Comments
 (0)