Silverstripe CMS:n asentaminen – opas aloittelijalle

Tiivistelmä

Silverstripe CMS:n asentaminen tutustuttaa samalla muutamaan verkkokehityksen perusasiaan. Julkaisujärjestelmä tarvitsee PHP-ympäristön, tietokannan ja oikein määritetyn verkkopalvelimen. Ohjelmiston tiedostot ja…

Ensimmäinen asennus kannattaa tehdä erilliseen harjoitusympäristöön. Silloin voit opetella asetuksia, tutkia hallintapaneelia ja kokeilla muutoksia ilman, että keskeneräinen työ vaikuttaa käytössä olevaan sivustoon.

Tämä opas käsittelee Silverstripe CMS 6 -sarjan asentamista ympäristöön, jossa verkkopalvelin, PHP ja tietokantapalvelu ovat jo käytettävissä. Komennot suoritetaan kyseisessä ympäristössä: paikallisella koneella sen päätteessä tai palvelimella SSH-yhteyden kautta.

Mitä tarvitset ennen asentamista?

Tarkista ympäristön yhteensopivuus ennen tiedostojen lataamista. Silverstripen version 6 dokumentaatio ilmoittaa tällä hetkellä tuetuiksi PHP-versioiksi 8.3–8.5 ja edellyttää Composer 2:ta. Tavallinen tietokantavalinta on MySQL tai MariaDB.

PHP tarvitsee myös laajennuksia, kuten intl ja mbstring, tietokantayhteyden mahdollistavan ajurin sekä kuvankäsittelyyn GD:n tai Imagickin. Tarkka luettelo löytyy Silverstripen palvelinvaatimuksista.

Varmista ennen aloittamista, että sinulla on:

Pääsy komentoriville.
Oikeus luoda projektikansio.
Toimiva Composer-asennus.
Oma tietokanta ja sen käyttäjätunnus.
Mahdollisuus määrittää sivuston julkinen juurihakemisto.

Webhotellissa viimeinen kohta kannattaa tarkistaa palveluntarjoajalta. Kaikki hosting-paketit eivät tarjoa samanlaisia mahdollisuuksia verkkopalvelimen asetusten muuttamiseen.

Tarkista PHP ja Composer

Avaa pääte ja tarkista käytettävät versiot:

php -v
composer --version

Ensimmäinen komento näyttää komentorivin käyttämän PHP-version. Toinen kertoo, löytyykö Composer ja mikä versio siitä on asennettu.

Huomaa, että komentorivin PHP voi olla eri versio kuin verkkopalvelimen käyttämä PHP. Esimerkiksi hosting-palvelun hallintapaneelissa tehty PHP-valinta ei välttämättä muuta SSH-yhteyden oletusta.

Jos Composer puuttuu, asenna se Composerin virallisen ohjeen mukaan tai pyydä palveluntarjoajalta käyttöohje. Tarkista samalla, millä PHP-komennolla sitä kuuluu kyseisessä ympäristössä suorittaa.

Älä ohita yhteensopivuusvirheitä väkisin. Puuttuva PHP-laajennus kannattaa ottaa käyttöön ennen varsinaisen asennuksen jatkamista.

Luo projekti Composerilla

Siirry kansioon, jonka alle haluat uuden projektin. Älä suorita asennusta olemassa olevan verkkosivuston päälle.

Luo Silverstripe 6 -projekti seuraavasti:

composer create-project silverstripe/installer oma-sivusto "^6"

Komennon osat tarkoittavat seuraavaa:

create-project luo uuden projektin.
silverstripe/installer määrittää käytettävän aloituspaketin.
oma-sivusto on uuden kansion nimi.
"^6" rajaa asennuksen version 6 sarjaan.

Composer lataa yhteensopivat riippuvuudet ja muodostaa projektin tiedostorakenteen. Asennuksen kesto riippuu verkkoyhteydestä ja ympäristöstä.

Kun komento on valmistunut onnistuneesti, siirry projektikansioon:

cd oma-sivusto

Silverstripen virallinen asennustapa perustuu Composeriin, jolla hallitaan myös projektin ohjelmistoriippuvuuksia. Silverstripen Composer-ohje.

Tutustu tärkeimpiin tiedostoihin

Projektikansion sisältö voi näyttää aluksi laajalta. Kaikkea ei tarvitse ymmärtää heti, mutta muutaman kohdan tunnistaminen helpottaa jatkoa.

Keskeisiä osia ovat:

app: projektin omaa sovelluskoodia ja asetuksia.
public: verkkopalvelimelle tarkoitettu julkinen hakemisto.
vendor: Composerin asentamat riippuvuudet.
composer.json: projektin riippuvuusmääritykset.
composer.lock: asennettavien riippuvuuksien tarkat versiot.

Älä tee omia korjauksia suoraan vendor-kansion ohjelmistopaketteihin. Composerin myöhempi asennus tai päivitys voi korvata muutokset.

Pidä myös projektin juurihakemisto ja julkinen hakemisto käsitteinä erillään. Kaikkien projektitiedostojen ei kuulu olla selaimella ladattavissa.

Hakemistorakenteeseen voi perehtyä tarkemmin Silverstripen rakenneohjeessa.

Luo oma tietokanta

Perusta harjoitussivustolle tyhjä tietokanta esimerkiksi hosting-palvelun hallintapaneelissa. Luo sille oma käyttäjä ja anna käyttäjälle tarvittavat oikeudet kyseiseen tietokantaan.

Kirjaa talteen:

Tietokantapalvelimen osoite.
Tietokannan nimi.
Käyttäjätunnus.
Salasana.

Hosting-palvelu voi lisätä tietokannan ja käyttäjän nimeen tilikohtaisen etuliitteen. Käytä asetuksissa koko nimeä täsmälleen sellaisena kuin hallintapaneeli sen näyttää.

Tietokantapalvelin ei myöskään ole aina localhost. Jos palveluntarjoaja ilmoittaa erillisen osoitteen, käytä sitä.

Tyhjän tietokannan käyttäminen helpottaa ongelmien selvittämistä ja pitää harjoituksen erillään muista sivustoista. Älä käytä olemassa olevan tuotantosivuston tietokantaa asennuksen kokeilemiseen.

Määritä ympäristöasetukset

Etsi projektin juuresta .env.example ja tee siitä kopio nimellä .env. Voit käyttää tiedostonhallintaa tai macOS- ja Linux-ympäristöissä komentoa:

cp .env.example .env

Avaa .env tekstieditorissa ja täydennä asetukset. Seuraavan esimerkin tunnukset ovat paikkamerkkejä, jotka täytyy vaihtaa:

SS_DATABASE_CLASS="MySQLDatabase"
SS_DATABASE_SERVER="localhost"
SS_DATABASE_NAME="OMA_TIETOKANTA"
SS_DATABASE_USERNAME="OMA_TIETOKANTAKAYTTAJA"
SS_DATABASE_PASSWORD="VAIHDA_TIETOKANNAN_SALASANA"

SS_DEFAULT_ADMIN_USERNAME="OMA_YLLAPITAJAN_TUNNUS"
SS_DEFAULT_ADMIN_PASSWORD="VAIHDA_PITKA_YKSILOLLINEN_SALASANA"

SS_ENVIRONMENT_TYPE="dev"

Tietokannan salasana ja ylläpitäjän salasana ovat eri asioita. Käytä niissä eri arvoja.

Sijoita .env projektin juureen, ei public-kansioon. Älä myöskään tallenna oikeita tunnuksia julkiseen versionhallintaan.

Kehitystilaa tarkoittava dev sopii omaan harjoitusympäristöön. Julkisella tuotantosivustolla käytetään live-tilaa, joka rajoittaa kehitystietojen näyttämistä. Silverstripen ympäristöasetukset.

Ohjaa verkkopalvelin public-kansioon

Verkkopalvelimen dokumenttijuureksi määritetään projektin public-hakemisto.

Jos projekti sijaitsee esimerkiksi palvelimen polussa /var/www/oma-sivusto, dokumenttijuuri on:

/var/www/oma-sivusto/public

Tämä on esimerkkipolku. Oman palvelimesi hakemistorakenne voi olla erilainen.

Määritystapa riippuu ympäristöstä. Hallintapaneelissa asetus voi olla verkkotunnuksen dokumenttijuuri, kun taas omalla palvelimella muutos tehdään Apache- tai Nginx-asetuksiin.

Varmista myös osoitteiden uudelleenkirjoituksen toiminta. Nginx ei käytä Apachen .htaccess-tiedostoja, joten Apachelle tarkoitetut asetukset eivät siirry siihen automaattisesti.

Silverstripen palvelinvaatimukset käsittelevät sekä julkisen hakemiston että tiedostosuojauksen asetukset. Verkkopalvelimen määritykset.

Rakenna tietokannan taulut

Kun riippuvuudet ja ympäristöasetukset ovat kunnossa, suorita projektin juurihakemistossa:

vendor/bin/sake db:build

Komento käynnistää Silverstripen tietokantarakenteen luonnin ja päivityksen. Version 6 ohjeissa käytetään tätä komentomuotoa, joten vanhojen opetusvideoiden komennot voivat poiketa siitä.

Seuraa tulostetta loppuun asti. Jos suoritus epäonnistuu, korjaa ilmoitettu ongelma ennen seuraavaan vaiheeseen siirtymistä.

Tavallisia syitä ovat väärä salasana, virheellinen tietokannan nimi tai puuttuvat tietokantaoikeudet. Myös komennon suorittaminen väärästä kansiosta voi estää käynnistymisen.

Sake on Silverstripen komentorivityökalu, jolla suoritetaan järjestelmän toimintoja. Saken dokumentaatio.

Kirjaudu hallintapaneeliin

Avaa selaimessa sivustolle määrittämäsi osoite. Hallintapaneeli löytyy lisäämällä osoitteen loppuun /admin.

Kirjaudu ympäristöasetuksiin määrittelemilläsi ylläpitäjän tunnuksilla. Sivuston avaaminen ja hallintaan kirjautuminen kuuluvat virallisen asennusohjeen viimeisiin vaiheisiin. Silverstripen käyttöönotto-ohje.

Jos kirjautumisnäkymä ei avaudu, tarkista ensin sivuston osoite ja verkkopalvelimen dokumenttijuuri. Jos etusivu toimii mutta /admin antaa 404-virheen, osoitteiden uudelleenkirjoitus on yksi tarkistettava kohta.

Kun pääset hallintaan, tutustu rauhassa sivupuuhun, tiedostoihin ja käyttäjäasetuksiin. Ensimmäisen kokeilun tarkoitus on varmistaa perustoiminta ennen lisäominaisuuksien asentamista.

Kokeile muutakin kuin kirjautumista

Toimiva kirjautuminen on hyvä alku, mutta asennus kannattaa tarkistaa myös tavallisilla sisältötehtävillä.

Tee seuraava harjoitus:

Luo uusi testisivu.
Lisää otsikko ja lyhyt tekstikappale.
Tallenna luonnos.
Avaa esikatselu.
Julkaise sivu.
Tarkista julkaistu näkymä.
Lataa pieni kuva ja kokeile sen lisäämistä sisältöön.

Kuvakokeilu auttaa havaitsemaan tallennus- ja kuvankäsittelyongelmia, jotka eivät näy pelkässä kirjautumisessa.

Tarkista sivu myös uloskirjautuneena. Näin näet, mitä tavallinen kävijä todella saa näkyviin.

Jos kaikki toimii, sinulla on käyttökelpoinen lähtökohta sisällönhallinnan harjoitteluun.

Selvitä virheet yksi kerrallaan

Virheilmoituksessa kannattaa aloittaa ensimmäisestä konkreettisesta syystä. Useat myöhemmät ilmoitukset voivat johtua samasta puuttuvasta asetuksesta.

Tyypillisiä tarkistuksia ovat:

Composer-virhe: PHP-versio ja laajennukset.
Tietokantavirhe: osoite, tunnukset ja käyttöoikeudet.
Puuttuvat sivut: dokumenttijuuri ja uudelleenkirjoitus.
Epäonnistuva kuvalataus: kirjoitusoikeudet ja kuvankäsittelylaajennus.
Tyhjä virhesivu: sovelluksen ja palvelimen lokit.

Älä yritä ratkaista käyttöoikeusongelmaa avaamalla kaikkia kansioita kaikille. Oikeudet määritetään palvelimen käyttäjien ja tarvittavien toimintojen perusteella.

Kirjaa toimivat asetukset ja tekemäsi korjaukset muistiin. Seuraava asennus helpottuu, kun tiedät, mitä juuri sinun ympäristössäsi tarvittiin.

Valmistaudu julkaisemiseen erikseen

Harjoitusasennuksen onnistuminen ei vielä tarkoita, että sivusto olisi valmis julkiseen käyttöön. Ennen julkaisua määritä HTTPS, vaihda ympäristö live-tilaan ja tarkista käyttäjätilit.

Järjestä varmuuskopiointi niin, että mukana ovat tietokanta, käyttäjien lataamat tiedostot ja palautukseen tarvittava projektin sisältö. Kokeile myös palauttamista.

Luo ylläpitoon nimetyt käyttäjätilit ja poista ympäristöön määritelty väliaikainen ylläpitäjätunnus käytöstä, kun korvaava kirjautuminen on varmistettu.

Pidä ensimmäinen toteutus yksinkertaisena. Kun asennus, julkaiseminen ja palauttaminen ovat hallinnassa, voit siirtyä omiin sivutyyppeihin, ulkoasuun ja tarpeellisiin moduuleihin.