Docker/AdventureLog
Docker/AdventureLog
1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-07-18 20:39:36 +02:00
Code Issues Releases Activity

Add Google Maps integration documentation and update docker-compose for API key

Browse source
This commit is contained in:
Sean Morley 2025-05-26 13:59:18 -04:00
parent f355ba48e2
commit b25bf4af27
3 changed files with 43 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
documentation/.vitepress/config.mts
View file

@ -1,7 +1,5 @@
import { defineConfig } from "vitepress";
const inProd = process.env.NODE_ENV === "production";
// https://vitepress.dev/reference/site-config
export default defineConfig({
head: [
@ -58,7 +56,8 @@ export default defineConfig({
softwareVersion: "v0.9.0",
license:
"https://github.com/seanmorley15/adventurelog/blob/main/LICENSE",
screenshot: "https://raw.githubusercontent.com/seanmorley15/AdventureLog/refs/heads/main/brand/screenshots/adventures.png",
screenshot:
"https://raw.githubusercontent.com/seanmorley15/AdventureLog/refs/heads/main/brand/screenshots/adventures.png",
downloadUrl: "https://github.com/seanmorley15/adventurelog",
sameAs: ["https://github.com/seanmorley15/adventurelog"],
keywords: [
@ -171,6 +170,10 @@ export default defineConfig({
text: "Immich Integration",
link: "/docs/configuration/immich_integration",
},
{
text: "Google Maps Integration",
link: "/docs/configuration/google_maps_integration",
},
{
text: "Social Auth and OIDC",
link: "/docs/configuration/social_auth",

36
documentation/docs/configuration/google_maps_integration.md Normal file
View file

@ -0,0 +1,36 @@
# Google Maps Integration
To enable Google Maps integration in AdventureLog, you'll need to create a Google Maps API key. This key allows AdventureLog to use Google Maps services such as geocoding and location search throughout the application.
Follow the steps below to generate your own API key:
## Google Cloud Console Setup
1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
2. Create an account if you don't have one in order to access the console.
3. Click on the project dropdown in the top bar.
4. Click **New Project**.
5. Name your project (e.g., `AdventureLog Maps`) and click **Create**.
6. Once the project is created, ensure it is selected in the project dropdown.
7. Click on the **Navigation menu** (three horizontal lines in the top left corner).
8. Navigate to **Google Maps Platform**.
9. Once in the Maps Platform, click on **Keys & Credentials** in the left sidebar.
10. Click on **Create credentials** and select **API key**.
11. A dialog will appear with your new API key. Copy this key for later use.
<!-- To prevent misuse:
1. Click the **Edit icon** next to your new API key.
2. Under **Application restrictions**, choose one:
- Choose **Websites** as the restriction type.
- Add the domain of the AdventureLog **backend** (e.g., `https://your-adventurelog-backend.com`). -->
## Configuration in AdventureLog
Set the API key in your environment file or configuration under the backend service of AdventureLog. This is typically done in the `docker-compose.yml` file or directly in your environment variables `.env` file.
```env
GOOGLE_MAPS_API_KEY=your_api_key_here
```
Once this is set, AdventureLog will be able to utilize Google Maps services for geocoding and location searches instead of relying on the default OpenStreetMap services.