Firefly III majutamine Managed VPS-is: teie rahaasjad teie enda serveris

Mida Firefly III teeb

Firefly III on isiklike rahaasjade haldur, mis on loodud ise majutamiseks. See jälgib teie kulusid ja tulusid eelarvete, kategooriate ja siltide abil, et näeksite, kuhu teie raha läheb. README kirjeldab seda täielikult ise majutatud ja isoleerituna: see ei võta ühendust ühegi välise serveriga enne, kui te seda selgesõnaliselt palute.

• Raamatupidamine: kahekordne kirjendamine, varakontod, kohustused ja mis tahes valuuta.
• Automatiseerimine: korduvad tehingud ja reeglid, mille kirjutate iga tehingu liigitamiseks.
• Jälgimine: eelarved, hoiupõrsad eesmärgi nimel säästmiseks, tulude ja kulude aruanded, graafikud.
• Turvalisus: kaksikautentimine igale kontole.
• Avatus: REST JSON API, mis katab peaaegu kogu rakenduse, lisaks veebikonksud.

Üks instants majutab nii palju kasutajaid, kui soovite, igaühel teistest täielikult eraldatud rahaline haldus. Dokumentatsioon kirjeldab ühe ühise halduse jagamise mudelit, mis on praegu arendamisel.

Mida AGPL-litsents lubab

Firefly III avaldatakse litsentsi GNU Affero General Public License, versioon 3 või teie valikul mis tahes hilisem versioon all: see on SPDX-identifikaator AGPL-3.0-or-later selle failis composer.json. Tekst kinnitab piiramatut luba muutmata programmi käitada. Seega võite projekti avaldatud tõmmist kasutada enda, oma pere või ettevõtte jaoks, ilma et peaksite litsentsi ostma.

Artikkel 13 lisab AGPL-ile omase tingimuse: kui te programmi muudate, peab teie versioon pakkuma kõigile, kes seda kaugelt, võrgu kaudu kasutavad, võimalust saada selle lähtekood tasuta. Data Importer on sama litsentsi all.

Paigaldus Docker Compose’iga

Dokumentatsioon nimetab Docker Compose’i Firefly III paigaldamise lihtsaimaks viisiks. Looge serveris, kuhu Docker on paigaldatud, kaust ja laadige sinna alla kolm ametlikku faili toorkujul: nende tühikud on olulised ja dokumentatsioon palub neid mitte brauserist kopeerida.

mkdir firefly-iii && cd firefly-iii
curl -o docker-compose.yml https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose.yml
curl -o .env https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example
curl -o .db.env https://raw.githubusercontent.com/firefly-iii/docker/main/database.env

• docker-compose.yml kirjeldab kolme teenust: app on rakendus, db MariaDB andmebaas ja cron ajastatud ülesanne.
• .env sisaldab Firefly III sätteid, sealhulgas krüpteerimisvõtit ja andmebaasi juurdepääsu.
• .db.env sisaldab andmebaasi sätteid. Säilitage mõlemad nimed: Compose’i fail viitab neile võtmega env_file.

Sätted, mida muuta enne esimest käivitamist

Looge failis .env antud käsuga kaks 32-märgilist stringi: üks võtme ja teine andmebaasi parooli jaoks.

head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 32 && echo

SITE_OWNER=you@example.com
APP_KEY=
DB_PASSWORD=
APP_URL=https://finances.example.com

MYSQL_PASSWORD=

• APP_KEY krüpteerib teie seansid. See on täpselt 32 märki pikk, ilma erimärkideta nagu =, #, < või >, ja fail palub seda väga hoolikalt hoida.
• DB_PASSWORD failis .env ja MYSQL_PASSWORD failis .db.env saavad sama väärtuse.
• SITE_OWNER: teie aadress, mida kuvatakse mõnes veateates kasutajatele, kes ei ole administraatorid.
• APP_URL: teie instantsi avalik aadress. Fail selgitab, et seda kasutatakse teatud päringute kontrollimiseks ja e-kirjades olevate linkide koostamiseks.
• TZ: teie ajavöönd tz-andmebaasi kujul, nagu failis olev näide näitab.

Valige andmebaasi parool enne esimest käivitamist. Andmebaas salvestab selle oma köitesse kohe loomisel: kui muudate seda hiljem, ei klapi see enam ja Dockeri KKK pakub ainult ühte väljapääsu, konteinerite ja köidete eemaldamist ning otsast alustamist.

Kohalikult avaldatud port

Ametlik fail avaldab rakenduse serveri kõigi aadresside pordil 80. Selle teenindamiseks HTTPS-iga samas masinas asuva pöördproksi taga muutke teenuses app ainult seda rida:

ports:
  - 127.0.0.1:8080:8080

docker compose -f docker-compose.yml up -d --pull=always
docker compose -f docker-compose.yml logs -f

Esimesel käivitamisel loob ja migreerib konteiner andmebaasi ise. Kui paigaldus on lõpetatud, tänab Firefly III teid logis paigaldamise eest: minge edasi pöördproksi juurde.

• Silt latest järgib viimast stabiilset väljalaset. Silt nagu version-6.7.9 fikseerib versiooni; projekt eemaldab vanad sildid umbes kuue kuu pärast.
• Arhitektuurid: tõmmised ehitatakse platvormidele linux/amd64 ja linux/arm64.
• Köited: firefly_iii_upload hoiab manuseid, firefly_iii_db andmebaasi.

Dokumentatsioon ei too välja mälu mahtu; selle Dockeri KKK soovitab PHP_MEMORY_LIMIT=512M või rohkem, kui PHP-l mälu otsa saab. Suurus sõltub kasutajate arvust, tehingute mahust ja andmete importijast. Managed VPS-is kirjeldage meile oma kasutust ja soovitame sobiva suuruse.

HTTPS ja pöördproksi

Firefly III teenindab rakendust konteineri sees HTTP kaudu pordil 8080 ja HTTPS asub selle ees oleval pöördproksil. Rakendus loeb päist X-Forwarded-Proto, et teada, et külastaja saabus HTTPS-i kaudu, tingimusel et see usaldab proksit:

TRUSTED_PROXIES=*

Dockeri KKK on selles punktis selge: ilma TRUSTED_PROXIES=*-ita jäävad lingid http-le, vormid ja graafikud lakkavad töötamast ning CSP turvapäised ei toimi. Kui port on avaldatud aadressil 127.0.0.1, jõuab rakenduseni ainult serveri enda proksi. Looge konteiner pärast iga faili .env muudatust uuesti:

docker compose up -d --force-recreate app

Caddy-ga

Caddy hangib Let’s Encrypti sertifikaadi ise ja selle direktiiv reverse_proxy seab vaikimisi päised X-Forwarded-For, X-Forwarded-Proto ja X-Forwarded-Host:

finances.example.com {
  reverse_proxy 127.0.0.1:8080
}

Nginxi ja Certbotiga

See plokk järgib paigaldus-KKK päiseid ja puhvreid, mida see soovitab 502-vigade vastu, kui rakendus tagastab märgi pikas päises. See kuulab pordil 80, et Certbot saaks HTTPS-i paigaldada:

server {
    listen 80;
    listen [::]:80;
    server_name finances.example.com;

    client_max_body_size 64M;
    proxy_buffer_size 128k;
    proxy_buffers 4 256k;
    proxy_busy_buffers_size 256k;

    location / {
        proxy_pass http://127.0.0.1:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-Server $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_read_timeout 300s;
    }
}

Certbot paigaldab seejärel sertifikaadi ja hoolitseb selle uuendamise eest:

sudo certbot --nginx

• Oma domeeninimi: teenindage Firefly III-t oma nime all, näiteks finances.example.com. KKK märgib, et Laravel ei parsi URL-is toorest IPv6-aadressi.
• 431-vead: KKK seostab need proksi liiga väikese päise mahu piiranguga, mis põhjustab mõne toimingu, näiteks sisselogimise, ebaõnnestumise.

Esimene konto ja registreerimine

Esimene registreeruja saab instantsi omanikuks. Turvameetmena suletakse registreerimine seejärel iseenesest: enamik inimesi paigaldab Firefly III ainult enda jaoks.

1. Avage oma HTTPS-aadress kohe, kui proksi vastab, ja looge oma konto: see saab omaniku rolli.
2. Lülitage oma profiilis sisse kaksikautentimine ja hoidke alles kaheksa varukoodi, mida see näitab.
3. Instantsi avamiseks teistele inimestele minge aadressile /settings, avage Firefly III konfiguratsioonivalikud, eemaldage linnuke registreerimise keelavalt valikult ja salvestage.

• Kaksikautentimine tugineb kellale: KKK ütleb, et ajaerinevus telefoni ja serveri vahel paneb selle ebaõnnestuma.
• Sisselogimine teie identiteedipakkuja kaudu: sättega AUTHENTICATION_GUARD=remote_user_guard usaldab Firefly III ette paigutatud autentimisproksit, näiteks Autheliat või Authentikut, mis edastab kasutaja päises.
• Juurdepääsumärgid: OAuth-kliendid ja isiklikud API-märgid luuakse profiilist.

Cron-ülesanne

Mitu funktsiooni töötab ainult ajastatud ülesandega: automaatsed eelarved, korduvad tehingud, tellimuste hoiatused ja ajakohased vahetuskursid. Dockeri tõmmis ei käivita croni ise; ametlik fail lisab selleks väikese teenuse cron, mis kutsub rakendust iga päev kell 3 öösel.

See autendib end staatilise märgiga. Looge sama käsuga kolmas string ja pange see faili .env:

STATIC_CRON_TOKEN=

See märk on täpselt 32 märki pikk: versiooni 6.7.9 kood ei aktsepteeri muud pikkust. Siin on teenus nii, nagu ametlik fail selle deklareerib; kahekordne $$ on tahtlik ja viitab faili .env ridadele TZ ja STATIC_CRON_TOKEN:

cron:
  image: alpine
  restart: always
  container_name: firefly_iii_cron
  env_file: .env
  init: true
  command: ["sh", "-c", "apk add tzdata && \
    (ln -s /usr/share/zoneinfo/$$TZ /etc/localtime || true) && \
    echo \"0 3 * * * wget -qO- http://app:8080/api/v1/cron/$$STATIC_CRON_TOKEN;echo\" \
    | crontab - && \
    exec crond -f -L /dev/stdout"]
  networks:
    - firefly_iii
  depends_on:
    - app

Ühest ülesandest piisab kõigile instantsi kasutajatele. Et kontrollida, kas see käivitus, lugege konteineri logi: iga ülesanne annab aru JSON-is, väljadega job_fired ja job_succeeded.

docker logs firefly_iii_cron

Käsitsi käivitamiseks palub Dockeri KKK kasutada kasutajat www-data, mitte root: KKK seostab selle lõksu logifailide õiguste vigadega:

docker exec --user www-data firefly_iii_core /usr/local/bin/php /var/www/html/artisan firefly-iii:cron --force

MariaDB, PostgreSQL või SQLite

Ametlik fail tuleb MariaDB-ga, tõmmisega mariadb:lts. Firefly III toetab ka PostgreSQL-i ja SQLite’i, mis valitakse failis .env muutujaga DB_CONNECTION:

DB_CONNECTION=pgsql
DB_HOST=db
DB_PORT=5432

PostgreSQL-i puhul suunab dokumentatsioon ka teenuse db tõmmisele postgres, mis paigaldab PostgreSQL 18, ja paigaldab selle köite kausta /var/lib/postgresql. Failis .db.env muutuvad muutujad MYSQL_* muutujateks POSTGRES_USER, POSTGRES_DB ja POSTGRES_PASSWORD.

Tehke see valik enne esimeste tehingute sisestamist. KKK ütleb, et ühelt andmebaasilt teisele üleminek jääb võimalikuks, ilma et Firefly III ise seda toetaks, ning et rakenduse eksport ei kanna kõiki andmeid.

Data Importer

Firefly III Data Importer on eraldi tööriist, oma paigalduse ja oma uuendustega; selle versioon 2.3.5 ilmus 23. septembril 2026. See impordib CSV- ja CAMT.053-faile ning oskab ka tehinguid teie pankadest kolmandate osapoolte andmepakkujate kaudu tuua, igaühel oma tingimused.

Ametlik Dockeri hoidla tarnib selle teises failis docker-compose-importer.yml, mis säilitab samad teenused ja lisab teenuse importer. Selle sätted lähevad faili .importer.env, mis võetakse importija failist .env.example. Teenindage seda oma domeeninime all, kohalikult avaldatud pordi ja teise proksiplokiga: KKK palub seda mitte alamkausta paigutada.

FIREFLY_III_URL=http://app:8080
VANITY_URL=https://finances.example.com
TRUSTED_PROXIES=*

• FIREFLY_III_URL: rakenduse sisemine aadress, milleni importija jõuab Dockeri võrgu kaudu.
• VANITY_URL: Firefly III avalik aadress, see, mida teie kasutajad teavad.
• OAuth-klient: looge oma Firefly III profiilis klient, mille tagasikutse-URL on importija aadress, millele järgneb /callback, ja eemaldage linnuke valikult «Confidential». Importija küsib seejärel selle kliendi ID-d.
• Mitu kasutajat: jätke FIREFLY_III_ACCESS_TOKEN tühjaks ja säilitage FIREFLY_III_URL; iga kasutaja logib siis importijasse sisse oma kontoga.

E-kirjad: SMTP seadistus

Vaikimisi kirjutab MAIL_MAILER=log sõnumid logidesse, selle asemel et neid saata. Teavituste, näiteks tellimuste hoiatuste saamiseks seadistage saatmine failis .env. Dokumentatsioon palub alati muuta MAIL_FROM ja SITE_OWNER, vastasel juhul ei lähe ükski e-kiri välja.

Simafri VPS-is läheb saatmine läbi autenditud SMTP-releesõlme pordis 587: selleks sobib teil juba olemasoleva e-postikonto aadress või Simafri Suite.

MAIL_MAILER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=587
MAIL_FROM=finances@example.com
MAIL_USERNAME=finances@example.com
MAIL_PASSWORD=account_password
MAIL_ENCRYPTION=tls

• MAIL_ENCRYPTION aktsepteerib väärtusi null, ssl, starttls või tls, sõltuvalt teie teenusepakkujast; versiooni 6.7.9 kood kasutab tühja väärtuse korral tls.
• Proov: leht /settings/notifications saadab testkirja, kui konteiner on uuesti loodud.
• Muud kanalid: teavitused võivad minna ka Slacki ning Discordi või Mattermosti nende veebikonksu URL-i kaudu, millele järgneb /slack.

Varukoopiad

Firefly III-l ei ole sisseehitatud varundusrutiini: dokumentatsioon soovitab süsteemi enda tööriistu ja märgib, et rakenduse ekspordifunktsioon ei ole varukoopia. Dockeriga tuleb hoida järgmist:

Andmebaas, teenus töötamas

MariaDB puhul ekspordib mariadb-dump andmebaasi teenust peatamata; selle valik --single-transaction annab InnoDB tabelitest järjepideva koopia neid lukustamata. Compose’i faili kaustast käivitatuna loeb käsk juurdepääsuandmed konteineri keskkonnast:

docker exec firefly_iii_db sh -c 'mariadb-dump --single-transaction -u"$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DATABASE"' > firefly-$(date +%F).sql

PostgreSQL-i puhul käib sama mõte läbi pg_dump-i:

docker exec firefly_iii_db sh -c 'pg_dump -U "$POSTGRES_USER" "$POSTGRES_DB"' > firefly-$(date +%F).sql

Ajastage see eksport serveris vähemalt kord päevas ja sorteerige failid, mis kuhjuvad.

Köited, teenus peatatud

Dokumentatsioon arhiveerib iga köite ühekordse konteineriga. Docker Compose lisab köidete nimedele ette projekti nime, mis on vaikimisi kausta nimi: kontrollige täpseid nimesid enne arhiveerimist.

docker volume ls
docker compose stop
docker run --rm -v "firefly-iii_firefly_iii_db:/tmp" -v "$HOME/backups/firefly:/backup" \
    ubuntu tar -czvf /backup/firefly_db.tar /tmp
docker run --rm -v "firefly-iii_firefly_iii_upload:/tmp" -v "$HOME/backups/firefly:/backup" \
    ubuntu tar -czvf /backup/firefly_upload.tar /tmp
docker compose start

Valesti kirjutatud köite nimi ei anna viga: Docker loob selle nime all tühja köite ja arhiveerib selle, mis kirjutab eelmise varukoopia üle. Dokumentatsioon palub enne iga arhiveerimist kontrollida, et köide on olemas.

Hoidke failist .env ja nendest arhiividest koopiat väljaspool serverit, krüpteeritult, sest see kannab võtit ja andmebaasi juurdepääsuandmeid. Serveri kettale pandud failid jõuavad ka selle öistesse varukoopiatesse.

Taastamine

Dokumentatsioon taastab köite vastupidise käsuga, teenus peatatud; manuste köide taastatakse samamoodi:

docker run --rm -v "firefly-iii_firefly_iii_db:/recover" -v "$HOME/backups/firefly:/backup" \
    ubuntu tar -xvf /backup/firefly_db.tar -C /recover --strip 1

SQL-eksport laaditakse tagasi töötavasse andmebaasi:

docker exec -i firefly_iii_db sh -c 'mariadb -u"$MYSQL_USER" -p"$MYSQL_PASSWORD" "$MYSQL_DATABASE"' < firefly-YYYY-MM-DD.sql

Taastage ka .env koos selle APP_KEY-ga, käivitage seejärel uuesti ja avage oma kontod. Dokumentatsioon kordab seda iga meetodi järel: varukoopiaga tuleb kõigepealt teha taastamine, et kontrollida, kas see toimib.

Uuendused ja migratsioonid

Firefly III uuendab end ise, isegi nii vanadest versioonidest nagu 4.7, ja migreerib oma andmebaasi konteineri käivitumisel. Dokumentatsioon hoiatab, et mõned uuendused eemaldavad või puhastavad andmeid, ja palub enne igaüht andmebaasi ja köidete varukoopiat, eriti peaversioonide vahel. Compose’i faili kaustast:

docker compose stop
docker compose pull
docker compose -f docker-compose.yml up -d --remove-orphans

• Tempo: versioonist 6.7.0 14. septembril 2026 kuni versioonini 6.7.9 11. oktoobril 2026 ilmus nelja nädalaga kümme versiooni. Jälgige väljalaskemärkmeid: alates versioonist 6.7.8 võtab rakenduses olev aken kokku paigaldatud versiooni peamised muudatused.
• Versioon 6.7.0 tõi uue liidese; selle reeglite avaldiste mootor on vaikimisi välja lülitatud ja lülitatakse uuesti sisse aadressil /settings.
• Compose’i fail: kui laadite selle uuesti alla, kontrollige selles deklareeritud andmebaasi versiooni. Dokumentatsioon hoiatab, et MariaDB uus peaversioon ei pruugi vana versiooni köidet üle võtta.
• Migratsioon, mis ei õnnestunud: alates versioonist 6.4.19 eemaldab php artisan correction:rollback-single-migration viimase migratsioonikirje andmeid puutumata ja seejärel käivitab php artisan migrate selle uuesti, konteineri sees.
• Allkirjastatud väljalasked: projekt allkirjastab oma väljalasked, mida saate kontrollida selle PGP-võtmega.

Importija uueneb samamoodi, oma dokumentatsiooni järgi käsuga docker compose rm -f peatamise ja tõmmiste allalaadimise vahel.

Kes mida teeb Managed VPS-is

Ise majutamine nõuab lisaks rakendusele ka serveri hoidmist. Managed VPS-is võtavad meie meeskonnad serveri enda hoole alla ja jälgivad teie instantsi proaktiivselt; Firefly III jääb teie tarkvaraks oma sätete ja teie rahaliste andmetega.

Kui eelistate, et meie meeskonnad sekkuksid rakendusse endasse, arveldatakse see teenus tunni- või kindlahinnaga, hinnapakkumine edastatakse enne sekkumist.