ตัวแปรสภาพแวดล้อม

ตัวแปรทั้งหมดที่ Container ของ HolyArrs อ่าน การติดตั้งส่วนใหญ่ตั้งแค่ PUID, PGID และ TZ

ตัวแปรที่ใช้บ่อย

ตัวแปร	หน้าที่	ค่าเริ่มต้น	ตัวอย่าง
PUID, PGID	ผู้ใช้และกลุ่มที่ HolyArrs รันด้วย ต้องเป็นเจ้าของ /config และโฟลเดอร์สื่อของคุณ	1000, 1000	PUID=1000
TZ	เขตเวลาสำหรับตารางเวลาและ Log	Etc/UTC	TZ=Europe/Amsterdam
UMASK	บิตสิทธิ์ที่ไฟล์ใหม่ไม่ได้รับ มีผลกับไฟล์ใหม่เท่านั้น	022	UMASK=002
HOLYARRS_SAVE_PATH	โฟลเดอร์ที่ตัวดาวน์โหลดใช้บันทึกไฟล์ ตามที่ตัวดาวน์โหลดมองเห็น ส่งไปพร้อมกับทุกงานดาวน์โหลด	ไม่มี	/data/downloads
HOLYARRS_URL_BASE	ให้ HolyArrs ทำงานใต้พาธหนึ่งหลัง Reverse proxy ถ้าใส่ / จะไม่สนพาธที่บันทึกไว้ในการตั้งค่า	ไม่มี	/holyarrs
HOLYARRS_ALLOWED_HOSTS	ชื่อโฮสต์เพิ่มเติมที่ใช้เข้า HolyArrs คั่นด้วยจุลภาค	IP และ localhost	holyarrs.example.com
HOLYARRS_TRUSTED_PROXIES	ที่อยู่หรือเครือข่ายของ Reverse proxy คั่นด้วยจุลภาค จำเป็นถ้าต้องการที่อยู่จริงของผู้ใช้	ไม่มี	172.18.0.0/16
HOLYARRS_MASTER_KEY_FILE	อ่านคีย์หลักของ vault จากไฟล์ของมันเอง ผู้ใช้ PUID ต้องอ่านไฟล์นี้ได้	/config/holyarrs.key	/keys/holyarrs.key

ค่าจากไฟล์

ใส่ FILE__ หน้าตัวแปรใดก็ได้ เพื่ออ่านค่าจากไฟล์ เช่น Docker secret

environment:
  - FILE__HOLYARRS_ALLOWED_HOSTS=/run/secrets/holyarrs_hosts

HolyArrs ตัดบรรทัดใหม่ท้ายไฟล์ออกหนึ่งตัว ถ้าไม่มีไฟล์ HolyArrs จะหยุดทำงาน และ Log จะบอกชื่อตัวแปรกับไฟล์ แต่ไม่แสดงค่า

การกู้คืนและการแก้ปัญหา

ตัวแปร	หน้าที่	ค่าเริ่มต้น	ตัวอย่าง
HOLYARRS_SAFE_MODE	เริ่มเฉพาะส่วนหลัก ได้แก่ การล็อกอิน คลัง การตั้งค่า Backup และการตรวจสุขภาพ เอาออกหลังแก้ปัญหาแล้ว	ปิด	1
HOLYARRS_LOW_MEMORY	1 บังคับเปิดโหมดประหยัดหน่วยความจำ 0 บังคับปิด ถ้าไม่ตั้ง โหมดนี้จะเปิดเองเมื่อ RAM ประมาณ 2.5 GiB หรือน้อยกว่า	ตามขนาดเครื่อง	1
HOLYARRS_FOLLOW_LINKS	1 ให้การสแกนคลังและการนำเข้าใช้ไฟล์วิดีโอและเพลงที่เป็น symlink ได้ (คลังที่สร้างจากลิงก์ไปยังไดรฟ์ที่เมานต์) งานดาวน์โหลดที่เป็นลิงก์จะวางในคลังเป็นลิงก์	ปิด	1
GOMEMLIMIT	แทนที่เป้าหมายหน่วยความจำที่ HolyArrs ตั้งให้ตัวเอง	HolyArrs ตั้งให้เอง	1GiB
HOLYARRS_SKIP_SPACE_CHECK	ข้ามการตรวจพื้นที่ว่างก่อนอัปเดตฐานข้อมูล	ปิด	yes
HOLYARRS_CONFIG_IN_MEMORY	อนุญาตให้ /config อยู่ในโฟลเดอร์ที่เก็บในหน่วยความจำ สำหรับเครื่องทดสอบ ข้อมูลจะหายเมื่อรีสตาร์ต	ปิด	yes
HOLYARRS_ALLOW_DESKTOP_FOLDER	เริ่มโดยให้ /config อยู่ในโฟลเดอร์แชร์ของ Docker Desktop บน Mac หลังจากที่คุณตรวจแล้วว่าการล็อกไฟล์ใช้ได้ HolyArrs จะเตือนทุกครั้งที่เริ่ม	ปิด	1
HOLYARRS_READONLY_DOWNLOADERS	ตัวดาวน์โหลดที่ HolyArrs ห้ามเปลี่ยนแปลง ระบุด้วย id หรือที่อยู่ คั่นด้วยจุลภาค	ไม่มี	3,http://qbit:8080
HOLYARRS_HEALTH_URL	ที่อยู่ที่การตรวจสุขภาพของ Container เรียกใช้	http://127.0.0.1:6262	http://127.0.0.1:6262/holyarrs

ตัวแปรแบบเปิด/ปิดรับค่า 1, true, yes หรือ on

Single sign-on (SSO)

ตั้งค่าเหล่านี้ก่อนเริ่ม ถ้ามี HOLYARRS_OIDC_ENABLED อยู่เลย แม้เป็น false ก็ตาม แปลว่าสภาพแวดล้อมเป็นผู้ควบคุม SSO และหน้าการตั้งค่าจะแสดงให้ดูอย่างเดียว ตัวแปรแบบเปิด/ปิดตรงนี้รับเฉพาะ true หรือ false ค่าอื่นจะทำให้เริ่มไม่ได้

ตัวแปร	หน้าที่	ค่าเริ่มต้น
HOLYARRS_OIDC_ENABLED	เปิด SSO	false
HOLYARRS_OIDC_ISSUER	HTTPS issuer ที่ตรงเป๊ะของผู้ให้บริการ	ไม่มี
HOLYARRS_OIDC_CLIENT_ID	client id ที่ลงทะเบียนไว้	ไม่มี
HOLYARRS_OIDC_CLIENT_SECRET_FILE	ไฟล์ที่เก็บ client secret ไม่เกิน 4096 ไบต์ ไม่ต้องใส่ถ้าเป็น public client	ไม่มี
HOLYARRS_OIDC_REDIRECT_URL	callback ที่ตรงเป๊ะ ได้แก่ที่อยู่ของคุณ ตามด้วย URL base (ถ้ามี) แล้วต่อด้วย /api/v1/auth/oidc/callback	ไม่มี
HOLYARRS_OIDC_ALLOW_JOIN	คนใหม่เข้าร่วมเป็นสมาชิกที่ขอได้อย่างเดียว	false
HOLYARRS_OIDC_ALLOW_LOCAL_NETWORK	อนุญาตผู้ให้บริการที่อยู่ในเครือข่ายส่วนตัวของคุณ	false
HOLYARRS_OIDC_ALLOW_LOOPBACK_HTTP	อนุญาต HTTP ธรรมดาบนเครื่องนี้ สำหรับการทดสอบ	false
HOLYARRS_FORWARD_AUTH_ENABLED	เปิดการล็อกอินผ่าน Proxy ที่เชื่อถือได้	false
HOLYARRS_FORWARD_AUTH_ISSUER	ชื่อ HTTPS ที่คงที่สำหรับ Proxy	ไม่มี
HOLYARRS_FORWARD_AUTH_TRUSTED_PEERS	ที่อยู่หรือช่วงของ Proxy ที่ส่ง header ระบุตัวตนได้ คั่นด้วยจุลภาค	ไม่มี
HOLYARRS_FORWARD_AUTH_ALLOW_JOIN	ชื่อใหม่จาก Proxy เข้าร่วมเป็นสมาชิกที่ขอได้อย่างเดียว	false

ถ้าตั้งค่าผิด HolyArrs จะเริ่มไม่ได้ ดูขั้นตอนที่ การล็อกอินและรหัสผ่าน

สำหรับผู้เชี่ยวชาญ

เมตาดาต้า

ตัวแปร	หน้าที่	ค่าเริ่มต้น
HOLYARRS_METADATA_URL	ที่อยู่ของเมตาดาต้าเซิร์ฟเวอร์	https://api.holyarrs.com
HOLYARRS_TMDB_KEY	Read access token ของ TMDB ที่เป็นของคุณเอง ถ้าตั้งไว้ การอ่านข้อมูล TMDB จะไปที่ TMDB โดยตรง ไม่ผ่านเมตาดาต้าเซิร์ฟเวอร์	ไม่มี
HOLYARRS_METADATA_SERVICE_TOKEN_FILE	ไฟล์ที่เก็บข้อมูลยืนยันตัวตนของการติดตั้งนี้สำหรับเมตาดาต้าเซิร์ฟเวอร์ อ่านทุกครั้งที่เรียก ถ้าไม่ตั้ง ข้อมูลยืนยันตัวตนจะอยู่ใน vault	ไม่มี

สิ่งที่ยังผ่านเมตาดาต้าเซิร์ฟเวอร์เมื่อใช้คีย์ TMDB ของคุณเอง และที่อยู่ภายนอกอื่นทั้งหมด อยู่ในที่อยู่ภายนอก

ทางลัดตอนเริ่มครั้งแรก

แต่ละตัวเพิ่มหนึ่งรายการตอนเริ่ม ใช้สำหรับเดโมและการทดสอบ ตัวช่วยตั้งค่าครั้งแรกก็ทำสิ่งเดียวกัน

ตัวแปร	สิ่งที่เพิ่ม
HOLYARRS_MOVIES	โฟลเดอร์คลังภาพยนตร์
HOLYARRS_QBITTORRENT_URL	ตัวดาวน์โหลด qBittorrent
HOLYARRS_SOURCE_URL	แหล่งค้นหา Torznab ที่ไม่มีคีย์

ตัวแปรสำหรับนักพัฒนาและการทดสอบ

ตัวแปรเหล่านี้ชี้ HolyArrs ไปที่ตัวจำลองสำหรับการทดสอบ อย่าตั้งในการติดตั้งจริง

ตัวแปร	หน้าที่
HOLYARRS_FLAGS	สวิตช์คั่นด้วยจุลภาคสำหรับฟีเจอร์ที่ปิดอยู่โดยค่าเริ่มต้นในเวอร์ชันนี้ ดู การอัปเดต
HOLYARRS_DIRECT_SOURCES	1 ให้การติดตั้งนี้ถามแหล่งข้อมูลเพลงและทีวีเอง แทนที่จะผ่านเมตาดาต้าเซิร์ฟเวอร์
HOLYARRS_METADATA_SERVICE_ALLOW_LOCAL	อนุญาตเมตาดาต้าเซิร์ฟเวอร์ ในเครือข่ายภายใน
HOLYARRS_METADATA_COUNT	นับและบันทึก Log คำขอเมตาดาต้า
HOLYARRS_TMDB_TOKEN_FILE, HOLYARRS_TMDB_URL	ไฟล์ token TMDB สำหรับทดสอบ และที่อยู่ตัวจำลอง
HOLYARRS_TVMAZE_URL, HOLYARRS_MUSICBRAINZ_URL, HOLYARRS_DEEZER_URL, HOLYARRS_TRAKT_URL, HOLYARRS_PLEX_URL, HOLYARRS_PLEX_APP_URL, HOLYARRS_PLEX_DISCOVER_URL, HOLYARRS_PUSHOVER_URL, HOLYARRS_TELEGRAM_URL, HOLYARRS_YOUTUBE_URL, HOLYARRS_RELEASE_FEED	ที่อยู่ตัวจำลองของบริการภายนอก
HOLYARRS_TRAILER_PASS_FIRST, HOLYARRS_TRAILER_PASS_EVERY	ช่วงเวลาของรอบตรวจตัวอย่างหนัง เป็นระยะเวลา เช่น 2s

หน้าที่เกี่ยวข้อง

• การติดตั้ง
• รันใต้พาธ
• การล็อกอินและรหัสผ่าน