OpenLibry ist eine einfache, schnelle und offene Verwaltung für kleine Bibliotheken, z.B. in Schulen. Sie wurde optimiert auf einfache Bedienung in einer trubeligen Umgebung, in der kleine Kinder Bücher abgeben, ausleihen, weitergeben und liegen lassen.
Die Idee entstand in unserer Grundschule, in der OpenBiblio im Einsatz war, eine quelloffene und kostenlose Software, die aber schon seit vielen Jahren nicht mehr gepflegt wird. Viele Eltern und Freiwillige engagieren sich ehrenamtlich, um die Bücher zu katalogisieren, Nutzer-Ausweise zu drucken und zu Ausleihzeiten zur Verfügung zu stehen - trotzdem habe ich keine kostenlose digitale Lösung gefunden, um sie zu unterstützen. So entstand OpenLibry.
- Nutzbar auf Computer, Tablet und Handy
- On-the-fly-Suche während man tippt nach Büchern, Leihen und NutzerInnen. Einfacher Filter für überfällige Bücher in einer Klasse direkt im Ausleih-Screen
- Optimiert auf wenige Maus- und Tastaturklicks, insbesondere für die Ausleihe und Rückgabe
- Cover-Bilder für Bücher können eingefügt werden
- Einfache Installation in einer lokalen Umgebung oder in einer Cloud
- Kein komplizierter Schnickschnack mit Nutzerberechtigungen, drölfzig unnötigen Datenfeldern usw.
- Moderner Software-Stack mit next.js-Oberfläche und einfacher Datenbank
- Importfunktion für Daten von alten OpenBiblio-Installationen
Start-Screen
Ausleih-Screen
Bücherverwaltung-Screen
Edit-Screen
- Kopiere das Beispiel-Environment-File:
cp .env_example .env - Konfiguriere den Servernamen in einer
.env-Datei im Hauptordner entsprechend der Werte im.env_example, z.B.NEXT_PUBLIC_API_URL="http://localhost:3000" - Der Wert
AUTH_ENABLEDsollte zunächst auffalsegesetzt werden, so dass man sich beim ersten Login ohne Authentifizierung einloggen kann. Viahttps://<domain>/auth/registerkann man dann den ersten User anlegen und danachAUTH_ENABLEDauftruesetzen.
Für eine lokale Installation ohne Docker befolge diese Schritte:
- Update der Distribution:
sudo apt-get updateundsudo apt-get upgrade - Falls
curlnicht installiert ist:apt install curl - Installiere den node version manager NVM:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash. Damit solltenvminstalliert sein. - Installiere den node server:
nvm install --lts - Falls noch kein
gitinstalliert ist:sudo apt-get install git-all - Kopiere das Repository aus github:
git clone https://github.com/jzakotnik/openlibry.git - Nutze das entsprechende Verzeichnis:
cd openlibry - Kopiere das Beispielfile und passe den API-Endpunkt mit dem entsprechenden Servernamen an:
cp .env_example .envund ggf.nano .env - Installiere alle notwendigen node-Pakete:
npm install - Erzeuge eine leere Datenbank (SQLite):
npx prisma db push - Starte OpenLibry mit
npm run dev. Achte darauf, dass der entsprechende Port freigegeben ist und über den Browser zugänglich ist.
Erledige zunächst folgende Vorarbeiten:
Update der Distribution: sudo apt-get update und sudo apt-get upgrade
Falls curl nicht installiert ist: sudo apt install curl
Installiere den node version manager NVM: curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
Installiere den node server (Vorher Neustart des Terminals notwendig.): nvm install --lts
Falls noch kein git installiert ist: sudo apt-get install git-all
Installiere, falls noch nicht vorhanden, Docker an sich:
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu jammy stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
sudo usermod -aG docker ${USER}
sudo systemctl is-active docker
Danach ist eine Neuanmeldung/Neustart nötig, damit die Änderungen an den Nutzergruppen (usermod) aktiv werden.
Anschließend kannst du OpenLibry installieren. Dabei bieten sich zwei Modi an: Entweder ein Sandbox-Modus zum Ausprobieren, bei dem nach Beendigung der Ausführung alles wieder entfernt wird. Oder die dauerhafte Installation, die auch automatisch mit Rechnerstart, bei Abstürzen etc. wieder mit startet. Folgende Schritte sind so oder so zu erledigen (Zum Beispiel im Home-Verzeichnis):
- Kopiere das Repository aus github:
git clone https://github.com/jzakotnik/openlibry.git - Wechsle in das dabei dabei entstandene Verzeichnis:
cd openlibry - Anschließend musst du die Konfiguration/individuelle Anpassung von OpenLibry vornehmen: Zum einen müssen Bilddateien mit den Logos deiner Institution hinterlegt werden. Diese befinden sich im "public" Unterordner, du kannst dich dabei an den vorhandenen Beispielbildern orientieren. Weiterhin muss eine ".env"-Datei angelegt werden. (Hinweis: Dateien mit führenden Punkt sind in der grafischen Oberfläche standardmäßig "unsichtbar". Die Tastenkombination "Strg-h" macht sie sichtbar.) Kopiere dazu die vorhandene ".env_example" Datei nochmal in den Ordner und benenne sie dabei um in ".env":
cp .env_example .env - Bearbeite die entstandene ".env" Datei mit einem Texteditor und passe die Werte entsprechend an.
- Anschließend kannst du Docker alle notwendigen Schritte automatisch übernehmen lassen:
docker build --no-cache -t openlibry .
Das weitere Vorgehen unterscheidet sich je nach Absicht:
a) Sandbox-Modus zum rückstandsfreien Ausprobieren:
- Docker Container starten:
docker run -i --rm -p 3000:3000 -t openlibry - Öffne OpenLibry im Browser und probiere es aus:
http://localhost:3000 - Zum Beenden den Prozess in der Konsole abrechen mit der Tastenkombination "Strg-c".
- Optional das Docker-Image löschen:
docker image rm openlibry
b) Dauerhafte Installation
- Docker Container dauerhaft starten, er wird dabei auch nach jedem Neustart, Absturz etc. automatisch neu gestartet:
docker compose up(Hierbei wird Docker gestartet mit Parametern, die in der Datei docker-compose.yml hinterlegt sind. Unter anderem sind hier Volumes angelegt, in welchen die User-Daten deiner Installation liegen. Nach einem Update deines Docker-Containers sind diese dann weiterhin vorhanden.) - Öffne OpenLibry im Browser:
http://localhost:3000 - Bei Bedarf kannst du die Ausführung dieses Containers manuell stoppen, dann startet er auch nicht sofort automatisch wieder neu:
docker stop openlibry - Bei Bedarf kannst du nach dieser Variante alles zu OpenLibry in Docker wieder löschen: Du kannst den Container und das Image in Docker wieder entfernen mit:
docker rm openlibryunddocker image rm openlibry
Eine Installationsanleitung für die Konfiguration mit dem Webserver nginx auf einer Subdomain findet sich hier
- Setze die Auth Variable in
.envauffalseum sich ohne Authentifizierung anzumelden - Via
/auth/registererzeuge einen neuen User - Setze die Auth Variable auf
true
Die REST-API kennt die Resourcen book und user. Für beide gibt es jeweils die entsprechenden http-Operationen (GET, PUT, POST, DELETE). Die Ausleihe entsteht durch die Verknüpfung von user und book, also z.B. http://localhost:3000/api/book/2001/user/1080, um ein Buch auszuleihen.
Die API kann verwendet werden, um User/Bücher aus anderen Programmen automatisiert zu importieren.
Weitere Beispiele sind im docs-Folder aufgeführt.
Um Bücher einfacher mit dem Schlagwort der Antolin Leseförderung versehen zu können, kann der Antolin Export des Westermann Verlags eingebunden werden. Dazu kann man Westermann/Antolin kontaktieren und bekommt dort einen Link auf eine csv Datei mit dem Export alles Antolin Bücher. Dieser ist im Ordner /public/antolin/antolingesamt.csv abzulegen.
Im Edit-Screen der Bücher kann man dann sehen ob ähnliche Bücher in der Antolin Datenbank vorhanden sind.
. OpenLibry durchsucht dabei die Datenbank nach Datensätzen bei denen der Autor und Titel vorkommmen, insbesondere wenn es keinen direkten Link via ISBN gibt.
Um automatisierte Mahnschreiben zu erzeugen, verwendet OpenLibry eine Template Bibliothek, welche eine Word Datei als Muster verwendet und dann entsprechende Platzhalter einsetzen kann. Die Platzhalter können im .env File konfiguriert. Ein Beispiel ist in folgendem Template zu finden.
Um bestehende Daten zu importieren bzw. Daten aus OpenLibry zu exportieren gibt es eine Excel Funktion. Diese kann auch verwendet werden, um Backups zu erzeugen und bei Bedarf wieder zu importieren.
Für das Erzeugen einer Excel Datei kann auf der Reports Seite die Kachen Excel Export angeklickt werden. Dadurch downloadet der Browser ein Excel mit 2 Blättern: Bücher und User.
Das Worksheet Userliste enthält folgende Spalten:
- Erzeugt am
- Update am
- Nummer
- Nachname
- Vorname
- Klasse
- Lehrkraft
- Freigeschaltet
Das Worksheet Bücherliste enthält folgende Spalten:
- Mediennummer
- Erzeugt am
- Update am
- Ausleihstatus
- Ausgeliehen am
- Rückgabe am
- Anzahl Verlängerungen
- Titel
- Untertitel
- Autor
- Schlagworte
- Bild
- ISBN
- Edition
- Verlagsort
- Seiten
- Zusammenfassung
- Min Spieler
- Verlag
- Merkmale
- Beschaffung
- Publikationsdatum
- Abmessungen
- Min Alter
- Max Alter
- Material
- Preis
- Links
- Ausgeliehen von
Für den Import einer Excel Datei kann auf der Reports Seite die Kachel Excel Import angeklickt werden. Diese führt zu einer Import-Seite.
Für den Import von Daten gibt es zwei Stufen:
-
Zunächst kann das Excel hochgeladen werden. Eine Vorschau zeigt an, wieviele User und Bücher importiert werdne und die jeweiligen ersten Zeilen werden dargestellt. Die Spalten des Excel Files müssen denen entsprechen, die auch beim export erzeugt werden. Ein Beispiel-Excel File findet sich hier. Nach dem Upload sieht der Bildschirm so aus:
-
Wenn die Vorschau wie erwartet aussieht, kann mit dem Button In die Datenbank importieren importiert werden. Dabei muss eine leere Datenbank bereits existieren, wie in der Anleitung beschrieben.
Siehe Open Biblio, die Import-Schritte
Das Datenmodell für Bücher beinhaltet aktuell folgende Felder (alle optional bis auf Titel und Autor). Die anderen Felder sind im Schema einsehbar:
| Feld-Name | Funktion |
|---|---|
| id | Mediennummer |
| rentalStatus | Ausleihstatus (available, rented, lost) |
| rentedDate | Ausleihdatum |
| dueDate | Rückgabedatum |
| renewalCount | Anzahl Verlängerungen |
| title | Titel |
| subtitle | Untertitel |
| author | Autor(en) |
| topics | Schlagwörter mit Semikolon getrennt |
| imageLink | Cover Bild |
| isbn | ISBN Nummer |
| editionDescription | Edition / Band |
| publisherLocation | Verlagsort |
| pages | Anzahl Seiten |
| summary | Zusammenfassung |
| minPlayers | Anzahl Spieler (bei Brettspielen) |
| publisherName | Verlag |
| otherPhysicalAttributes | Andere physische Eigenschaften (bei Brettspielen) |
| supplierComment | Quelle, z.B. Spende |
| publisherDate | Publikationsdatum |
| physicalSize | Abmessungen |
| minAge | Mindestalter |
| maxAge | Höchstalter |
| additionalMaterial | Zusätzliches Material, z.B. CD oder DVD |
| price | Preis |
| externalLinks | Externe Verknüpfungen |
Falls Cover importiert werden: ISBN-Service für ISBN-10 und ISBN-13: https://openlibrary.org/isbn/9780140328721 Cover: https://covers.openlibrary.org/13834659
Falls Ihr mitmachen wollt, die Software nutzen wollt oder ein Hosting sucht, schreibt mich gerne unter [email protected] an. Falls Ihr die Software finanziell unterstützen wollt, geht es bei Ko-Fi sehr einfach.