You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration/plugins.md
+27-8Lines changed: 27 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,18 +50,21 @@ Typically, plugins do not necessitate additional configuration. However, there a
50
50
51
51
### Map Plugin
52
52
53
-
The Map plugin exclusively supports the Google Maps Platform. To enable access to Google Maps data, two <ahref="https://developers.google.com/maps/documentation/javascript/get-api-key?hl=en">Google API Keys</a> are required.
53
+
The Map plugin works exclusively with the Google Maps Platform. To enable it, you need two <ahref="https://developers.google.com/maps/documentation/javascript/get-api-key?hl=en">Google API keys</a>, each with different permissions:
54
54
55
-

55
+
- Geocoding API
56
+
- Maps Javascript API
56
57
57
-
Generate two API keys and append the following lines to the configuration file `dtable_web_settings.py`.
58
+
Using two separate keys is recommended for security and cost control. While technically the same key could be used for both, separating them ensures that your Geocoding API key (which is expensive) is not exposed to end users.
58
59
59
60
```bash
60
-
DTABLE_GOOGLE_MAP_KEY = '<replace with your Google Maps API Key>'
61
-
SERVER_GOOGLE_MAP_KEY = '<replace with your Google Maps API Key>'
61
+
DTABLE_GOOGLE_MAP_KEY = '<your Maps JavaScript API key here>'
62
+
SERVER_GOOGLE_MAP_KEY = '<your Geocoding API key here>'
62
63
```
63
64
64
-
!!! warning "Required scope of the API keys"
65
+

66
+
67
+
!!! danger "Required scope of the API keys"
65
68
66
69
To safeguard your Google API Keys from abuse, restrict their usage. However, even with restrictions in place, abuse remains a risk—especially since `DTABLE_GOOGLE_MAP_KEY` must be included in your source code and is therefore publicly accessible. Additionally, heavy use of the maps plugin may increase your Google billing, so monitor your spending closely.
67
70
@@ -70,9 +73,25 @@ SERVER_GOOGLE_MAP_KEY = '<replace with your Google Maps API Key>'
70
73
| `DTABLE_GOOGLE_MAP_KEY` | Restrict to your Server URL,<br>like `https://cloud.seatable.io` | Maps Javascript API |
71
74
| `SERVER_GOOGLE_MAP_KEY` | **No website restriction** | Geocoding API |
72
75
73
-
Remember to [restart the SeaTable Service](../maintenance/restart-seatable.md) to apply the changes from the updated configuration file.
74
76
75
-

77
+
#### `SERVER_GOOGLE_MAP_KEY`
78
+
79
+
- Used for **server-side requests** (Geocoding API).
80
+
-**Do not** restrict it to a website (since requests originate from the server).
81
+
- Restrict it instead by **API usage** → only allow the *Geocoding API*.
82
+
83
+

84
+
85
+
#### `DTABLE_GOOGLE_MAP_KEY`
86
+
87
+
- Used for **client-side requests** (Maps JavaScript API).
88
+
- This key must be embedded in the frontend and will therefore be **publicly visible**.
89
+
- Restrict it to your **SeaTable server’s domain** (HTTP referrers).
90
+
- Allow usage only for the *Maps JavaScript API*.
91
+
92
+

93
+
94
+
Remember to [restart the SeaTable Service](../maintenance/restart-seatable.md) to apply the changes from the updated configuration file.
Copy file name to clipboardExpand all lines: docs/upgrade/extra-upgrade-notice.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -139,7 +139,7 @@ Of course, you can skip this script and make the changes manually. The following
139
139
140
140
??? info "Maps Plugin utilizes two API Keys"
141
141
142
-
The Google Maps Plugin now uses two separate Google API keys instead of one. Please refer to the [documentation for further details](../configuration/plugins.md).
142
+
The Google Maps Plugin now uses two separate Google API keys instead of one. Please refer to the [documentation for further details](../configuration/plugins.md#map-plugin).
0 commit comments