Apache-www-palvelin

ITKP1011 Web-julkaiseminen · korjattu laitos

Tällä luennolla käsitellään oleellisimpia Apache HTTP Server -palvelinohjelmiston ominaisuuksia. Apache on yksi maailman käytetyimmistä www-palvelimista ja erityisen yleinen jaetussa palvelintilassa, koska se on ainoa suurista palvelimista, joka tukee .htaccess- tiedostoja. Sellaista käytetään myös JYU:n kotisivupalvelimella.

Suuri osa www-sivuston tarvitsemasta toiminnallisuudesta kannattaa toteuttaa jo palvelimella, koska siellä se toimii varmasti riippumatta käyttäjän selaimesta.

1. .htaccess

.htaccess on hakemistokohtainen asetustiedosto, jolla voi muuttaa palvelimen toimintaa ilman pääsyä palvelimen omaan konfiguraatioon. Sillä voi toteuttaa muun muassa salasanasuojauksen, uudelleenohjauksen ja mediatyyppien lisäykset.

• Tiedosto sijoitetaan siihen hakemistoon, jota halutaan muuttaa. Omalla kotisivutilalla se on tavallisesti www-kansio.
• Asetukset vaikuttavat kyseiseen hakemistoon ja kaikkiin sen alihakemistoihin tiedostoineen. Alihakemistoon voi laittaa oman tiedostonsa, joka ohittaa ylemmän.
• Yksi määritys kirjoitetaan yhdelle riville. Direktiivin ja sen parametrien väliin tulee välilyönti.
• Risuaidalla # alkava rivi on kommentti.

2. Uudelleenohjaus

Uudelleenohjaus tehdään HTTP:n omilla vastauskoodeilla ja Location-otsikkotiedolla. Apachessa on tätä varten valmiit direktiivit.

2.1 Väliaikainen ohjaus (302)

Redirect /vanha/index.html https://appro.mit.jyu.fi/uusi/

Ohjattavan sivun osoite kerrotaan palvelimen juuresta lukien, ja kohdeosoite kirjoitetaan kokonaisuudessaan protokollaa myöten.

2.2 Pysyvä ohjaus (301)

Redirect permanent /vanha/index.html https://appro.mit.jyu.fi/uusi/

Pysyvä ohjaus tehdään lisäämällä avainsana permanent. Hakukoneet siirtävät silloin vanhan osoitteen sijoituksen uudelle osoitteelle.

2.3 Useamman tiedoston ohjaus

Kun samaan kohteeseen halutaan ohjata useampi tiedosto, käytetään RedirectMatch-direktiiviä. Säännöllinen lauseke kirjoitetaan lähdepolkuun, ei kohteeseen.

RedirectMatch permanent ^/doc/tietokone/pc.*  https://appro.mit.jyu.fi/doc/tietokone/
RedirectMatch permanent ^/doc/kayttojarjestelma/win.*  https://appro.mit.jyu.fi/doc/kayttojarjestelma/

Merkki ^ kiinnittää kuvion polun alkuun. Muista, että piste on säännöllisessä lausekkeessa erikoismerkki, joka vastaa mitä tahansa merkkiä. Jos haluat tarkoittaa oikeaa pistettä, kirjoita se muodossa \.. Säännöllisiä lausekkeita käsitellään komentoriviluennolla.

Lähteen osia voi käyttää kohteessa sulkeilla ja viittauksilla $1, $2 ja niin edelleen:

RedirectMatch permanent ^/vanha/(.*)$  https://appro.mit.jyu.fi/uusi/$1

Lisätietoa: mod_alias.

3. Käytettävä merkistö

Palvelin voi kertoa vastauksen mukana, mitä merkistöä tiedostossa käytetään. Tällä on merkitystä, koska HTTP-otsikossa ilmoitettu merkistö voittaa aina dokumentin oman meta charset -määrityksen. Jos palvelin ilmoittaa väärän merkistön, ääkköset näkyvät väärin, vaikka tiedosto olisi oikein tallennettu ja meta-rivi paikallaan.

Yksittäisten tiedostopäätteiden merkistön voi asettaa näin:

AddCharset utf-8 .html .css .js .txt

4. Mediatyypit

Mediatyyppi eli MIME-tyyppi kertoo selaimelle, millainen tiedosto on kyseessä ja miten se pitäisi käsitellä. Selain ei päättele tyyppiä tiedostopäätteestä vaan luottaa siihen, minkä palvelin ilmoittaa. Väärä tai puuttuva mediatyyppi on tavallinen syy siihen, että selain tarjoaa tiedostoa ladattavaksi sen sijaan että näyttäisi sen, tai ettei video toistu.

Tyyppi asetetaan AddType-direktiivillä:

# Määrätään .html-päätteisten tiedostojen mediatyypiksi text/plain,
# jolloin selain näyttää koodin sellaisenaan eikä tulkitse sitä
AddType text/plain .html

# ja päinvastoin
AddType text/html .txt

4.1 Usein tarvittavia mediatyyppejä

Apachen mukana tulee valmis luettelo tavallisimmista tyypeistä, joten useimmiten mitään ei tarvitse lisätä. Uudempi formaatti voi silti puuttua vanhemmasta asennuksesta.

AddType image/webp .webp
AddType image/avif .avif
AddType image/svg+xml .svg
AddType video/mp4 .mp4
AddType video/webm .webm
AddType audio/mpeg .mp3
AddType audio/ogg .ogg .opus
AddType application/pdf .pdf
AddType application/xml .xml
AddType application/xhtml+xml .xhtml
AddType text/vtt .vtt

Lisätietoa: mod_mime: AddType ja MIME types (MDN). Mediatyyppien käyttöä kuvien ja videoiden kanssa käsitellään multimedialuennolla.

5. Hakemiston indeksitiedosto

Selaimella voidaan pyytää hakemistoa ilman tiedostonimeä, esimerkiksi https://users.jyu.fi/~tunnus/harkka/. Palvelin etsii silloin hakemistosta oletustiedoston, joka on tavallisesti index.html.

Oletustiedoston voi vaihtaa DirectoryIndex-direktiivillä:

DirectoryIndex index.shtml index.html

Vaihtoehtoja voi luetella useita. Palvelin tarjoaa ensimmäisen, joka hakemistosta löytyy. Esimerkissä tarjotaan ensin index.shtml-tiedostoa ja sen puuttuessa index.html-tiedostoa. Tätä tarvitaan, jos sivuilla käytetään SSI-komentoja.

5.1 Hakemistolistaus

Jos hakemistosta ei löydy yhtään DirectoryIndex-tiedostoa, palvelin voi luoda automaattisesti sivun, joka listaa hakemiston tiedostot. JYU:n kotisivupalvelimella automaattinen listaus on oletuksena pois päältä, jolloin selain saa virheen 403 (Forbidden).

Listauksen saa halutessaan käyttöön hakemistokohtaisesti:

Options +Indexes

Listausta voi myös siistiä. IndexIgnore jättää tiedostoja pois näkyvistä ja IndexOptions säätää esitystapaa:

Options +Indexes
IndexOptions FancyIndexing HTMLTable NameWidth=*
IndexIgnore .htaccess *.bak *~

Vastaavasti listauksen saa pois päältä merkinnällä Options -Indexes, jos se on jossain hakemistossa päällä.

Lisätietoa: mod_dir ja mod_autoindex.

6. Salasanasuojaus

Hakemiston voi suojata salasanalla .htaccess-tiedostolla. Tarvitaan kaksi tiedostoa: asetukset ja käyttäjätunnusten tiedosto.

Luo ensin salasanatiedosto komentoriviltä. Valitsin -c luo uuden tiedoston, ja se pyyhkii olemassa olevan, joten seuraavia käyttäjiä lisättäessä se jätetään pois:

htpasswd -c ~/.htpasswd matti     # luo tiedoston ja ensimmäisen käyttäjän
htpasswd ~/.htpasswd maija       # lisää käyttäjän olemassa olevaan

Kirjoita sitten suojattavan hakemiston .htaccess-tiedostoon:

AuthType Basic
AuthName "Suojattu alue"
AuthUserFile /home/omatunnus/.htpasswd
Require valid-user

Katso myös pääteohjaustehtävän ohje, digipalvelujen ohje ja Authentication and Authorization.

7. Automaattinen kielivalinta

Apache osaa tarjota saman sivun eri kielisinä versioina sen mukaan, mitä kieliä käyttäjän selain ilmoittaa haluavansa. Ominaisuutta kutsutaan nimellä content negotiation.

Yksinkertaisimmillaan tiedostot nimetään kielikoodin mukaan (index.fi.html, index.en.html), ja palvelin valitsee sopivan, kun selain pyytää osoitetta index.html. Tarkemman hallinnan saa .var-tiedostoilla eli typemapeilla, joissa kerrotaan jokaisen version osoite, kieli ja mediatyyppi.

Ominaisuutta tarvitaan harvoin, ja nykyään monikielisyys hoidetaan yleensä erillisillä osoitteilla, esimerkiksi /fi/ ja /en/, koska silloin käyttäjä näkee osoitteesta millä kielellä sivu on ja voi jakaa linkin halutulla kielellä. Jos haluat perehtyä asiaan, Apachen oma ohje kertoo kaiken tarvittavan:

• Content Negotiation
• mod_negotiation

8. Toistuvien osien liittäminen

Sivustolla on yleensä osia, jotka toistuvat joka sivulla: navigointi, otsake, tekijätiedot. Jos ne kirjoitetaan jokaiseen tiedostoon erikseen, yhden linkin lisääminen vaatii kaikkien sivujen muokkaamista. Ratkaisu on kirjoittaa toistuva osa yhteen tiedostoon ja liittää se muihin.

8.1 SSI (Server Side Includes)

SSI-komennot ovat HTML-dokumenttiin kirjoitettuja käskyjä, jotka palvelin suorittaa ennen kuin lähettää sivun selaimelle. Selain ei siis koskaan näe komentoja vaan valmiin lopputuloksen.

Komento kirjoitetaan HTML-kommentin näköisenä, mutta risuaidalla heti aloitusmerkinnän jälkeen:

<!--#komento parametri="arvo" -->

DirectoryIndex index.shtml index.html

8.2 Tavallisimmat SSI-komennot

Toisen tiedoston sisällön liittäminen. Tämä on SSI:n tärkein käyttötapa. Käytä aina virtual-parametria, joka tulkitsee polun www-osoitteena, älä file-parametria.

<!--#include virtual="navigointi.ssi" -->
<!--#include virtual="/~omatunnus/yhteiset/alatunniste.ssi" -->

Liitettävä tiedosto sisältää pelkän katkelman HTML-koodia, ei kokonaista dokumenttia. Esimerkiksi navigointi.ssi:

<nav>
  <ul>
    <li><a href="/~omatunnus/">Etusivu</a></li>
    <li><a href="/~omatunnus/harkka/">Harjoitustyö</a></li>
  </ul>
</nav>

Muuttujan asettaminen ja tulostaminen. Näin saman tiedon voi kirjoittaa kerran ja käyttää monessa kohdassa sivua.

<!--#set var="otsikko" value="Nanonano" -->

<title><!--#echo var="otsikko" --></title>
...
<h1><!--#echo var="otsikko" --></h1>

<!-- väärin: lainausmerkit menevät sisäkkäin -->
<link rel="stylesheet" href="<!--#echo var="css" -->" />

<!-- oikein -->
<link rel="stylesheet" href="<!--#echo var='css' -->" />

Muutosajankohdan tulostaminen. Palvelin lukee ajan tiedoston tiedoista, joten se pysyy oikeana ilman käsityötä.

<!--#config timefmt="%Y-%m-%d %H:%M" -->
<p>Päivitetty <!--#echo var="LAST_MODIFIED" --></p>

8.3 Kokonainen esimerkki

Tiedosto index.shtml:

<!DOCTYPE html>
<!--#set var="otsikko" value="Nanonano" -->
<html xmlns="http://www.w3.org/1999/xhtml" lang="fi" xml:lang="fi">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title><!--#echo var="otsikko" --></title>
    <link rel="stylesheet" href="/~omatunnus/tyyli.css" />
  </head>
  <body>

    <!--#include virtual="/~omatunnus/yhteiset/navigointi.ssi" -->

    <main>
      <h1><!--#echo var="otsikko" --></h1>
      <p>Sivun sisältö tähän.</p>
    </main>

    <!--#include virtual="/~omatunnus/yhteiset/alatunniste.ssi" -->

  </body>
</html>

Tiedosto yhteiset/alatunniste.ssi:

<footer>
  <p>Päivitetty <!--#config timefmt="%Y-%m-%d" --><!--#echo var="LAST_MODIFIED" --></p>
  <address><a href="mailto:nobody@example.invalid">Nanonano</a></address>
</footer>

Lisätietoa: mod_include ja Introduction to Server Side Includes.

9. Lisätietoa

• Apache HTTP Server 2.4 Documentation.
• Apache HTTP Server Tutorial: .htaccess files.
• Direktiivien pikahakemisto.
• Rekisteröidyt mediatyypit (IANA).
• Mediatyypit (Jukka Korpela).
• RFC 9110: HTTP Semantics. Tämä korvasi vanhan RFC 2616:n, johon monet ohjeet yhä viittaavat.