MLInvoicen asennus

Ladattavat tiedostot

Viimeisin julkaistu versio

MLInvoice 2.3.1 (22.11.2024)

Vanhemmat versiot

MLInvoice 2.1.2 (2.4.2023)

Kehitysversio

Viimeisin kehitysversio, joka saattaa sisältää keskeneräistä tai loppuun asti testaamatonta toiminnallisuutta, vaikka pyritäänkin pitämään toimintakuntoisena:
MLInvoice git dev.

Commit-historiasta löytyvät tiedot viimeisimmistä muutoksista. Tätä versiota ei suositella tuotantokäyttöön.
Huom! kehitysversio ei sisällä kaikkia riippuvuuksia. Niiden asentamiseksi tarvitaan Composer ja npm. Suorita seuraavat komennot MLInvoicen hakemistossa: 

  php [path to ]composer.phar install
  npm install --production
Jos haluat muokata scss- tai js-tiedostoja, suorita npm install ilman parametreja, niin voit käyttää esim. node_modules/.bin/grunt watch -komentoa.

Uusi asennus

MLInvoice tarvitsee toimiakseen www-palvelimen, joka tukee PHP-kieltä (versio 7.3.5 tai uudempi), ja MySQL- tai MariaDB-tietokannan. Nämä kaikki voi asentaa erillisen palvelimen lisäksi myös esim. kannettavalle tietokoneelle. Tähän löytyy ohjeita muualta:

Windows-ympäristössä voit käyttää kuvitettua ohjetta MLInvoicen ja XAMPP:n asentamiseksi.

Toki myös erilaiset web-hotellit, jotka tarjoavat PHP- ja MySQL-tuen, ovat toimivia vaihtoehtoja, mutta näissä on syytä pitää mielessä, että jos ei käytetä suojattua HTTPS-yhteyttä, on verkkoliikennettä mahdollista urkkia. Monissa palveluissa on käytettävissä phpMyAdmin-niminen MySQL-tietokantojen ylläpitotyökalu, jolla tietokannan luominen sujuu helposti.

PHP:ltä edellytetään MySQL-tukea ja mbstring-moduulia. Finvoice-tuki tarvitsee myös DOM/XML- ja XSL-moduulit. Vaadittava PHP-versio on vähintään 7.3.5.

Kun yllämainitut edellytykset on täytetty, varsinainen MLInvoicen asennus tapahtuu näin:

  1. Luo MySQL-tietokanta mlinvoice (tietokannan nimen voi tarvittaessa vaihtaa esim. lyhyemmäksi, mutta näissä ohjeissa oletetaan sen olevan mlinvoice). Aseta collationiksi utf8_swedish_ci.
  2. Luo MySQL-käyttäjä, jolla on riittävät oikeudet (ainakin SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, INDEX, DROP, EXECUTE, CREATE VIEW, EVENT, TRIGGER, LOCK TABLES) mlinvoice-tietokannan käyttöön.
  3. Pura MLInvoicen asennuspaketti www-palvelimelle sopivaan paikkaan (tyypillisesti esim. htdocs-hakemistoon). Varmista, että tiedostojen käyttöoikeudet riittävät. Käyttöön riittää se, että web-palvelimella on lukuoikeus kaikkiin tiedostoihin, mutta automaattipäivitys edellyttää myös kirjoitusoikeutta.
  4. Avaa MLInvoice selaimella menemällä osoitteeseen, johon se on asennettu (ts. ylläoleva paketti on purettu).
  5. Anna avautuvaan asennuslomakkeeseen tarvittavat perustiedot.
  6. Avaa MLInvoice selaimeen ja kirjaudu sisään antamillasi tunnuksilla.
  7. Muokkaa asetukset sopiviksi kohdasta Asetukset -> Yleiset asetukset.
  8. Muokkaa tulostusmallit kohdasta Järjestelmä -> Tulostusmallit poista käytöstä / ota käyttöön tarpeen mukaan.
  9. PHP:n oletusmuistirajat eivät välttämättä riitä PDF:n luontiin. Jos se keskeytyy virheeseen, kasvata PHP:n memory_limit -asetus esim. arvoon 32M (ks. http://php.net/manual/en/configuration.changes.php ja http://php.net/manual/en/ini.core.php#ini.memory-limit).
  10. Jos aiot käyttää Finvoice-laskutusta, varmista, että PHP:ssa on käytössä DOM/XML- ja XSL-moduulit.
  11. Sähköpostin lähettämiseksi voi olla tarpeen muokata lähetysasetuksia config.php-tiedostossa.

Huom! MLInvoice ei välttämättä toimi oikein, jos PHP:n magic quotes -toiminto on päällä, vaikka mahdolliset ongelmat onkin pyritty kiertämään. Katso ohjeet toiminnon poistamiseksi.

Muista huolehtia MLInvoicen tietokannan varmuuskopioinnista. MLInvoice sisältää varmuuskopiointitoiminnon, joka luo tietokannan sisällöstä SQL-skriptin (skripti on samankaltainen kuin phpMyAdmin-ohjelman tietokannan vientitoiminnon tuottama). Skriptin suorittamalla sisältö voidaan palauttaa tyhjään tietokantaan. Kannattaa varmistua aika ajoin siitä, että varmuuskopio toimii, eli kokeilla, miltä tilanne näyttää, jos varmuuskopiosta luo uuden tietokannan.

Ongelmien selvitys

Jos jostain syystä käy niin, että MLInvoice ei toimi, vaan valittelee jostain tai näyttää tyhjää ruutua, niin web-palvelimen ja PHP:n lokeista voi löytyä osviittaa siihen, mikä on pielessä.

Päivitys automaattisesti (versiosta 1.17.0 lähtien)

Versiosta 1.17.0 MLInvoice tukee automaattista päivitystä. Ks. Järjestelmä-valikko. Jos automaattista päivitystä ei voida käyttää, allaolevat ohjeet toimivat edelleen.

Päivitys käsin

  1. Kirjaudu ulos MLInvoicesta.
  2. Korvaa vanhan version tiedostot uusilla, mutta säilytä olemassaoleva config.php-tiedosto..
    Tietokanta päivitetään tarvittaessa automaattisesti ennen kirjautumisruudun näyttämistä, ja siitä tulee ilmoitus kirjautumisruudulle. Jos tietokannan päivitys epäonnistuu esim. riittämättömien käyttöoikeuksien takia, kirjoitetaan tarvittavat päivitystoimenpiteet PHP:n virhelokiin. Huomaa, että kirjautumisruutua voi joutua odottamaan hetken aikaa ensimmäisellä kerralla päivityksen jälkeen riippuen siitä, miten paljon tietokantapäivityksiä on tehtävänä.
  3. Varmista, että MySQL-käyttäjällä on LOCK TABLES -käyttöoikeus.
  4. Jos käyttöliittymä toimii oudosti päivityksen jälkeen, tyhjennä selaimen välimuisti.