Εισαγωγή κλειδιών από αρχείο

Συμπλήρωσε ένα αρχείο με τις Πηγές, τα προγράμματα λήψεων, τους διακομιστές πολυμέσων, τους ιστότοπους υποτίτλων και το email σου, εισήγαγέ το, και γλίτωσε να γράφεις κάθε κλειδί στις Ρυθμίσεις.

Πριν ξεκινήσεις

• Το HolyArrs τρέχει σε Docker με τον φάκελο ρυθμίσεων στο /config.
• Μπορείς να φτιάξεις κλειδί API ιδιοκτήτη στο Settings > API > API keys (Ρυθμίσεις > API > κλειδιά API).

Εισήγαγε το αρχείο

1. Αντίγραψε το holyarrs-secrets.template.yaml σε holyarrs-secrets.yaml.

2. Συμπλήρωσε όσα χρησιμοποιείς. Άφησε τα υπόλοιπα κενά· κενό σημαίνει παράλειψη.

3. Κάν’ το αναγνώσιμο μόνο από σένα:

   chmod 600 holyarrs-secrets.yaml

4. Σύνδεσέ το (mount) στο container μόνο για ανάγνωση:

   volumes:
     - /srv/holyarrs/config:/config
     - /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro

5. Φτιάξε ένα κλειδί API ιδιοκτήτη με το scope admin στο Settings > API > API keys. Βάλ’ το στο μπλοκ holyarrs του αρχείου με τη διεύθυνση http://127.0.0.1:6262.

6. Κάνε μια δοκιμαστική εκτέλεση. Δεν αλλάζει τίποτα:

   docker exec holyarrs /holyarrs import-secrets -file /run/secrets/holyarrs.yaml -dry-run

   Θα πρέπει να δεις μία γραμμή would set για κάθε στοιχείο.

7. Τρέξ’ το κανονικά (η ίδια εντολή χωρίς -dry-run). Θα πρέπει να δεις γραμμές set και κωδικό εξόδου 0.

8. Έλεγξε τις νέες Πηγές και τα νέα προγράμματα λήψεων και μετά συνέχισέ τα. Δοκίμασε τους νέους διακομιστές πολυμέσων και τις Ειδοποιήσεις και μετά ενεργοποίησέ τα.

9. Σβήσε το αρχείο στον host (δες Σβήσε το αρχείο). Σβήσε και το κλειδί API αν δεν το χρειάζεσαι πια.

Προσοχή

Το αρχείο κρατά κάθε μυστικό σε απλό κείμενο μέχρι να το σβήσεις. Σβήσ’ το στον host μόλις πετύχει η εκτέλεση.

Σε τι μετατρέπεται κάθε μπλοκ

Στο αρχείο	Γίνεται
trakt.client_id	Το κλειδί εφαρμογής του Trakt (Settings > Outside lists, δηλαδή Εξωτερικές λίστες).
tmdb, tvdb	Γίνονται δεκτά από παλιότερα αρχεία. Τα μεταδεδομένα δεν χρειάζονται κλειδιά.
opensubtitles, subdl	Ένας ιστότοπος υποτίτλων με τον λογαριασμό σου.
addic7ed	Ένας ιστότοπος υποτίτλων Addic7ed, μόνο για σειρές.
indexers	Μία Πηγή για κάθε εγγραφή, σε παύση.
jackett, prowlarr	Το κλειδί τους συμπληρώνει κάθε εγγραφή indexers στην ίδια διεύθυνση που δεν έχει κλειδί.
qbittorrent, sabnzbd	Ένα πρόγραμμα λήψεων, σε παύση.
nzbget, transmission, deluge	Παραλείπονται. Η εισαγωγή δεν μπορεί ακόμα να τα ρυθμίσει· πρόσθεσέ τα στο Settings > Downloaders.
jellyfin, emby, plex	Ένας διακομιστής πολυμέσων, ανενεργός μέχρι να τον δοκιμάσεις.
smtp, discord, webhook	Οι Ειδοποιήσεις «Email», «Discord» και «Webhook», ανενεργές μέχρι να τις δοκιμάσεις.
radarr, sonarr, lidarr, prowlarr, bazarr, seerr	Ένα κλειδί αποθηκευμένο για το Import from other apps (εισαγωγή από άλλες εφαρμογές).
holyarrs	Χρησιμοποιείται μόνο για να φτάσει στο HolyArrs όσο τρέχει. Δεν αποθηκεύεται ποτέ.

Κάθε κλειδί μπαίνει στο κρυπτογραφημένο vault, όπως κι ένα που γράφεις στις Ρυθμίσεις.

Επιλογές

Ο διακόπτης τοπικού δικτύου

Κάθε μπλοκ με διεύθυνση μπορεί να έχει allow_local_network: true. Αφήνει αυτό το στοιχείο να φτάνει στον υπολογιστή αυτόν ή στο οικιακό σου δίκτυο (192.168.x.x, 10.x.x.x, όνομα container). Χωρίς αυτό, το στοιχείο φτάνει μόνο στο internet, οπότε ένα πρόγραμμα λήψεων στο σπίτι δεν θα απαντήσει. Το HolyArrs δεν το μαντεύει ποτέ από τη διεύθυνση. Είναι ο ίδιος διακόπτης με το May reach the local network (μπορεί να φτάνει στο τοπικό δίκτυο) στις Ρυθμίσεις.

Με σταματημένο το HolyArrs

Τρέξε ένα εφάπαξ container πάνω στον ίδιο φάκελο ρυθμίσεων. Αποθηκεύει κατευθείαν στον φάκελο ρυθμίσεων και δεν χρειάζεται μπλοκ holyarrs:

docker stop holyarrs
docker run --rm -e PUID=1000 -e PGID=1000 \
  -v /srv/holyarrs/config:/config \
  -v /srv/holyarrs/holyarrs-secrets.yaml:/run/secrets/holyarrs.yaml:ro \
  holyarrs/holyarrs:latest import-secrets -file /run/secrets/holyarrs.yaml
docker start holyarrs

Χρησιμοποίησε τα ίδια PUID και PGID με την εφαρμογή, αλλιώς ο φάκελος ρυθμίσεων περνά στο 1000:1000. Ο χρήστης PUID πρέπει να μπορεί να διαβάσει το αρχείο. Αν χρησιμοποιείς το HOLYARRS_MASTER_KEY_FILE, δώσε στο εφάπαξ container την ίδια μεταβλητή και την ίδια σύνδεση φακέλου.

Νέα εκτέλεση

Μπορείς να το τρέξεις ξανά με ασφάλεια. Τα στοιχεία που ταιριάζουν γράφουν unchanged· αποθηκεύονται μόνο όσα άλλαξαν.

Στοιχείο	Αντιστοιχίζεται με
Πηγές	όνομα
Προγράμματα λήψεων, διακομιστές πολυμέσων	είδος και διεύθυνση
Ειδοποιήσεις	όνομα και είδος
Ιστότοποι υποτίτλων, παλιές εφαρμογές	είδος

Μια Πηγή ή ένα πρόγραμμα λήψεων που άλλαξε διεύθυνση ή κλειδί μπαίνει ξανά σε παύση. Αφού συνεχίσεις μόνος σου κάποιο, μια νέα εκτέλεση το αφήνει να τρέχει. Ένα κενό api_key σε εγγραφή indexers κρατά το αποθηκευμένο κλειδί· πρόσθεσε clear_key: true για να το αφαιρέσεις.

Σβήσε το αρχείο

Με το -delete, η εντολή γράφει μηδενικά πάνω στο αρχείο και το αφαιρεί, μόνο μετά από εκτέλεση χωρίς αποτυχίες. Μια σύνδεση φακέλου μόνο για ανάγνωση δεν μπορεί να σβηστεί από μέσα από το container, οπότε σβήσ’ το στον host:

Σύστημα	Εντολή
Linux	shred -u holyarrs-secrets.yaml
macOS	rm -P holyarrs-secrets.yaml
Windows	Remove-Item holyarrs-secrets.yaml, και μετά άδειασε τον Κάδο Ανακύκλωσης.

Σε SSD και συστήματα αρχείων copy-on-write, παλιά blocks μπορεί να μείνουν στον δίσκο. Τα ίδια τα κλειδιά ζουν πλέον στο κρυπτογραφημένο vault.

Αν δεν δουλεύει

Σύμπτωμα	Αιτία	Λύση
Το αρχείο διαβάζεται από άλλους χρήστες	Τα δικαιώματα είναι πολύ ανοιχτά.	Τρέξε chmod 600. Στα Windows, κράτα το σε φάκελο που ανοίγεις μόνο εσύ.
Ένα άγνωστο κλειδί σταμάτησε την εισαγωγή	Τυπογραφικό λάθος ή tab στη γραμμή που αναφέρεται.	Διόρθωσε εκείνη τη γραμμή. Δεν αποθηκεύτηκε τίποτα.
Απορρίφθηκε το απλό http	Η διεύθυνση holyarrs δεν είναι σε αυτόν τον υπολογιστή.	Τρέξε μέσα στο container με http://127.0.0.1:6262, ή χρησιμοποίησε https.
Ένα πρόγραμμα λήψεων στο σπίτι δεν απαντά	Δεν υπάρχει δικαίωμα τοπικού δικτύου.	Βάλε allow_local_network: true σε εκείνο το μπλοκ.
Το εφάπαξ container άλλαξε τους ιδιοκτήτες των φακέλων	Διαφορετικά PUID/PGID.	Χρησιμοποίησε τα PUID και PGID της εφαρμογής.
Το -delete δεν έκανε τίποτα	Κάτι απέτυχε, ή η σύνδεση φακέλου είναι μόνο για ανάγνωση.	Σβήσ’ το στον host.

Για έμπειρους

Flags και κωδικοί εξόδου

Flag	Τι κάνει	Προεπιλογή
-file <path>	Το αρχείο μυστικών.	κανένα
-dry-run	Λέει μόνο τι θα οριζόταν.	ανενεργό
-config <folder>	Ο φάκελος ρυθμίσεων.	/config
-delete	Μετά από εκτέλεση χωρίς αποτυχίες, γράφει μηδενικά πάνω στο αρχείο και το σβήνει.	ανενεργό
-forget-move-credentials	Σβήνει κάθε αποθηκευμένο κλειδί παλιάς εφαρμογής και μετά σταματά.	ανενεργό
-allow-http-lan	Επιτρέπει απλό http:// προς διεύθυνση οικιακού δικτύου. Τυπώνει προειδοποίηση.	ανενεργό
-allow-readable-file	Δέχεται αρχείο που μπορούν να διαβάσουν άλλοι χρήστες. Το Docker Desktop στα Windows δείχνει κάθε αρχείο ως αναγνώσιμο.	ανενεργό

Η διεύθυνση holyarrs πρέπει να είναι https://, ή απλό http:// μόνο προς αυτόν τον υπολογιστή (127.0.0.1, ::1, localhost). Μέσω απλού http, το κλειδί ιδιοκτήτη και ολόκληρο το αρχείο ταξιδεύουν χωρίς κρυπτογράφηση.

Κωδικός εξόδου	Τι σημαίνει
0	Όλα τα στοιχεία πήγαν καλά.
1	Ένα στοιχείο απέτυχε. Διόρθωσε το αρχείο και τρέξε ξανά.
2	Λάθος γραμμή εντολών ή αρχείο.

Έξοδος

Μία γραμμή ανά στοιχείο: set (ή would set σε δοκιμαστική εκτέλεση, μερικές φορές με σημείωση), unchanged, skipped (empty), skipped (why) ή failed: why. Δεν τυπώνει ποτέ κλειδί, κωδικό πρόσβασης, token ή διεύθυνση. Το Ιστορικό παίρνει ένα συμβάν με μόνο τους αριθμούς. Ένα σφάλμα που θα έδειχνε τιμή από το αρχείο σου δείχνει αντί γι’ αυτήν [hidden].

Μορφή αρχείου

Ένα μικρό, αυστηρό υποσύνολο του YAML:

• μπλοκ με εσοχή από κενά, ποτέ tabs· λίστες με - ,
• τιμές απλές, σε "double quotes" (διπλά εισαγωγικά) ή 'single quotes' (μονά εισαγωγικά) (γράψε ένα ' μέσα σε μονά εισαγωγικά δύο φορές),
• το # ξεκινά σχόλιο στην αρχή γραμμής ή μετά από κενό εκτός εισαγωγικών, οπότε βάλε σε εισαγωγικά έναν κωδικό που περιέχει #,
• βάλε σε εισαγωγικά μια τιμή που ξεκινά με &, *, !, |, >, [, {, %, @ ή backquote, ή που περιέχει : .

Ένα άγνωστο κλειδί ή ένα αρχείο πάνω από 256 KB σταματά ολόκληρη την εισαγωγή πριν αποθηκευτεί οτιδήποτε· το μήνυμα λέει το κλειδί και τη γραμμή. Ένας σύνδεσμος προς το αρχείο απορρίπτεται.

Ειδικά πεδία

Πεδίο	Κανόνας
SABnzbd	Θέλει το πλήρες api_key. Ένα nzb_key, όνομα χρήστη ή κωδικός πρόσβασης παραλείπεται και δεν αποθηκεύεται ποτέ.
tvdb.api_key, tvdb.unique_user_key, trakt.redirect_urls	Γίνονται δεκτά και παραλείπονται.
smtp.host	Μόνο όνομα διακομιστή, χωρίς scheme ή θύρα.
smtp.port	1 έως 65535. Προεπιλογή 587.
smtp.from	Μία απλή διεύθυνση email.
Μπλοκ παλιών εφαρμογών	Χρησιμοποιούνται στο Import from other apps με το Use the saved key (χρήση του αποθηκευμένου κλειδιού). Δεν εμφανίζονται ποτέ, μόνο για τον ιδιοκτήτη, σβήνονται μετά από μία επιτυχημένη ανάγνωση.

Σχετικά

• Διάβασε τις παλιές εφαρμογές σου
• Μεταβλητές περιβάλλοντος