16 Installation
Benjamin edited this page 3 months ago

Installation 🔧

PHP Server

Anforderungen

  1. Lade awesomeBible Verse herunter.
  1. Öffne den FTP Client deiner Wahl und verbinde dich mit deinem Server.
  2. Navigiere in das Verzeichnis wo du awesomeBible Verse haben möchtest und lade nun den Inhalt der verse.zip-Datei hoch.

Empfohlen ist, awesomeBible Verse auf einer Subdomain z.B. verse.deinedomain.de zu installieren – wenn dies dein Hosting Provider zur Verfügung stellt. Ansonsten einfach in einen seperaten Ordner. Wenn auf deinedomain.de/ z.B. eine Wordress Installation ist, dann kannst du die Dateien einfach in einem Unterverzeichnis der selben Domain ablegen. (Zum Beispiel: deinedomain.de/verse/)

Bilder selbst hosten

awesomeBible Verse besteht aus zwei Teilen:

  1. Das Programm
  2. Die Bilder

Das Programm haben wir gerade auf deinem Server installiert. Standardmäßig benutzt Verse die Bilder die von verse.awesomebible.de gehostet werden.

Um Last von dem einen Server zu nehmen, und zu verhindern dass wenn verse.awesomebible.de down ist alle Verse Installationen nicht mehr funktionieren, sollte man wenn möglich die Bilder ebenfalls selbst hosten.

Die Bilder herunterladen:

  • Gehe zu Versbilder.md und lade die passende Datei herunter. (Sortiert nach Jahreszahlen)

Einfach die ZIP-Datei herunterladen herunterladen und entpacken.

Den Inhalt kann man jetzt in einen Storage-Bucket oder auf einen Webserver hochladen. Damit wären wir für den Bilder-Part fertig.

Jetzt müssen wir nur noch unsere Verse-Installation so anpassen, dass sie die Bilder aus unserem Storage-Bucket läd. Dazu müssen wir die index.php Datei auf unserem Server anpassen.

Die Dateiliste auf dem Server. Die Datei "index.php" ist hervorgehoben.

Lade die Datei herunter und öffne sie in einem Texteditor:

Die Datei "index.php" geöffnet in einem Texteditor

Dort musst du "https://verse.awesomebible.de/img/" finden und es mit der URL wo du die Bilder hochgeladen hast austauschen. (Zum Beispiel dein Storage-Bucket.)

Dann kannst du die Datei wieder speichern und hochladen.

Wenn das geklappt hat, rufe zum testen deine Installation auf. Wenn alles gut aussieht bist du hier fertig. Wenn nicht, öffne bitte hier ein Issue.

API Einrichtung

Wenn du die API benutzen möchtest, bearbeite auf dem Server im Verzeichnis api/ die Datei „keys.json“ und füge ein API-Schlüssel ein.

Nun speichere.

awesomeBible Verse API Schlüssel

API Nutzung

  1. Die API-Anfrage sollte so geformt sein: https://verse.deinedomain.de/api/?key=DEIN_API_KEY&location=BIBELBUCH_KAPITEL_UND_VERS

Beispiel: https://verse.deinedomain.de/api/?key=api-key&location=Offenbarung4,11

Browser.js

Anleitung

  1. Füge das Browser.js Skript in deine Website ein. Dazu kannst du folgenden HTML-Tag benutzen:
<script defer src="https://cdn.jsdelivr.net/npm/@awesomebible/verse.js@1.0.1/verse.min.js"></script>
  1. Füge da wo das Versbild erscheinen soll, ein Image-Tag mit der Klasse „awb-verse“ ein.
<img class="awb-verse"></img>

💡 Hinweis: Der Server von dem die Bilder geladen werden kann durch das setzen von der Variable versePath angepasst werden. Die Variable muss das Protokoll (HTTPS), die Domain und den genauen Pfad zu dem Ort wo die 2022/2023 Unterordner liegen enthalten.

Node.js Server

Coming soon. Lies, wie du helfen kannst.