Hogyan hozzunk létre egyéni Redmine Docker képet?

Redmine előtt testreszabás

Megjegyzés: A Redmine natív docker elérhető a https://hub.docker.com/_/redmine oldalon. Itt jó útmutatókat is találhat arról, hogyan lehet külső adatbázist feltölteni és külső mappákat csatolni (a pluginek telepítéséhez).

Ha hasonlóan gondolkodik, mint én, és inkább közvetlenül szeretné látni a testreszabott Redmine Docker kép kódját, akkor látogasson el a github.com/lcofre/redmine oldalra, és ellenőrizze a Dockerfile-t.

A Redmine Docker kép jó kiindulópont, bár valószínűleg szeretné testreszabni a saját kedvenc plugineivel és témáival. Ebben a how-to-ban egy Docker képet fogunk építeni az hivatalos képre alapozva, hozzáadunk néhány témát és plugint, majd feltöltjük a docker registry-be.

Az egyszerűség kedvéért nem használunk külső adatbázist, hanem egy belső adatbázist használunk a Redmine konténerben magában. Azonban egy termelési környezetben ajánlott egy dedikált tároló konténer beállítása.

Pluginek és témák

Választottunk néhány plugint és témát, hogy bemutassuk a Redmine-hez való különböző hozzáadási módokat:

• Oldalsáv elrejtése, egy plugin, amely lehetővé teszi a nagyobb képernyőterületet, különösen akkor, amikor problémákat írunk
• Vágólap beillesztése, hogy képernyőképeket csatoljon a vágólapról, ahelyett, hogy kiválasztana egy fájlt
• A1 és Gitmike, két téma, amely megváltoztatja a felhasználói felület kinézetét

Kizárjuk azokat a plugineket, amelyek adatbázis-migrációt igényelnek, mivel előre létező adatbázisra van szükségük. Ha olyan plugint szeretne telepíteni, amely migrációkat igényel, akkor kérjük, kommentelje alá, mivel van jó ötleteink.

A Dockerfile írása

A Dockerfile egy recept arról, hogyan kell egy Docker képet építeni. Az első tény, amit itt megtanulunk, az az, hogy másik képre kell alapoznunk a képünket, így a hivatalos Redmine képet fogjuk használni.

FROM Redmine

A Dockerfile első sora az utolsó és legnagyobb képre alapozza a képünket, amely a 4.1.0 verzió a jelenlegi írásbeli időpontban. Mivel ez a legfrissebb verziót fogja letölteni, előnyösebb lehet egy adott verziót használni, hogy elkerüljük azokat az váratlan új verziókat, amelyek tönkretehetik ezt a képet.

FROM Redmine:4.1.0

A Git használata a komponensek letöltéséhez

A legtöbb esetben a témák és bővítmények Git tárolókkal rendelkeznek, ahol letölthetjük a legfrissebb kódot. Ez igaz a következő három komponensre.

Az alap Redmine kép nem tartalmaz Git-et, de hozzáadhatjuk a képhez ezt a módszert használva:

RUN apt install -y git

Ez végrehajtódik, amikor a kép épül, és lehetővé teszi a Git használatát a következő utasításokban.

Gitmike témája: javasolják, hogy közvetlenül klónozzuk a repo-jukat

RUN git clone https://github.com/makotokw/redmine-theme-gitmike.git public/themes/gitmike

Ez a sor menti a klónozott projektet a megfelelő mappába, a public/themes-be.

Oldalsáv elrejtése: Ugyanez a folyamat alkalmazható bővítményekre is. Ehhez semmi másra nincs szükségünk, csak a klónozott mappa elhelyezésére a bővítmények mappájában.

RUN git clone https://gitlab.com/bdemirkir/sidebar_hide.git plugins/sidebar_hide

Vágólap kép beillesztése: Ez is úgy tűnik, hogy a tipikus eljárás, klónozzuk a repo-t, és kész is vagyunk.

RUN git clone https://github.com/RubyClickAP/clipboard_image_paste.git plugins/clipboard_image_paste

De ha tovább olvasunk, láthatjuk, hogy "ajánlott az RMagick gem telepítése, különben a csatolt képek nem jelennek meg az exportált PDF fájlokban". Tehát hogyan kell ezt megtenni? Ez olyan egyszerűnek tűnik, mint

RUN gem install rmagick

de valószínűleg tudod, hogy a gem-nek épülnie kell, mielőtt telepíthető lenne, tehát szükséged van néhány csomag telepítésére a gem telepítése előtt. Az a sor, amire valóban szükséged van, az:

RUN apt install -y build-essential imagemagick libmagickcore-dev libmagickwand-dev ruby-dev \

       && gem install rmagick

Minden egyetlen parancsban, két sorba szétválasztva az olvashatóság érdekében.

A plugin eredeti szerzője nem biztosít verziót a Redmine 4-hez, de a plugin nevének keresése a GitHub-on egy olyan projektre vezetett, amely igen: RubyClickAP/clipboard_image_paste.

Bővítmény vagy téma hozzáadása letöltött forrásból

A A1 téma jó példa arra, hogy bemutassuk azokat az eseteket, amikor rendelkezünk a forrással, de nincs URL a letöltéshez a build folyamat során. Ebben az esetben az egyik lehetőség az, hogy a forrást a build folyamatához adjuk. Így a tartalom hozzáadódik a képhez letöltés nélkül.

COPY a1 public/themes/a1

Ehhez az a1 mappának ugyanazon a helyen kell lennie, ahol a Dockerfile található.

Most már készen állsz a kép építésére, tehát nyiss meg egy terminált, ahol a Dockerfile található, és hajtsd végre a következő parancsot:

docker build -t my-redmine .

Amint elkészült, futtathatod a képedet:

docker run -it -p 3000:3000 --name my-redmine my-redmine

Nyisd meg a http://localhost:3000 címet, hogy megnézd a testreszabott Redmine-odat!

A testreszabott Redmine

Néhány tipp a bővítmények hozzáadásához

Az új bővítmények kipróbálásához mindig jobb egy friss Redmine konténert használni. Így jöttem rá, hogy az rmagick-hez néhány csomagot telepíteni kell. Először futtass egy eldobható Redmine példányt:

docker run --rm -d -p 3000:3000 --name test-redmine redmine

és lépj be a példányba:

docker exec -it test-redmine bash

Itt telepíthetsz operációs rendszer csomagokat, gem-eket vagy futtathatsz migrációkat. Csak emlékezz a lépésekre, hogy hozzáadhassuk őket a Dockerfile-hoz!

A saját kép feltöltése a Docker Hub-ra

Az általad épített kép csak a helyi környezetedben érhető el. Mi van akkor, ha mások is hozzáférhetnek hozzá, mondjuk mindenki? Természetesen feltöltheted a Dockerfile-t és a kapcsolódó fájlokat egy git repo-ba, és az érdeklődők maguk is építhetik a képet. De a Docker lehetővé teszi a kép feltöltését a regisztrációjukba is. Ehhez hozz létre egy fiókot a hub.docker.com-on, és hozz létre egy tárolót a képedhez. Ezután jelentkezz be a terminálban így

docker login

Címkézd a képedet, hogy feltölthető legyen a tárolódba

docker tag my-redmine:latest lcofre/redmine:latest

és töltsd fel így

docker push lcofre/redmine:latest

A Docker kép a Docker regisztrációban

Most bárki kipróbálhatja a képedet azzal, hogy

docker run -it -p 3000:3000 --name my-redmine lcofre/redmine

Ennyi az egész! Így juthatsz el egy szabványos Redmine telepítéstől egy a Docker regisztrációban elérhető személyre szabott verzióig. Kérjük, ossza meg velünk a megjegyzéseit vagy kérdéseit az alábbiakban.

A Docker kép méretének csökkentése

Az a repo-ban található Dockerfile több sort egybeolvasztott. Ez a Docker ajánlása a kisebb képek létrehozása érdekében. Ezt és más ajánlásokat megtalálhatod itt: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/

Egy másik ajánlás a kép végső méretének csökkentésére az alpine verzió használata a Redmine-ban

FROM Redmine:alpine

Az Alpine egy másik Linux disztribúció. Ahelyett, hogy az apt segítségével telepítenéd a csomagokat, az apk-t kell használnod.

Egy utolsó tipp: az apt segítségével telepített csomagok a Dockerfile-ban már nem szükségesek a kép elkészültével. Követheted a legjobb gyakorlatot, és több szakaszos építést használhatsz: https://docs.docker.com/develop/develop-images/dockerfile_best-practices/#use-multi-stage-builds

A kis méretű Docker kép megtartása különösen hasznos, amikor növeled a példányok számát, de csökkenti a képed támadási felületét is.