Uppsetning

Keyrðu HolyArrs í Docker og opnaðu það í vafranum. Það tekur nokkrar mínútur.

Áður en þú byrjar

• Tölva með Docker og Docker Compose.
• Margmiðlunarmöppurnar þínar, eða staður þar sem þú getur búið þær til. Lestu fyrst Möppur ef þú vilt fá flutning án afritunar.
• Á NAS, Unraid eða Synology, sjá NAS, Synology og Unraid. Án Docker, sjá Portable útgáfa.

Skref

1. Búðu til möppu fyrir stillingarnar á staðbundnum diski, til dæmis /srv/holyarrs/config. Ekki á netdeild. Á Docker Desktop skaltu nota nefnt volume í staðinn. Sjá Docker Desktop.

2. Finndu notandann og hópinn sem eiga margmiðlunarmöppurnar þínar:

   id youruser
   # uid=1000(youruser) gid=1000(youruser)

   Notaðu uid sem PUID og gid sem PGID.

3. Vistaðu þetta sem docker-compose.yml og breyttu slóðunum:

   name: holyarrs
   services:
     holyarrs:
       image: holyarrs/holyarrs:latest
       container_name: holyarrs
       environment:
         - PUID=1000
         - PGID=1000
         - TZ=Etc/UTC
       volumes:
         - /srv/holyarrs/config:/config
         - /path/to/movies:/movies #optional
         - /path/to/tv:/tv #optional
         - /path/to/music:/music #optional
         - /path/to/downloads:/downloads #optional
       ports:
         - 6262:6262
       restart: unless-stopped

4. Ræstu það:

   docker compose up -d
   docker compose ps

   Container-inn sýnir stöðuna healthy þegar HolyArrs svarar.

5. Opnaðu http://your-server:6262 og stofnaðu eigandareikninginn strax. Það er ekkert sjálfgefið lykilorð. Þangað til þú stofnar hann verður sá sem opnar HolyArrs fyrst eigandinn.

6. Fylgdu uppsetningunni sem opnast næst. Sjá Fyrsta ræsing.

Varúð

Það er ekkert sjálfgefið lykilorð. Sá sem opnar nýtt HolyArrs fyrst verður eigandinn. Stofnaðu reikninginn núna.

Ef þú vilt frekar nota docker run:

docker run -d \
  --name=holyarrs \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 6262:6262 \
  -v /srv/holyarrs/config:/config \
  -v /path/to/movies:/movies `#optional`   -v /path/to/tv:/tv `#optional`   -v /path/to/music:/music `#optional`   -v /path/to/downloads:/downloads `#optional` \
  --restart unless-stopped \
  holyarrs/holyarrs:latest

Image tag

Tag	Hvað þú færð
latest	Nýjustu útgáfuna
1.0.0 (hvaða útgáfa sem er)	Nákvæmlega þá útgáfu, breytist aldrei

Stillingar útskýrðar

Port og möppur

Stilling	Hvað hún gerir
-p 6262:6262	Vefforritið.
-v /config	Gagnagrunnar, stillingar, aðallykillinn, backup og log. Aðeins staðbundinn diskur.
-v /movies	Valfrjálst. Safnmappa fyrir kvikmyndir.
-v /tv	Valfrjálst. Safnmappa fyrir þætti.
-v /music	Valfrjálst. Safnmappa fyrir tónlist.
-v /downloads	Valfrjálst. Niðurhalsmappa niðurhalsforritsins. Sjá Margmiðlunarmöppur.
--read-only=true	Valfrjálst. Sjá Skrifvarið rótarskráakerfi.
--user=1000:1000	Valfrjálst. Sjá Ræsa sem fastur notandi.

Umhverfisbreytur

Breyta	Hvað hún gerir
PUID, PGID	Notandinn og hópurinn sem HolyArrs keyrir sem. 1000 og 1000 ef þú sleppir þeim.
TZ	Tímabelti, til dæmis Europe/Amsterdam.
UMASK	Valfrjálst. Hvaða heimildabita nýjar skrár fá ekki, til dæmis 022 eða 002.
HOLYARRS_SAVE_PATH	Valfrjálst. Vistunarmappa niðurhalsforritsins, eins og niðurhalsforritið sér hana.
HOLYARRS_ALLOWED_HOSTS	Valfrjálst. Fleiri hýsilnöfn sem fólk notar til að ná í HolyArrs, aðskilin með kommum.
HOLYARRS_TRUSTED_PROXIES	Valfrjálst. Vistfang eða net reverse proxy sem þú notar.
HOLYARRS_URL_BASE	Valfrjálst. Bjóða HolyArrs undir slóð. Sjá URL base og reverse proxy.
HOLYARRS_MASTER_KEY_FILE	Valfrjálst. Lesa aðallykilinn úr sérskrá.

Hvaða breytu sem er má taka úr skrá. Settu FILE__ fyrir framan nafnið og gefðu slóð skrárinnar sem gildi:

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

Ein nýlína aftast í skránni er felld burt. Þetta virkar líka fyrir PUID, PGID, UMASK og TZ. Ef skráin vantar stöðvast HolyArrs og nefnir breytuna í logginu. Það prentar aldrei gildið.

Image-ið

Image-ið geymir HolyArrs og lítið annað. Það hefur ekkert shell, svo þú getur ekki farið inn með docker exec til að skoða þig um. Lestu logið í staðinn með docker logs holyarrs, eða opnaðu logs/holyarrs.log í stillingamöppunni.

Skipanir HolyArrs sjálfs virka áfram í gegnum docker exec:

docker exec holyarrs /holyarrs doctor
docker exec -i holyarrs /holyarrs reset-owner
docker exec holyarrs /holyarrs restore --pre-update

Image-in eru smíðuð fyrir amd64, 64-bita ARM og 32-bita ARM. Á tölvu með um það bil 2,5 GiB af minni eða minna kveikir HolyArrs sjálft á lágminnisham. Fyrsta línan í logginu segir frá því.

Notandi og hópur

Container-inn ræsist sem root aðeins til að setja sig upp. Hann gefur stillingamöppuna til PUID:PGID ef þarf og skiptir svo varanlega yfir í þann notanda. Fyrsta línan í logginu sýnir notandann, hópinn og umask.

HolyArrs breytir aldrei eiganda margmiðlunarmappa þinna eða niðurhalsmappa. Gefðu PUID-notandanum skrifaðgang að þeim handvirkt. Lesaðgangur nægir ekki, því HolyArrs býr til möppur og flytur skrár.

Sumt geymslukerfi getur ekki breytt eigendum, til dæmis NFS með root squash, SMB eða skrifvarin tenging. HolyArrs skráir þá viðvörun og heldur áfram. Gerðu stillingamöppuna skrifanlega fyrir PUID:PGID handvirkt.

Til að skipta um notanda þarf heimildirnar CHOWN, DAC_OVERRIDE, SETUID og SETGID. Docker gefur þær sjálfgefið. Ef þú tekur þær burt stöðvast HolyArrs með skilaboðum. Það fellur ekki aftur á root. Til að keyra í raun sem root skaltu stilla PUID=0 og PGID=0.

Aukahópar úr group_add: haldast þegar HolyArrs skiptir um notanda.

UMASK hefur aðeins áhrif á nýjar skrár. Slepptu því til að halda 022, þar sem þú skrifar og aðrir lesa. Notaðu 002 þegar hópur þarf líka að skrifa.

Margmiðlunarmöppur

Tengdu aðeins möppurnar sem þú notar: /movies, /tv og /music sem safnmöppur og /downloads sem niðurhalsmöppu.

Ábending um hardlinks (harðir tenglar): hver mappa sem þú tengir sérstaklega er sérstök tenging inni í container-num og ekki er hægt að gera hardlink á milli tenginga, svo innflutningur verður full afritun. Ef þú vilt hardlinks geturðu í staðinn tengt eina sameiginlega yfirmöppu (með niðurhali og safnmöppum inni í sér) í stað þessara fjögurra valfrjálsu tenginga og gefið niðurhalsforritinu sömu tengingu á sömu slóð. Yfirmappan verður líka að vera eitt skráakerfi. Aðskildar netdeildir eða datasets undir henni afrita áfram. Settings > Library folders (stillingar > safnmöppur) varar þig við þegar HolyArrs þarf að afrita.

HOLYARRS_SAVE_PATH er sent til niðurhalsforritsins með hverju niðurhali, svo það breytir líka hvar niðurhalsforritið vistar. Slepptu því til að halda stillingu niðurhalsforritsins sjálfs. Ef þú sleppir því skaltu bæta niðurhalsmöppunni við undir Settings > Library folders > Extra import folders (aukamöppur fyrir innflutning) svo þú getir flutt inn handvirkt úr henni.

Geymdu aðallykilinn

HolyArrs dulkóðar vistuð lykilorð, lykla og tokens með aðallykli. Fyrsta ræsing býr til /config/holyarrs.key.

Backup innihalda aldrei þennan lykil. Geymdu afrit annars staðar. Auðveldasta leiðin: sem eigandi skaltu opna Settings > Backups (stillingar > backup) og velja Download key kit (sækja lyklapakka). Til að setja hann aftur skaltu nefna skrána holyarrs.key og setja hana í stillingamöppuna á meðan HolyArrs er stöðvað. Endurheimt með öðrum lykli er hafnað. Með nefndu volume er engin mappa til að opna: afritaðu hann inn með docker cp holyarrs.key hx:/config/ eins og í Docker Desktop. Ertu að flytja á nýja tölvu? Settu lykilinn aftur fyrst og endurheimtu svo backup-ið. Sjá Backup.

Þú getur líka geymt lykilinn í sérstakri skrifvarinni skrá:

environment:
  - HOLYARRS_MASTER_KEY_FILE=/keys/holyarrs.key
volumes:
  - /srv/holyarrs/keys:/keys:ro

Skráin verður að vera til og geyma 32 hrá bæti, 64 sextándakerfisstafi eða base64 fyrir 32 bæti. PUID-notandinn verður að geta lesið hana.

Endurræsing og endurheimt

Hafðu endurræsingarstefnu. Endurheimt er athuguð og undirbúin, síðan hættir HolyArrs með stöðukóða 75 svo Docker ræsi það aftur og beiti henni. unless-stopped sér um það.

Til að uppfæra staðbundið build skaltu smíða og endurskapa án þess að snerta tengingarnar:

docker build --file deploy/Dockerfile --tag holyarrs:local .
docker compose up -d --force-recreate

Fjarlægðu aldrei /config í uppfærslu. Sjá Uppfærslur og Backup.

Hýsilnöfn og reverse proxy

IP-vistföng og localhost virka strax. Heimanafn eins og tower.local sem þú notar í fyrstu uppsetningu er vistað fyrir þig. Bættu við öðrum nöfnum undir Allowed host names (leyfð hýsilnöfn) í Settings > Sign-in and security, eða í HOLYARRS_ALLOWED_HOSTS.

Þegar reverse proxy bætir við X-Forwarded-For skaltu setja aðeins vistfang eða net fyrir proxy í HOLYARRS_TRUSTED_PROXIES. Án þess virka SSO, raunveruleg vistföng notenda og Secure-kakan ekki, og allir á bak við proxy deila sömu innskráningartakmörkum. Logið nefnir proxy-vistfangið sem á að bæta við. Ef annar proxy er fyrir framan, eins og Cloudflare, bættu við vistfangasviðum hans líka.

Með nginx skaltu senda báða hausana:

proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

Ef þeir stangast á lítur HolyArrs á gestinn sem utan netsins þíns.

Öryggi í grunninn

• Ekki framsenda port 6262 á routernum. Notaðu VPN eins og Tailscale, eða reverse proxy með HTTPS.
• Stofnaðu eigandareikninginn strax eftir fyrstu ræsingu.
• Geymdu afrit af aðallyklinum fjarri stillingamöppunni.
• Haltu image-inu uppfærðu.

Sérstakar uppsetningar

Docker Desktop (Windows og Mac)

Docker Desktop deilir möppum hýsilsins í gegnum lag þar sem læsingar á gagnagrunnsskrám eru ekki öruggar. HolyArrs hafnar /config þar og sýnir lausnina á porti 6262. Notaðu nefnt volume fyrir /config. Margmiðlunarmöppur mega vera möppur á hýsilnum.

name: holyarrs
services:
  holyarrs:
    image: holyarrs/holyarrs:latest
    container_name: holyarrs
    environment:
      - TZ=Etc/UTC
    volumes:
      - holyarrs-config:/config
      - C:/Media/movies:/movies
    ports:
      - 6262:6262
    restart: unless-stopped

volumes:
  holyarrs-config:

Til að færa gamla stillingamöppu inn í volume-ið skaltu stöðva HolyArrs og keyra:

docker create --name hx -v holyarrs-config:/config holyarrs/holyarrs:latest
docker cp C:\old\config\. hx:/config/
docker rm hx

Til að afrita backup út: docker cp holyarrs:/config/backups .

Á Mac, ef þú hefur athugað að skráalæsingar virka í möppunni þinni, stilltu HOLYARRS_ALLOW_DESKTOP_FOLDER=1 til að ræsa samt. HolyArrs varar við í hverri ræsingu. Þetta aflétir aldrei höfnuninni fyrir netdeildir.

Skrifvarið rótarskráakerfi

Aðeins /config og /tmp þurfa að vera skrifanleg:

services:
  holyarrs:
    read_only: true
    tmpfs:
      - /tmp

PUID, PGID og UMASK virka áfram.

Ræsa sem fastur notandi

services:
  holyarrs:
    user: "1000:1000"

HolyArrs breytir þá engum eigendum, svo stillingamappan verður nú þegar að vera skrifanleg fyrir þann notanda. PUID og PGID eru hunsuð og logið segir frá því. Þetta nær líka yfir Kubernetes runAsUser.

Rootless Docker og Podman

Í rootless-ham er root inni í container-num þinn eigin notandi og önnur auðkenni varpast á há númer á hýsilnum. Með PUID=1000 endar stillingamappan í eigu ókunnugs á hýsilnum.

Þú keyrir	docker info eða podman info sýnir	Notaðu
Venjulegt Docker	ekkert rootless	PUID og PGID eins og venjulega
Rootless Docker	rootless undir Security Options	Valkost 1
Rootless Podman	rootless: true	Valkost 1 eða 2

Valkostur 1. Stilltu PUID=0 og PGID=0. Þetta er öruggt aðeins í rootless-ham. Gerðu þetta aldrei með venjulegu Docker eða á NAS.

Valkostur 2. Podman með keep-id, sem Quadlet í ~/.config/containers/systemd/holyarrs.container:

[Container]
Image=holyarrs/holyarrs:latest
UserNS=keep-id
User=%U:%G
Volume=%h/holyarrs/config:/config:Z
PublishPort=6262:6262
HealthCmd=["/holyarrs","-healthcheck"]
HealthInterval=30s

[Service]
Restart=always

[Install]
WantedBy=default.target

Eða sem ein skipun:

podman run -d --name holyarrs --userns=keep-id --user "$(id -u):$(id -g)" -v ~/holyarrs/config:/config:Z -p 6262:6262 --health-cmd '["/holyarrs","-healthcheck"]' --health-interval 30s --restart always holyarrs/holyarrs:latest

• :Z er fyrir SELinux-kerfi. Notaðu :z á möppur sem niðurhalsforritið deilir. Notaðu hvorugt á netdeild (NFS eða SMB): ekki er hægt að merkja hana upp á nýtt og container-inn myndi ekki ræsast.
• Gefðu heilsuathugunina sem lista. Image-ið hefur ekkert shell.
• Hafðu endurræsingarstefnuna always. Þjónusta Podman sem ræsir eftir endurræsingu tölvunnar ræsir aðeins always-container.
• Til að ræsa eftir endurræsingu tölvunnar án þess að skrá þig inn skaltu keyra loginctl enable-linger $USER einu sinni. Notaðu svo Quadlet-skrána, eða fyrir podman run keyrðu systemctl --user enable podman-restart.service.

Ef mappan tilheyrir nú þegar háu auðkenni skaltu stöðva container-inn fyrst og síðan:

• Rootless Podman: podman unshare chown -R 0:0 ~/holyarrs/config (Valkostur 1) eða podman unshare chown -R 1000:1000 ~/holyarrs/config.
• Rootless Docker: rootlesskit chown -R 0:0 ~/holyarrs/config, keyrt í gegnum nsenter inn í rootless-daemon (nsenter -U --preserve-credentials -n -m -t $(cat $XDG_RUNTIME_DIR/docker.pid)).

Smíðaðu þitt eigið image

Úr checkout af HolyArrs:

docker build --file deploy/Dockerfile --tag holyarrs:local .

Notaðu svo holyarrs:local sem image.

Bilanaleit

Keyrðu doctor fyrst. Hann athugar stillingarnar, möppurnar, netið og klukkuna og segir þér hvernig á að laga hvert vandamál.

• Container-inn keyrir: docker exec holyarrs /holyarrs doctor
• Container-inn endurræsir sig sífellt: docker compose run --rm holyarrs doctor

Sjá Bilanaleit fyrir logið og stuðningspakkann.

Þú sérð	Gerðu þetta
Config folder is on a shared or network folder	Notaðu staðbundinn disk, eða nefnt volume á Docker Desktop. Á Unraid notaðu /mnt/<pool>/appdata/holyarrs.
Config folder is in memory	Settu /config á disk. Á Unraid, athugaðu að slóð pool-sins sé til. Fyrir prufutölvu leyfir HOLYARRS_CONFIG_IN_MEMORY=yes það.
Config folder cannot be written	Fjarlægðu :ro og athugaðu að PUID:PGID eigi möppuna.
Disk is full	Losaðu pláss á disknum sem geymir /config og endurræstu svo.
/config is not mapped	Sjá hér að neðan.
Cannot switch user	Settu heimildirnar fjórar aftur, eða notaðu user: "<uid>:<gid>".
PUID/PGID does not exist inside this container	Auðkennin eru utan varpaða sviðsins. Sjá Rootless Docker og Podman.
A FILE__ variable cannot be read	Athugaðu slóðina og að skráin sé tengd.
Permission denied	Athugaðu PUID, PGID og skrifaðgang á öllum möppum.
Unknown host name	Opnaðu HolyArrs með IP-vistfangi og bættu nafninu við undir Allowed host names.
Imports are copied	Tengdu eina sameiginlega möppu. Sjá Margmiðlunarmöppur.
Master key does not match	Settu aftur lykilinn sem tilheyrir þessum gagnagrunnum.
Restore staged but the app stays down	Bættu við endurræsingarstefnu og ræstu container-inn.

Gleymdirðu að varpa /config?

HolyArrs ræsist samt, en varar við út um allt. Allt tapast þegar container-inn er fjarlægður. Vistaðu það fyrst:

docker stop holyarrs
docker cp holyarrs:/config ./holyarrs-config

Varpaðu síðan ./holyarrs-config:/config (eða nefndu volume) og endurskapaðu container-inn. Á Docker Desktop (Windows og Mac) skaltu nota nefnt volume, ekki möppu á hýsli, og afrita gögnin inn eins og sýnt er í Docker Desktop. Eldri uppsetning gæti enn setið í ónefndu volume. Listaðu þau með docker volume ls.

Tengt efni

• Möppur
• Fyrsta ræsing
• NAS, Synology og Unraid
• Uppfærslur