Express Tutorial Teil 7: Bereitstellung in Produktion

Übersicht

Sobald Ihre Seite fertig ist (oder "fertig genug", um öffentlich getestet zu werden), müssen Sie sie irgendwo hosten, das öffentlicher und zugänglicher ist als Ihr persönlicher Entwicklungscomputer.

Bis jetzt haben Sie in einer Entwicklungsumgebung gearbeitet, Express/Node als Webserver verwendet, um Ihre Seite an den lokalen Browser/das Netzwerk freizugeben, und Ihre Website mit (unsicheren) Entwicklungseinstellungen betrieben, die Debugging- und andere private Informationen offenlegen. Bevor Sie eine Website extern hosten können, müssen Sie:

• Eine Umgebung für das Hosting der Express-App wählen.
• Einige Änderungen an Ihren Projekteinstellungen vornehmen.
• Eine Infrastruktur auf Produktionsniveau für das Bereitstellen Ihrer Website einrichten.

Dieses Tutorial bietet einige Anleitungen zu den Optionen für die Wahl einer Hosting-Site, einen kurzen Überblick darüber, was Sie tun müssen, um Ihre Express-App für die Produktion bereit zu machen, und ein Arbeitsbeispiel, wie Sie die Website der LocalLibrary auf dem Railway Cloud-Hosting-Service installieren.

Was ist eine Produktionsumgebung?

Die Produktionsumgebung ist die Umgebung, die vom Computer des Servers bereitgestellt wird, auf dem Ihre Website für den externen Verbrauch ausgeführt wird. Die Umgebung umfasst:

• Computerhardware, auf der die Website läuft.
• Betriebssystem (z.B. Linux oder Windows).
• Programmiersprachenlaufzeit und Framework-Bibliotheken, auf denen Ihre Website geschrieben ist.
• Webserver-Infrastruktur, möglicherweise einschließlich eines Webservers, eines Reverse-Proxys, eines Load Balancers usw.
• Datenbanken, von denen Ihre Website abhängt.

Der Server-Computer könnte auf Ihrem Gelände sein und über einen schnellen Anschluss mit dem Internet verbunden sein, aber es ist weitaus üblicher, einen Computer zu verwenden, der "in der Cloud" gehostet wird. Was dies eigentlich bedeutet, ist, dass Ihr Code auf einem entfernten Computer (oder möglicherweise einem "virtuellen" Computer) im Rechenzentrum Ihres Hosting-Unternehmens ausgeführt wird. Der Remote-Server bietet normalerweise eine garantierte Ebene von Computing-Ressourcen (z.B. CPU, RAM, Speicher, etc.) und Internet-Konnektivität zu einem bestimmten Preis.

Diese Art von aus der Ferne zugänglicher Netzwerkinfrastruktur wird als Infrastructure as a Service (IaaS) bezeichnet. Viele IaaS-Anbieter bieten Optionen zur Vorinstallation eines bestimmten Betriebssystems, auf das Sie die anderen Komponenten Ihrer Produktionsumgebung installieren müssen. Andere Anbieter erlauben Ihnen, vollständigere Umgebungen auszuwählen, die möglicherweise eine vollständige Node-Einrichtung umfassen.

Andere Hosting-Anbieter unterstützen Express als Teil eines Platform as a Service (PaaS)-Angebots. Bei der Nutzung dieser Art von Hosting müssen Sie sich nicht um den größten Teil Ihrer Produktionsumgebung (Server, Load Balancer, etc.) kümmern, da die Host-Plattform diese für Sie übernimmt. Dadurch wird die Bereitstellung recht einfach, da Sie sich nur auf Ihre Webanwendung konzentrieren und nicht auf andere Server-Infrastrukturen.

Einige Entwickler werden die erhöhte Flexibilität von IaaS gegenüber PaaS vorziehen, während andere die reduzierte Wartungslast und den geringeren Skalierungsaufwand von PaaS zu schätzen wissen. Wenn Sie gerade erst anfangen, ist es viel einfacher, Ihre Website auf einem PaaS-System einzurichten, und genau das werden wir in diesem Tutorial tun.

Einen Hosting-Anbieter auswählen

Es gibt zahlreiche Hosting-Anbieter, die entweder aktiv unterstützen oder gut mit Node (und Express) arbeiten. Diese Anbieter bieten verschiedene Arten von Umgebungen (IaaS, PaaS) sowie unterschiedliche Ebenen von Computing- und Netzwerkressourcen zu unterschiedlichen Preisen.

Einige Dinge, die Sie bei der Wahl eines Hosts berücksichtigen sollten:

• Wie stark Ihre Seite frequentiert sein wird und die Kosten für die Daten- und Computing-Ressourcen, die benötigt werden, um diese Nachfrage zu erfüllen.
• Unterstützung für das horizontale (Hinzufügen weiterer Maschinen) und vertikale (Upgrade auf leistungsstärkere Maschinen) Scaling und die damit verbundenen Kosten.
• Die Standorte, an denen der Anbieter Rechenzentren hat, und somit, wo der Zugriff wahrscheinlich am schnellsten ist.
• Die historische Verfügbarkeit und Ausfallzeiten des Hosts.
• Bereitgestellte Tools zur Verwaltung der Seite - sind sie einfach zu bedienen und sicher (z. B. SFTP gegenüber FTP).
• Eingebaute Frameworks zur Überwachung Ihres Servers.
• Bekannte Einschränkungen. Einige Hosts blockieren absichtlich bestimmte Dienste (z. B. E-Mail). Andere bieten nur eine bestimmte Anzahl von Stunden "Live-Zeit" in einigen Preiskategorien oder bieten nur wenig Speicherplatz.
• Zusätzliche Vorteile. Einige Anbieter bieten kostenlose Domain-Namen und Unterstützung für TLS-Zertifikate, die Sie normalerweise bezahlen müssten.
• Ob das "kostenlose" Tier, auf das Sie sich verlassen, im Laufe der Zeit abläuft und ob die Kosten für den Umstieg auf ein teureres Tier bedeuten, dass es besser gewesen wäre, einen anderen Dienst von Anfang an zu nutzen!

Die gute Nachricht, wenn Sie gerade erst anfangen, ist, dass es viele Seiten gibt, die "kostenlose" Computerumgebungen bieten, die für die Evaluierung und das Testen gedacht sind. Diese sind in der Regel relativ ressourcenbeschränkt und Sie müssen sich bewusst sein, dass sie nach einer Einführungszeit ablaufen oder andere Einschränkungen haben können. Sie sind jedoch großartig, um Seiten mit geringem Datenverkehr in einer gehosteten Umgebung zu testen, und können einen einfachen Übergang zu zahlungsbasierten Ressourcen bieten, wenn Ihre Seite stärker frequentiert wird. Beliebte Optionen in dieser Kategorie sind Amazon Web Services und Microsoft Azure.

Die meisten Anbieter bieten auch eine "Basic" oder "Hobby" Stufe an, die für kleine Produktionsseiten gedacht ist und nützlichere Rechenleistungsebenen und weniger Einschränkungen bietet. Railway, Heroku und DigitalOcean sind Beispiele für beliebte Hosting-Anbieter, die eine relativ kostengünstige grundlegende Compute-Stufe (im Bereich von 5 bis 10 USD pro Monat) haben.

Ihre Website für die Veröffentlichung bereit machen

Die wichtigsten Dinge, die Sie berücksichtigen sollten, wenn Sie Ihre Website veröffentlichen, sind Websicherheit und Leistung. Mindestens möchten Sie die Datenbankkonfiguration so ändern, dass Sie eine andere Datenbank für die Produktion verwenden und deren Anmeldeinformationen sichern können, die Stack-Traces entfernen, die während der Entwicklung auf Fehlerseiten enthalten sind, Ihre Protokollierung aufräumen und die entsprechenden Header setzen, um viele gängige Sicherheitsbedrohungen zu vermeiden.

In den folgenden Abschnitten umreißen wir die wichtigsten Änderungen, die Sie an Ihrer App vornehmen sollten.

Datenbankkonfiguration

Bisher in diesem Tutorial haben wir eine einzelne Entwicklungsdatenbank verwendet, deren Adresse und Anmeldeinformationen hartcodiert in bin/www waren. Da die Entwicklungsdatenbank keine Informationen enthält, die wir gerne preisgeben oder beschädigen lassen, besteht kein besonderes Risiko, diese Details weiterzugeben. Wenn Sie jedoch mit echten Daten arbeiten, insbesondere mit persönlichen Benutzerdaten, ist es sehr wichtig, Ihre Datenbankanmeldeinformationen zu schützen.

Aus diesem Grund möchten wir eine andere Datenbank für die Produktion verwenden als für die Entwicklung und auch die Anmeldeinformationen der Produktionsdatenbank vom Quellcode getrennt halten, damit sie angemessen geschützt werden können.

Wenn Ihr Hosting-Anbieter die Einstellung von Umgebungsvariablen über eine Webschnittstelle unterstützt (wie viele es tun), ist eine Möglichkeit, dies zu tun, den Datenbank-URL über eine Umgebungsvariable vom Server zu erhalten. Im Folgenden ändern wir die Website von LocalLibrary, um die Datenbank-URI aus einer OS-Umgebungsvariablen zu erhalten, wenn sie definiert wurde, und ansonsten die Entwicklungsdatenbank-URL zu verwenden.

Öffnen Sie bin/www und finden Sie die Zeile, die die MongoDB-Verbindungsvariable festlegt. Sie sieht etwa so aus:

const mongoDB =
  "mongodb+srv://your_user_name:your_password@cluster0.cojoign.mongodb.net/local_library?retryWrites=true&w=majority";

Ersetzen Sie die Zeile durch den folgenden Code, der process.env.MONGODB_URI verwendet, um den Verbindungsstring aus einer Umgebungsvariablen mit dem Namen MONGODB_URI zu erhalten, wenn diese gesetzt wurde (verwenden Sie Ihre eigene Datenbank-URL anstelle des Platzhalters unten).

const dev_db_url =
  "mongodb+srv://your_user_name:your_password@cluster0.cojoign.mongodb.net/local_library?retryWrites=true&w=majority";
const mongoDB = process.env.MONGODB_URI || dev_db_url;

Setzen von NODE_ENV auf 'production'

Wir können Stack-Traces auf Fehlerseiten entfernen, indem wir die NODE_ENV Umgebungsvariable auf production setzen (standardmäßig ist sie auf 'development' gesetzt). Zusätzlich zur Erzeugung weniger ausführlicher Fehlermeldungen bewirkt das Setzen der Variablen auf production, dass Ansichtsvorlagen und CSS-Dateien, die aus CSS-Erweiterungen generiert wurden, zwischengespeichert werden. Tests zeigen, dass das Setzen von NODE_ENV auf production die Anwendungsleistung um einen Faktor von drei verbessern kann!

Diese Änderung kann entweder durch Verwendung von export, einer Umgebungsdatei oder des OS-Initialisierungssystems vorgenommen werden.

Angemessen protokollieren

Protokollierungsaufrufe können einen Einfluss auf eine stark frequentierte Website haben. In einer Produktionsumgebung müssen Sie möglicherweise Website-Aktivitäten protokollieren (z.B. Verkehrsverfolgung oder API-Aufrufe protokollieren), aber Sie sollten versuchen, die zum Debuggen hinzugefügte Protokollierung auf ein Minimum zu beschränken.

Eine Möglichkeit, das "Debug"-Protokollieren in der Produktion zu minimieren, besteht darin, ein Modul wie debug zu verwenden, das es Ihnen ermöglicht, welche Protokollierung durchgeführt wird, durch das Setzen einer Umgebungsvariablen zu steuern. Zum Beispiel zeigt das untenstehende Codesegment, wie Sie das Protokollieren von "author" einrichten könnten. Die Debug-Variable wird mit dem Namen 'author' deklariert, und das Prefix "author" wird automatisch für alle Protokolle aus diesem Objekt angezeigt.

const debug = require("debug")("author");

// Display Author update form on GET.
exports.author_update_get = async (req, res, next) => {
  const author = await Author.findById(req.params.id).exec();
  if (author === null) {
    // No results.
    debug(`id not found on update: ${req.params.id}`);
    const err = new Error("Author not found");
    err.status = 404;
    return next(err);
  }

  res.render("author_form", { title: "Update Author", author });
};

Sie können dann eine bestimmte Menge Protokolle aktivieren, indem Sie sie als kommagetrennte Liste in der DEBUG Umgebungsvariablen angeben. Sie können die Variablen aktivieren, um Autoren- und Buchprotokolle so anzuzeigen (Jokerzeichen werden ebenfalls unterstützt).

#Windows
set DEBUG=author,book

#Linux
export DEBUG="author,book"

Wenn Sie Website-Aktivitäten protokollieren müssen, können Sie eine Protokollierungsbibliothek wie Winston oder Bunyan verwenden. Weitere Informationen zu diesem Thema finden Sie unter: Production best practices: performance and reliability.

Verwenden von gzip/deflate-Komprimierung für Antworten

Webserver können häufig die HTTP-Antwort, die an einen Client gesendet wird, komprimieren, was die Zeit erheblich reduzieren kann, die der Client benötigt, um die Seite zu erreichen und zu laden. Das verwendete Komprimierungsverfahren hängt von den Dekompressionsmethoden ab, die der Client im Request angibt (die Antwort wird unkomprimiert gesendet, wenn keine Komprimierungsmethoden unterstützt werden).

Fügen Sie dies zu Ihrer Website mithilfe der compression Middleware hinzu. Installieren Sie dies im Stammverzeichnis Ihres Projekts, indem Sie den folgenden Befehl ausführen:

npm install compression

Öffnen Sie ./app.js und binden Sie die Komprimierungsbibliothek ein, wie gezeigt. Fügen Sie die Komprimierungsbibliothek mit der use() Methode zur Middleware-Kette hinzu (dies sollte vor allen Routen erscheinen, die Sie komprimieren möchten - in diesem Fall alle!).

const catalogRouter = require("./routes/catalog"); // Import routes for "catalog" area of site
const compression = require("compression");

// Create the Express application object
const app = express();

// …

app.use(compression()); // Compress all routes

app.use(express.static(path.join(__dirname, "public")));

app.use("/", indexRouter);
app.use("/users", usersRouter);
app.use("/catalog", catalogRouter); // Add catalog routes to middleware chain.

// …

Verwenden von Helmet zum Schutz vor bekannten Schwachstellen

Helmet ist ein Middleware-Paket. Es kann die geeigneten HTTP-Header setzen, die Ihrer App helfen, sich vor bekannten Webschwachstellen zu schützen (siehe Dokumentation für weitere Informationen darüber, welche Header es setzt und welche Schwachstellen es schützt).

Installieren Sie dieses im Stammverzeichnis Ihres Projekts, indem Sie den folgenden Befehl ausführen:

npm install helmet

Öffnen Sie ./app.js und binden Sie die helmet Bibliothek ein, wie gezeigt. Fügen Sie dann das Modul mit der use() Methode zur Middleware-Kette hinzu.

const compression = require("compression");
const helmet = require("helmet");

// Create the Express application object
const app = express();

// Add helmet to the middleware chain.
// Set CSP headers to allow our Bootstrap and jQuery to be served
app.use(
  helmet.contentSecurityPolicy({
    directives: {
      "script-src": ["'self'", "cdn.jsdelivr.net"],
    },
  }),
);

// …

Normalerweise hätten wir einfach app.use(helmet()); eingefügt, um das Teilmenge der sicherheitsbezogenen Header hinzuzufügen, die für die meisten Seiten sinnvoll sind. Allerdings enthalten wir im LocalLibrary Basistemplate einige Bootstrap-Skripte. Diese verstoßen gegen die Standardeinstellung der helmingschen Content Security Policy (CSP), die das Laden von cross-site Skripten nicht zulässt. Um das Laden dieser Skripte zu erlauben, ändern wir die Helmet-Konfiguration so, dass CSP-Direktiven gesetzt werden, die das Skriptladen von den angegebenen Domains erlauben. Für Ihren eigenen Server können Sie spezifische Header je nach Bedarf hinzufügen/deaktivieren, indem Sie den Anweisungen zur Verwendung von helmet hier folgen.

Hinzufügen von Ratenbegrenzungen zu den API-Routen

Express-rate-limit ist ein Middleware-Paket, das verwendet werden kann, um wiederholte Anfragen an APIs und Endpunkte zu begrenzen. Es gibt viele Gründe, warum übermäßige Anfragen an Ihre Seite gestellt werden könnten, wie zum Beispiel Denial-of-Service-Angriffe, Brute-Force-Angriffe oder sogar einfach ein Client oder ein Skript, das sich nicht wie erwartet verhält. Abgesehen von Leistungsproblemen, die durch zu viele Anfragen entstehen können und dazu führen, dass Ihr Server langsamer wird, könnten Ihnen auch Gebühren für den zusätzlichen Verkehr berechnet werden. Dieses Paket kann verwendet werden, um die Anzahl der Anfragen, die an eine bestimmte Route oder eine Menge von Routen gestellt werden können, zu begrenzen.

Installieren Sie dieses im Stammverzeichnis Ihres Projekts, indem Sie den folgenden Befehl ausführen:

npm install express-rate-limit

Öffnen Sie ./app.js und binden Sie die express-rate-limit Bibliothek ein, wie gezeigt. Fügen Sie dann das Modul mit der use() Methode zur Middleware-Kette hinzu.

const compression = require("compression");
const helmet = require("helmet");
const RateLimit = require("express-rate-limit");

const app = express();

// Set up rate limiter: maximum of twenty requests per minute
const limiter = RateLimit({
  windowMs: 1 * 60 * 1000, // 1 minute
  max: 20,
});
// Apply rate limiter to all requests
app.use(limiter);

// …

Der obige Befehl begrenzt alle Anfragen auf 20 pro Minute (Sie können dies nach Bedarf ändern).

Node-Version festlegen

Für Node-Anwendungen, einschließlich Express, enthält die package.json Datei alles, was ein Hosting-Anbieter benötigt, um die Abhängigkeiten der Anwendung und die Startdatei zu ermitteln.

Die einzige wichtige Information, die in unserer aktuellen package.json fehlt, ist die Version von Node, die von der Bibliothek benötigt wird. Sie können die Version von Node, die für die Entwicklung verwendet wurde, abrufen, indem Sie den folgenden Befehl eingeben:

>node --version
v16.17.1

Öffnen Sie package.json und fügen Sie diese Information als engines > node hinzu, wie gezeigt (unter Verwendung der Versionsnummer für Ihr System).

{
  "engines": {
    "node": ">=22.0.0"
  }
}

Der Hosting-Dienst unterstützt möglicherweise nicht die spezifisch angegebene Version von Node, aber diese Änderung sollte sicherstellen, dass versucht wird, eine Version mit derselben Hauptversionsnummer oder einer aktuelleren Version zu verwenden.

Beachten Sie, dass es bei verschiedenen Hosting-Diensten andere Möglichkeiten gibt, die Node-Version anzugeben, aber der package.json Ansatz ist weithin unterstützt.

Abhängigkeiten abrufen und erneut testen

Bevor wir weitermachen, lassen Sie uns die Site erneut testen und sicherstellen, dass sie durch keine unserer Änderungen beeinflusst wurde.

Zuerst müssen wir unsere Abhängigkeiten abrufen. Sie können dies tun, indem Sie den folgenden Befehl in Ihrem Terminal am Stamm des Projekts ausführen:

npm install

Führen Sie nun die Site aus (siehe Testen der Routen für die relevanten Befehle) und überprüfen Sie, ob sich die Site weiterhin wie erwartet verhält.

Erstellen eines Anwendungsrepositorys auf GitHub

Viele Hosting-Dienste ermöglichen es Ihnen, Projekte aus einem lokalen Repository oder von cloudbasierten Quellversionskontrollplattformen zu importieren und/oder zu synchronisieren. Dies kann die Bereitstellung und die iterative Entwicklung erheblich erleichtern.

Für dieses Tutorial richten wir ein GitHub Konto und Repository für die Bibliothek ein und verwenden das git Tool, um unseren Quellcode hochzuladen.

Die Schritte sind:

1. Besuchen Sie https://github.com/ und erstellen Sie ein Konto.

2. Sobald Sie eingeloggt sind, klicken Sie auf den + Link in der oberen Symbolleiste und wählen Sie Neues Repository.

3. Füllen Sie alle Felder in diesem Formular aus. Auch wenn diese nicht zwingend erforderlich sind, werden sie dringend empfohlen.

   • Geben Sie einen neuen Repository-Namen ein (z.B. express-locallibrary-tutorial) und eine Beschreibung (z.B. "Local Library Website geschrieben in Express").
   • Wählen Sie Node in der Add .gitignore Auswahlliste.
   • Wählen Sie Ihre bevorzugte Lizenz in der Add license Auswahlliste.
   • Aktivieren Sie Repository mit einer README erstellen.

   Warnung: Der Standardzugriff "Öffentlich" macht den gesamten Quellcode - einschließlich Ihren Datenbank-Benutzernamen und Passwort - für jeden im Internet sichtbar! Stellen Sie sicher, dass der Quellcode nur Anmeldeinformationen aus Umgebungsvariablen liest und keine Anmeldeinformationen hartcodiert sind.

   Andernfalls wählen Sie die Option "Privat" aus, um nur ausgewählte Personen den Quellcode sehen zu lassen.

4. Drücken Sie Repository erstellen.

5. Klicken Sie auf die grüne Clone or download-Schaltfläche auf Ihrer neuen Repo-Seite.

6. Kopieren Sie den URL-Wert aus dem Textfeld im Dialogfeld, das erscheint. Wenn Sie den Repositories-Namen "express-locallibrary-tutorial" verwendet haben, sollte die URL in etwa so aussehen: https://github.com/<Ihr_git_benutzername>/express-locallibrary-tutorial.git.

Da das Repository ("Repo") jetzt auf GitHub erstellt wurde, möchten wir es auf unseren lokalen Computer klonen (kopieren):

1. Installieren Sie git für Ihren lokalen Computer (offizielle Git-Download-Anleitung).

2. Öffnen Sie ein Eingabeaufforderungs-/Terminalfenster und klonen Sie Ihr Repo mit der oben kopierten URL:

   bash

   git clone https://github.com/<your_git_user_id>/express-locallibrary-tutorial.git
   

   Dies erstellt das Repository im aktuellen Verzeichnis.

3. Navigieren Sie in den Repo-Ordner.

   bash

   cd express-locallibrary-tutorial
   

Kopieren Sie dann Ihre Anwendung-Quelldateien in den Repo-Ordner, machen Sie sie mit git zu einem Teil des Repos und laden Sie sie auf GitHub hoch:

1. Kopieren Sie Ihre Express-Anwendung in diesen Ordner (mit Ausnahme von /node_modules, das Abhängigkeitsdateien enthält, die bei Bedarf von npm abgerufen werden sollten).

2. Öffnen Sie ein Eingabeaufforderungs-/Terminalfenster und verwenden Sie den add-Befehl, um alle Dateien zu git hinzuzufügen.

   bash

   git add -A
   

3. Verwenden Sie den status-Befehl, um zu überprüfen, ob alle Dateien, die Sie commit möchten, korrekt sind (Sie möchten Quellcode-Dateien einbeziehen, keine Binärdateien, temporären Dateien usw.). Es sollte in etwa so aussehen wie die untenstehende Liste.

   bash

   git status
   

   On branch main
   Your branch is up-to-date with 'origin/main'.
   Changes to be committed:
     (use "git reset HEAD <file>..." to unstage)
   
           new file:   ...
   

4. Wenn Sie zufrieden sind, commit Sie die Dateien in Ihr lokales Repo. Dies ist gleichbedeutend mit der Unterzeichnung der Änderungen und macht sie zu einem offiziellen Teil des lokalen Repos.

   bash

   git commit -m "First version of application moved into GitHub"
   

5. Zu diesem Zeitpunkt wurde das Remote-Repo nicht geändert. Der letzte Schritt besteht darin, Ihr lokales Repo mit dem folgenden Befehl in das Remote GitHub Repo zu synchronisieren (push):

   bash

   git push origin main
   

Wenn dieser Vorgang abgeschlossen ist, sollten Sie zur Seite auf GitHub zurückkehren können, auf der Sie Ihr Repo erstellt haben, die Seite aktualisieren und sehen, dass Ihre gesamte Anwendung jetzt hochgeladen wurde. Sie können Ihr Repo weiterhin aktualisieren, während sich Dateien ändern, indem Sie diesen add/commit/push-Zyklus verwenden.

Dies ist ein guter Zeitpunkt, um ein Backup Ihres "Vanilla"-Projekts zu erstellen - während einige der Änderungen, die wir in den folgenden Abschnitten vornehmen werden, für die Bereitstellung bei jedem Hosting-Dienst nützlich sein könnten (oder für die Entwicklung) andere möglicherweise nicht. Sie können dies mit git in der Befehlszeile tun:

# Create branch vanilla_deployment from the current branch (main)
git checkout -b vanilla_deployment

# Push the new branch to GitHub
git push origin vanilla_deployment

# Switch back to main
git checkout main

# Make any further changes in a new branch
git pull upstream main # Merge the latest changes from GitHub
git checkout -b my_changes # Create a new branch

Beispiel: Hosting auf Railway

Dieser Abschnitt bietet eine praktische Demonstration, wie man LocalLibrary auf Railway installiert.

Warum Railway?

Railway ist eine attraktive Hosting-Option aus mehreren Gründen:

• Railway kümmert sich um die meiste Infrastruktur, sodass Sie dies nicht tun müssen. Dadurch, dass Sie sich nicht um Server, Load Balancer, Reverse Proxies usw. kümmern müssen, wird es viel einfacher, loszulegen.
• Railway hat einen Fokus auf Entwicklererfahrung für Entwicklung und Bereitstellung, die zu einer schnelleren und sanfteren Lernkurve als viele andere Alternativen führt.
• Die Fähigkeiten und Konzepte, die Sie beim Einsatz von Railway erwerben, sind übertragbar. Während Railway einige ausgezeichnete neue Funktionen hat, verwenden andere beliebte Hosting-Dienste viele derselben Ideen und Ansätze.
• Railway-Dokumentation ist klar und vollständig.
• Es hat eine vergleichsweise preiswerte Hobby Tier.
• Der Service scheint sehr zuverlässig zu sein. Wenn Sie ihn letztendlich lieben, sind die Preise vorhersehbar und das Skalieren Ihrer App ist sehr einfach.

Sie sollten sich die Zeit nehmen, um zu bestimmen, ob Railway für Ihre eigene Website geeignet ist.

Wie funktioniert Railway?

Webanwendungen werden jeweils in ihrem eigenen isolierten und unabhängigen virtualisierten Container ausgeführt. Um Ihre Anwendung auszuführen, muss Railway in der Lage sein, die entsprechende Umgebung und Abhängigkeiten einzurichten und außerdem zu verstehen, wie sie gestartet wird.

Railway macht das einfach, da es viele verschiedene Webanwendungs-Frameworks und -Umgebungen basierend auf ihrer Verwendung gemeinsamer Konventionen automatisch erkennen und installieren kann. Zum Beispiel erkennt Railway Node-Anwendungen daran, dass sie eine package.json Datei haben, und kann den verwendeten Paketmanager für das Builden anhand der "Lock"-Datei ermitteln. Zum Beispiel, wenn die Anwendung die Datei package-lock.json enthält, weiß Railway, dass npm verwendet wird, um die Pakete zu installieren, während es bei Vorhandensein von yarn.lock weiß, dass yarn verwendet wird. Nachdem alle Abhängigkeiten installiert sind, sucht Railway nach Skripten namens "build" und "start" in der Package-Datei und verwendet diese, um den Code zu erstellen und auszuführen.

Sobald die Anwendung läuft, kann sie sich selbst mit den in Umgebungsvariablen bereitgestellten Informationen konfigurieren. Zum Beispiel muss eine Anwendung, die eine Datenbank verwendet, die Adresse über eine Variable erhalten. Der Datenbankdienst selbst kann von Railway oder einem anderen Anbieter gehostet werden.

Entwickler interagieren mit Railway über die Railway-Seite und ein spezielles Command Line Interface (CLI) Tool. Die CLI ermöglicht es Ihnen, ein lokales GitHub-Repository mit einem Railway-Projekt zu verknüpfen, das Repository vom lokalen Zweig auf die Live-Site hochzuladen, die Protokolle des laufenden Prozesses zu inspizieren, Konfigurationsvariablen zu setzen und abzurufen und vieles mehr. Eine der nützlichsten Funktionen ist, dass Sie die CLI verwenden können, um Ihr lokales Projekt mit denselben Umgebungsvariablen wie das Live-Projekt auszuführen.

Das ist alles, was Sie wissen müssen, um die App auf Railway bereitzustellen. Weiter geht es mit der Einrichtung eines Railway-Kontos, der Installation unserer Website und einer Datenbank sowie dem Ausprobieren des Railway-Clients.

Erstellen eines Railway-Kontos

Um Railway zu nutzen, müssen Sie zunächst ein Konto erstellen:

• Gehen Sie zu railway.com und klicken Sie auf den Login-Link in der oberen Symbolleiste.
• Wählen Sie GitHub im Popup, um sich mit Ihren GitHub-Anmeldedaten anzumelden.
• Möglicherweise müssen Sie dann Ihr Konto per E-Mail verifizieren.
• Sie werden dann im Railway.com Dashboard angemeldet: https://railway.com/dashboard.

Bereitstellung auf Railway von GitHub

Als nächstes werden wir Railway einrichten, um unsere Bibliothek von GitHub bereitzustellen. Wählen Sie zunächst die Dashboard-Option aus dem oberen Menü der Seite aus und klicken Sie dann auf die New Project-Schaltfläche:

Railway zeigt eine Liste mit Optionen für das neue Projekt an, einschließlich der Möglichkeit, ein Projekt aus einer Vorlage bereitzustellen, die zuerst in Ihrem GitHub-Konto erstellt wird, und mehreren Datenbanken. Wählen Sie Deploy from GitHub repo aus.

Alle Projekte in den GitHub-Repos, die Sie mit Railway während der Einrichtung geteilt haben, werden angezeigt. Wählen Sie Ihr GitHub-Repository für die lokale Bibliothek: <benutzer-name>/express-locallibrary-tutorial.

Bestätigen Sie Ihre Bereitstellung, indem Sie Deploy Now auswählen.

Railway lädt dann Ihr Projekt und bereitstellt es, wobei der Fortschritt auf der Registerkarte bereithalten angezeigt wird. Wenn die Bereitstellung erfolgreich abgeschlossen ist, sehen Sie einen Bildschirm wie den untenstehenden.

Wählen Sie nun die Registerkarte Settings aus, scrollen Sie nach unten zum Abschnitt Domains und drücken Sie die Generate Domain-Schaltfläche.

Dies veröffentlicht die Seite und stellt die Domain anstelle der Schaltfläche bereit, wie unten gezeigt.

Wählen Sie die Domain-URL aus, um Ihre Bibliotheksanwendung zu öffnen. Beachten Sie, dass wir aufgrund der Tatsache, dass wir keine Produktionsdatenbank angegeben haben, wird unsere Bibliothek die Entwicklungsdaten verwenden.

Bereitstellung und Verbindung einer MongoDB-Datenbank

Anstelle unserer Entwicklungsdaten erstellen wir jetzt die Produktions-MongoDB-Datenbank, die stattdessen verwendet wird. Wir werden die Datenbank als Teil des Railway-Anwendungsprojekts erstellen, obwohl es nichts gibt, das Sie daran hindert, sie in einem eigenen separaten Projekt zu erstellen, oder sogar eine MongoDB Atlas Datenbank für Produktionsdaten zu verwenden, genauso wie Sie es für die Entwicklungsdatenbank getan haben.

Wählen Sie auf Railway die Dashboard-Option aus dem oberen Menü der Seite aus und wählen Sie dann Ihr Anwendungsprojekt aus. Zu diesem Zeitpunkt enthält es nur einen einzigen Dienst für Ihre Anwendung (dies kann ausgewählt werden, um Variablen und andere Details des Dienstes festzulegen). Wählen Sie die New-Schaltfläche, die verwendet wird, um Dienste zum aktuellen Projekt hinzuzufügen.

Wählen Sie Database, wenn Sie aufgefordert werden, die Art des hinzuzufügenden Dienstes anzugeben:

Wählen Sie dann Add MongoDB, um die Datenbank hinzuzufügen.

Railway wird dann einen Dienst mit einer leeren Datenbank im selben Projekt bereitstellen. Nach Abschluss sehen Sie nun sowohl die Anwendungs- als auch die Datenbankdienste in der Projektansicht.

Wählen Sie den MongoDB-Dienst aus, um Informationen über die Datenbank anzuzeigen. Öffnen Sie die Variables Registerkarte und kopieren Sie die "Mongo_URL" (dies ist die Adresse der Datenbank).

Um dies für die Bibliotheksanwendung zugänglich zu machen, müssen wir es mit einer Umgebungsvariablen zum Anwendungsprozess hinzufügen. Öffnen Sie zuerst den Anwendungsdienst. Wählen Sie dann die Variables Registerkarte und drücken Sie die New Variable-Schaltfläche.

Geben Sie den Variablennamen MONGODB_URI und die von Ihnen kopierte Verbindungs-URL für die Datenbank ein (MONGODB_URI ist der Name der Umgebungsvariable, aus der wir die Anwendung konfiguriert haben, um die Datenbankadresse zu lesen). Dies sieht in etwa aus wie der unten gezeigte Bildschirm.

Drücken Sie Add, um die Variable hinzuzufügen.

Railway startet Ihre App neu, wenn es Variablen aktualisiert. Wenn Sie nun die Startseite überprüfen, sollte sie Nullwerte für Ihre Objektanzahlen anzeigen, da die oben genannten Änderungen bedeuten, dass wir jetzt eine neue (leere) Datenbank verwenden.

Weitere Konfigurationsvariablen

Sie erinnern sich aus einem vorherigen Abschnitt, dass wir in der Lage sein müssen, die NODE_ENV auf 'production' zu setzen, um die Leistung zu verbessern und weniger ausführliche Fehlermeldungen zu erzeugen. Wir können dies im selben Bildschirm tun, in dem wir die MONGODB_URI-Variable festgelegt haben.

Öffnen Sie den Anwendungsdienst. Wählen Sie dann die Variables Registerkarte, wo Sie sehen werden, dass MONGODB_URI bereits definiert ist, und drücken Sie die New Variable-Schaltfläche.

Geben Sie NODE_ENV als Name der neuen Variable und production als Name der Umgebung ein. Drücken Sie dann die Add-Schaltfläche.

Die Local Library-Anwendung ist nun eingerichtet und für die Produktionsnutzung konfiguriert. Sie können Daten über die Benutzeroberfläche der Website hinzufügen und sie sollte auf die gleiche Weise funktionieren wie während der Entwicklung (wenn auch mit weniger Debug-Informationen für ungültige Seiten).

Client installieren

Laden Sie den Railway-Client für Ihr lokales Betriebssystem herunter und installieren Sie ihn, indem Sie den Anweisungen hier folgen.

Nachdem der Client installiert ist, können Sie Befehle ausführen. Einige der wichtigsten Operationen umfassen die Bereitstellung des aktuellen Verzeichnisses Ihres Computers für ein zugeordnetes Railway-Projekt (ohne auf GitHub hochladen zu müssen) und die Ausführung Ihres Projekts lokal mit den gleichen Einstellungen wie Sie auf dem Produktionsserver haben.

Sie können eine Liste aller möglichen Befehle erhalten, indem Sie den folgenden in ein Terminal eingeben.

railway help

Fehlerbehebung

Der Railway-Client stellt den Protokollbefehl bereit, um den Tail der Protokolle anzuzeigen (ein vollständigeres Protokoll steht auf der Seite für jedes Projekt zur Verfügung):

railway logs

Zusammenfassung

Dies ist das Ende dieses Tutorials zur Einrichtung von Express-Apps in der Produktion und auch die Serie von Tutorials zur Arbeit mit Express. Wir hoffen, dass Sie sie nützlich fanden. Sie können sich eine vollständig durchgearbeitete Version des Quellcodes hier auf GitHub ansehen.

Siehe auch

• Produktion Bestehende Praktiken: Leistung und Zuverlässigkeit (Express-Dokumentation)

• Produktion Bestehende Praktiken: Sicherheit (Express-Dokumentation)

• Railway Docs

  • CLI

• DigitalOcean

  • Express Tutorials
  • Node.js Tutorials

• Heroku

  • Erste Schritte auf Heroku mit Node.js (Heroku-Dokumentation)
  • Bereitstellen von Node.js-Anwendungen auf Heroku (Heroku-Dokumentation)
  • Heroku Node.js-Unterstützung (Heroku-Dokumentation)
  • Optimieren der Node.js-Anwendungskonkurrenz (Heroku-Dokumentation)
  • Wie Heroku arbeitet (Heroku-Dokumentation)
  • Dynos und der Dyno Manager (Heroku-Dokumentation)
  • Konfiguration und Konfigurationsvariablen (Heroku-Dokumentation)
  • Limits (Heroku-Dokumentation)

• Zurück
• Übersicht: Express Web-Framework (Node.js/JavaScript)