Naar de inhoud

Het bestand switchboard.toml

Hoe Switchboard je website bouwt en start, en welke instellingen er in switchboard.toml staan.

In de hoofdmap van elke website staat een bestand switchboard.toml. Daarin staat hoe Switchboard je website moet bouwen en starten. Het sjabloon zet het goed voor je klaar; meestal hoef je er nooit naar om te kijken. Deze pagina is voor de nieuwsgierigen en voor je AI.

#Voorbeeld

Een website met een aparte backend:

switchboard.toml
stack = "sveltekit-fastapi"

[frontend]
dir = "frontend"
install = "npm ci"
build = "npm run build"
start = "node build"
port = 3000

[backend]
dir = "backend"
install = "uv sync --frozen --no-dev"
start = "uv run --no-sync uvicorn app.main:app --host 0.0.0.0 --port 8000"
release = "uv run --no-sync alembic upgrade head"
port = 8000
prefixes = ["/api"]

[health]
path = "/healthz"

Bij een website zonder aparte backend is er alleen een [frontend]-deel, met dir = ".".

#Alle velden

Veld Betekenis
stack Het sjabloon: sveltekit, nextjs, sveltekit-fastapi of nextjs-fastapi.
[frontend] De website zelf (bij één onderdeel: de hele website).
[backend] Alleen bij een aparte backend: het tweede programma.
dir In welke map dit onderdeel staat. "." is de hoofdmap.
install Opdracht om de benodigde onderdelen te installeren.
build Opdracht om de website te bouwen.
start Opdracht om de website te starten.
release (optioneel) Opdracht die vóór elke start draait, bijvoorbeeld om de database bij te werken.
port Op welk "huisnummer" het onderdeel luistert. Je website moet de variabele PORT gebruiken.
prefixes Bij een backend: welke adressen naar de backend gaan, zoals ["/api"].
[health] path Een adres dat binnen 60 seconden na het starten "OK" moet antwoorden. Zo weten we dat je website goed is opgestart.

Ontbreekt het bestand of een veld, dan gebruiken we de standaard van je sjabloon. Onbekende velden worden overgeslagen, met een waarschuwing in het bouwlogboek.

#Goed om te weten

  • Je website draait in een afgeschermde omgeving. Alleen de map /data blijft bewaard tussen het opnieuw opstarten; daar staat bijvoorbeeld je database. Zie database en back-ups.
  • Instellingen zet je niet in dit bestand, maar in instellingen en geheimen.
  • Welke variabelen Switchboard zelf aan je website geeft, lees je bij platformvariabelen.

Had je hier iets aan?

Handleiding

Zoeken in de handleiding

Typ een woord of een vraag. Tip: druk op Ctrl K om dit venster overal te openen.