Skip to content

docs: add missing TRAVELPAYOUTS_API_TOKEN to self-hosting guide#4329

Open
shon91827 wants to merge 1 commit into
koala73:mainfrom
shon91827:fix/self-hosting-missing-travelpayouts
Open

docs: add missing TRAVELPAYOUTS_API_TOKEN to self-hosting guide#4329
shon91827 wants to merge 1 commit into
koala73:mainfrom
shon91827:fix/self-hosting-missing-travelpayouts

Conversation

@shon91827

Copy link
Copy Markdown
Contributor

Summary

SELF_HOSTING.md's docker-compose API keys example was missing TRAVELPAYOUTS_API_TOKEN, which powers the fly LON DXB flight price command mentioned in README.md.

Without this key in their docker-compose.override.yml, self-hosters get a "credentials required" message when using the flight price feature and have no obvious path to fixing it from the self-hosting docs.

Added it under the Aviation section alongside AVIATIONSTACK_API.

Source of truth

  • server/worldmonitor/aviation/v1/search-flight-prices.ts:48 reads TRAVELPAYOUTS_API_TOKEN
  • .env.example:118 documents the key
  • README.md:78 mentions the key by name

No code changes — documentation only.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jun 18, 2026

Copy link
Copy Markdown

@shonchen is attempting to deploy a commit to the World Monitor Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the trust:safe Brin: contributor trust score safe label Jun 18, 2026
@greptile-apps

greptile-apps Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds the missing TRAVELPAYOUTS_API_TOKEN environment variable to the docker-compose API keys example in SELF_HOSTING.md. The change is accurate — the token is actively read in server/worldmonitor/aviation/v1/search-flight-prices.ts and documented in .env.example, so its absence from the self-hosting guide was a genuine gap.

  • Inserts TRAVELPAYOUTS_API_TOKEN in the Aviation section of the docker-compose.override.yml snippet, between AVIATIONSTACK_API and the Maritime block, matching the logical grouping already in place.
  • The "Free vs Paid" tier table at the bottom of the file was not updated to include the new key alongside the other aviation entry.

Confidence Score: 4/5

Documentation-only change that correctly adds a missing environment variable to the self-hosting guide; the key is verified against actual source usage.

The added entry matches what the code reads (TRAVELPAYOUTS_API_TOKEN in search-flight-prices.ts) and what .env.example documents. The only gap is that the Free vs Paid tier table was not updated to include the new key, leaving self-hosters without signup cost guidance for this specific token.

SELF_HOSTING.md — the Free vs Paid table at line 98 does not yet list Travelpayouts alongside the other free-signup keys.

Important Files Changed

Filename Overview
SELF_HOSTING.md Adds TRAVELPAYOUTS_API_TOKEN to the docker-compose API key example; the key is verified to be used in server/worldmonitor/aviation and documented in .env.example. The Free vs Paid tier table was not updated to include the new key.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Self-hoster sets up docker-compose.override.yml] --> B{TRAVELPAYOUTS_API_TOKEN set?}
    B -- Yes --> C[fly LON DXB returns live flight quotes]
    B -- No --> D[credentials required message shown]
    C --> E[search-flight-prices.ts reads token from env]
    D --> F[AviationCommandBar.ts displays error]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[Self-hoster sets up docker-compose.override.yml] --> B{TRAVELPAYOUTS_API_TOKEN set?}
    B -- Yes --> C[fly LON DXB returns live flight quotes]
    B -- No --> D[credentials required message shown]
    C --> E[search-flight-prices.ts reads token from env]
    D --> F[AviationCommandBar.ts displays error]
Loading

Comments Outside Diff (1)

  1. SELF_HOSTING.md, line 98 (link)

    P2 The "Free vs Paid" tier table lists AVIATIONSTACK_API but does not include the newly added TRAVELPAYOUTS_API_TOKEN. Self-hosters scanning that table to understand what signup is required will have no signal for this key. The .env.example describes it as "optional, demo only" (free-tier registration exists at travelpayouts.com), so it fits in the free-signup row alongside the other aviation key.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Reviews (1): Last reviewed commit: "docs: add missing TRAVELPAYOUTS_API_TOKE..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

trust:safe Brin: contributor trust score safe

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants