Skip to content

docs(env): document NEXT_PUBLIC_APP_URL in .env.example, README and docs/ENVIRONMENT.md #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dev-dave01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(env): document NEXT_PUBLIC_APP_URL in .env.example, README and docs/ENVIRONMENT.md #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Backend API base URL
NEXT_PUBLIC_API_URL=http://localhost:3000

# Public origin this frontend is served from. Used for canonical/OG URLs
# (metadataBase) and sitemap.xml entries. MUST be the public origin in
# production (e.g. https://stellartickets.app) — leaving it unset there
# silently emits http://localhost:3001 URLs.
NEXT_PUBLIC_APP_URL=http://localhost:3001

# Must match the backend's STELLAR_NETWORK / the network Freighter is set to
NEXT_PUBLIC_STELLAR_NETWORK=testnet
NEXT_PUBLIC_STELLAR_NETWORK_PASSPHRASE="Test SDF Network ; September 2015"
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ See [`.env.example`](.env.example) for the full list.
| Variable | Meaning |
|---|---|
| `NEXT_PUBLIC_API_URL` | Base URL of the [backend](https://github.com/StellarTickets/backend) API |
| `NEXT_PUBLIC_APP_URL` | Public origin this frontend is served from, used for canonical/OG URLs and `sitemap.xml`. **Must be the public origin in production** (e.g. `https://stellartickets.app`) — if it's left unset, production emits `http://localhost:3001` URLs |
| `NEXT_PUBLIC_STELLAR_NETWORK` | `testnet` / `futurenet` / `mainnet` — must match the backend's `STELLAR_NETWORK` and whatever network the user's Freighter wallet is set to, or signed transactions will be rejected |
| `NEXT_PUBLIC_STELLAR_NETWORK_PASSPHRASE` | The matching network passphrase (e.g. `"Test SDF Network ; September 2015"` for testnet), used when building/verifying transactions client-side |
| `NEXT_PUBLIC_TICKETING_CONTRACT_ID` | *Optional.* The deployed `ticketing` contract address (same as the backend's `TICKETING_CONTRACT_ID`). When set, published events link to the contract on stellar.expert (testnet/mainnet only) |
Expand Down
3 changes: 2 additions & 1 deletion docs/ENVIRONMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ See [`.env.example`](../.env.example):
| Variable | Purpose |
|---|---|
| `NEXT_PUBLIC_API_URL` | Backend base URL |
| `NEXT_PUBLIC_APP_URL` | Public origin this frontend is served from, used for canonical/OG URLs and `sitemap.xml`. **Must be the public origin in production** (e.g. `https://stellartickets.app`) — it falls back to `http://localhost:3001` when unset |
| `NEXT_PUBLIC_STELLAR_NETWORK` | Must match the backend's configured network |
| `NEXT_PUBLIC_STELLAR_NETWORK_PASSPHRASE` | Passed to Freighter when signing, must match the network above |

All three are `NEXT_PUBLIC_*` because they're read client-side (the
All of them are `NEXT_PUBLIC_*` because they're read client-side (the
API base URL for `fetch`, the network passphrase for wallet signing)
— none of them are secret.