Siirry pääsisältöön

Lokaalin ympäristön asetukset

Opi konfiguroimaan Seravo-projektin paikallinen kehitysympäristö config.yml-tiedoston avulla. Hallitse verkkotunnuksia, SSH-yhteystietoja, automaattista synkronointia ja WordPress Multisite -asetuksia.

Projektihakemiston juuresta löytyvää config.yml-tiedostoa käytetään paikallisen Docker-kehitysympäristön määrittämiseen. Kun lataat olemassa olevan sivuston projektipohjan Seravolta, sen mukana tulee yleensä valmiiksi esitäytetty config.yml-tiedosto.

Jos aloitat kehityksen tyhjällä Seravo/wordpress-projektipohjalla, ensimmäinen käynnistys luo oletusarvoisen config.yml-tiedoston automaattisesti config-sample.yml-mallitiedoston pohjalta. Koska config.yml ei sisällä salasanoja, se on turvallista pitää mukana Git-versionhallinnassa, jolloin koko kehitystiimi jakaa samat ympäristöasetukset.

Esivaatimukset

Ennen asetusten muokkaamista varmista, että sinulla on:

  • Asennettu paikallinen Docker-kehitysympäristö: Docker ja Docker Compose (sekä halutessasi seravo-docker-aputyökalu) on asennettu työasemallesi.

  • Kloonattu projektihakemisto: Sivuston tiedostot on ladattu koneellesi ja projektin juuresta löytyy config-sample.yml-mallitiedosto.

  • Tuotantoympäristön SSH-tiedot (valinnainen): Jos haluat hakea tietokannan, lisäosat tai teemat suoraan tuotannosta (wp-pull-production-*), tarvitset sivuston SSH-osoitteen, portin ja SSH-avaimen.

Oletusarvoinen ja mukautettu config.yml

Tyhjän projektin oletusarvoinen config.yml on hyvin pelkistetty:

name: wordpress
development:
domains:
- wordpress.local

Täydellisempi config.yml, jossa on määritetty myös tuotanto- ja staging-ympäristön SSH-yhteystiedot, useita paikallisia verkkotunnuksia sekä automaattisen synkronoinnin asetukset, näyttää tältä:

name: mywpsite

production:
domain: example.seravo.com
ssh_port: 12345

staging:
domain: example.seravo.com
ssh_port: 23456

development:
domains:
- mywpsite.local
- another.local
- third.mywpsite.local
pull_production_db: never
pull_production_plugins: never
pull_production_themes: never

Asetusten muokkaaminen ja käyttöönotto

Kun muokkaat config.yml-tiedostoa, muutokset tulevat voimaan käynnistämällä kehitysympäristö uudelleen työasemasi projektihakemistossa:

seravo-docker up

Jos muutat kontin nimeä (name) tai paikallisia verkkotunnuksia (development.domains), luo kontit uudelleen, jotta verkkoreititys päivittyy varmasti:

seravo-docker down && seravo-docker up

config.yml-tiedoston asetukset

Alla olevassa taulukossa on kuvattu kaikki config.yml-tiedostossa tuetut pääasetukset:

Asetus

Oletusarvo

Kuvaus

name

wordpress

Sivuston sisäinen tunniste, jota käytetään Docker-konttien ja -verkkojen nimeämisessä sekä SSH-käyttäjätunnuksena (esim. wp-pull-production-db-komennossa).

production.domain

–

Tuotantoympäristön palvelinosoite, josta tiedot noudetaan paikalliseen ympäristöön.

production.ssh_port

–

Tuotantoympäristön yksilöllinen SSH-portti.

staging.domain

–

Staging-ympäristön (varjosivuston) palvelinosoite.

staging.ssh_port

–

Staging-ympäristön yksilöllinen SSH-portti.

development.domains

wordpress.local

Lista paikallisista verkkotunnuksista, jotka reititetään paikalliseen nginx-konttiin.

development.pull_production_db

never

Määrittää, haetaanko tietokanta tuotannosta automaattisesti kontin käynnistyessä (always tai never).

development.pull_production_plugins

never

Määrittää, haetaanko lisäosat tuotannosta automaattisesti kontin käynnistyessä (always tai never).

development.pull_production_themes

never

Määrittää, haetaanko teemat tuotannosta automaattisesti kontin käynnistyessä (always tai never).

Huom: Suurilla sivustoilla pull_production_db: always voi hidastaa kontin käynnistymistä huomattavasti ja ylikirjoittaa paikallisesti tekemäsi tietokantamuutokset. Yleensä on suositeltavampaa pitää arvona never ja ajaa wp-pull-production-db manuaalisesti tarpeen mukaan.

WordPress Multisite lokaalissa kehityksessä

WordPress Multisite -verkkoasennukset vaativat muutaman lisämäärityksen toimiakseen sujuvasti paikallisessa Docker-ympäristössä.

DOMAIN_CURRENT_SITE-vakion määritys

Tuotantosivustolla wp-config.php sisältää usein kovakoodatun pääverkkotunnuksen DOMAIN_CURRENT_SITE-vakiossa. Lokaalissa kehityksessä vakion tulee osoittaa paikalliseen verkkotunnukseen. Toteuta tämä dynaamisesti WP_ENV-ympäristömuuttujan avulla:

if ( 'development' === getenv( 'WP_ENV' ) ) {
define( 'DOMAIN_CURRENT_SITE', 'mywpsite.local' );
} else {
define( 'DOMAIN_CURRENT_SITE', 'example.com' );
}

Aliverkkotunnukset (Subdomain Multisite)

Jos käytät aliverkkotunnuksiin perustuvaa Multisite-verkkoa, lisää kaikki aliverkkotunnukset config.yml-tiedoston development.domains-listaan ennen kontin käynnistämistä:

development:
domains:
- mywpsite.local
- site1.mywpsite.local
- site2.mywpsite.local

Kun ajat kontin sisällä komennon wp-pull-production-db, työkalu tunnistaa aliverkkotunnusrakenteen ja muuntaa tuotannon aliverkkotunnukset automaattisesti vastaavaan .local-muotoon (esim. site1.example.com → site1.mywpsite.local).

Huom: Jos verkostossa on käytössä kokonaan erillisiä verkkotunnuksia (mapped domains, kuten erillinen-sivusto.fi), niitä ei muunneta automaattisesti. Lisää ne myös development.domains-listaan (esim. erillinen-sivusto.local) ja aja osoitteiden korvaus manuaalisesti komennolla wp search-replace 'https://erillinen-sivusto.fi' 'http://erillinen-sivusto.local' --network.

Yleisimmät virhetilanteet

  • seravo-docker up epäonnistuu YAML-jäsennysvirheeseen: YAML-tiedostot ovat tarkkoja sisennyksistä. Varmista, että käytät sisennysmerkkinä aina välilyöntejä (ei sarkaimia) ja että listan --merkit on sisennetty oikein domains:-avaimen alle.

  • Uusi development.domains-listaan lisätty osoite ei avaudu selaimessa: Pelkkä config.yml-tiedoston tallennus ei päivitä käynnissä olevan kontin verkkoreititystä. Aja projektihakemistossa seravo-docker down && seravo-docker up ja varmista, että paikallinen nimipalvelu (dnsmasq) tai hosts-tiedosto ohjaa uuden .local-osoitteen osoitteeseen 127.0.0.1.

  • wp-pull-production-*-komennot eivät saa yhteyttä tuotantopalvelimeen: Tarkista, että config.yml-tiedoston name-kenttä vastaa sivuston SSH-käyttäjätunnusta ja että production.domain sekä production.ssh_port vastaavat sivustosi tuotantotietoja.

  • Paikalliset tietokantamuutokset katoavat kontin uudelleenkäynnistyksen yhteydessä: Tarkista config.yml-tiedostosta, ettei pull_production_db-asetuksen arvoksi ole määritetty always.

Katso myös

Selkeästi määritelty config.yml pitää tiimin paikalliset kehitysympäristöt yhtenäisinä ja helpottaa tietojen synkronointia tuotannon kanssa. Mikäli tarvitset apua ympäristön asetusten määrittämisessä tai Multisite-kehityksessä, asiakaspalvelumme auttaa osoitteessa [email protected].

Vastasiko tämä kysymykseesi?