Express-Tutorial Teil 7: Bereitstellung in der Produktion

Überblick

Sobald Ihre Website fertig ist (oder "fertig genug" für den öffentlichen Test), 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 genutzt, um Ihre Website im lokalen Browser/Netzwerk zu teilen, 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 zunächst:

• Eine Umgebung für das Hosting der Express-App wählen.
• Einige Änderungen an Ihren Projekteinstellungen vornehmen.
• Eine Infrastrukturebene für die Produktion einrichten, um Ihre Website bereitzustellen.

Dieses Tutorial bietet einige Leitlinien zu Ihren Optionen für die Auswahl einer Hosting-Site, einen kurzen Überblick darüber, was Sie tun müssen, um Ihre Express-App für die Produktion vorzubereiten, und ein funktionierendes Beispiel, wie man die LocalLibrary-Website auf dem Railway Cloud-Hosting-Dienst installiert.

Was ist eine Produktionsumgebung?

Die Produktionsumgebung ist die Umgebung, die von dem Servercomputer bereitgestellt wird, auf dem Sie Ihre Website für die externe Nutzung betreiben. Die Umgebung umfasst:

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

Der Servercomputer könnte sich auf Ihrem Gelände befinden und über eine schnelle Leitung mit dem Internet verbunden sein, aber es ist weitaus üblicher, einen Computer zu verwenden, der "in der Cloud" gehostet wird. Das bedeutet im Wesentlichen, dass Ihr Code auf einem entfernten Computer (oder möglicherweise einem "virtuellen" Computer) in den Rechenzentren des Hosting-Unternehmens ausgeführt wird. Der entfernte Server bietet in der Regel ein garantiertes Maß an Computing-Ressourcen (z. B. CPU, RAM, Speicherplatz usw.) und Internetverbindung zu einem bestimmten Preis.

Solche aus der Ferne zugänglichen Computer- und Netzwerk-Hardware werden als Infrastructure as a Service (IaaS) bezeichnet. Viele IaaS-Anbieter bieten Optionen, ein bestimmtes Betriebssystem vorzuinstallieren, auf das Sie dann die anderen Komponenten Ihrer Produktionsumgebung installieren müssen. Andere Anbieter ermöglichen Ihnen die Auswahl voll ausgestatteterer Umgebungen, die möglicherweise ein komplettes Node-Setup umfassen.

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

Einige Entwickler bevorzugen die Flexibilität, die IaaS im Vergleich zu PaaS bietet, während andere den geringeren Wartungsaufwand und den geringeren Aufwand für Skalierung von PaaS schätzen. Wenn Sie gerade erst anfangen, ist die Einrichtung Ihrer Website auf einem PaaS-System viel einfacher, daher werden wir das in diesem Tutorial tun.

Auswahl eines Hosting-Anbieters

Es gibt zahlreiche Hosting-Anbieter, die bekannt dafür sind, entweder aktiv Unterstützung für oder gut mit Node (und Express) zusammenzuarbeiten. Diese Anbieter bieten verschiedene Arten von Umgebungen (IaaS, PaaS) und verschiedene Ebenen von Rechen- und Netzwerkressourcen zu unterschiedlichen Preisen.

Einige der Dinge, die zu berücksichtigen sind, wenn Sie einen Host auswählen:

• Wie viel Verkehr Ihre Seite voraussichtlich haben wird und die Kosten für die Daten- und Computerressourcen, die zur Deckung dieses Bedarfs erforderlich sind.
• Die Unterstützungsebene für das horizontale (Hinzufügen weiterer Maschinen) und vertikale (Upgrade auf leistungsfähigere Maschinen) Skalieren und die Kosten dafür.
• Die Standorte, an denen der Anbieter Rechenzentren hat und wo der Zugriff daher am schnellsten sein dürfte.
• Die historische Betriebszeit und Ausfallzeiten des Hosts.
• Bereitgestellte Tools zur Verwaltung der Seite – sind sie einfach zu verwenden und sicher (z. B. SFTP vs. FTP).
• Integrierte Frameworks zur Überwachung Ihres Servers.
• Bekannte Einschränkungen. Einige Hosts blockieren absichtlich bestimmte Dienste (z. B. E-Mail). Andere bieten in einigen Preiskategorien nur eine bestimmte Anzahl von Stunden "Live-Zeit" oder nur eine kleine Menge an Speicher.
• Zusätzliche Vorteile. Einige Anbieter bieten kostenlose Domainnamen und Unterstützung für TLS-Zertifikate, die Sie sonst bezahlen müssten.
• Ob die von Ihnen genutzte "kostenlose" Stufe im Laufe der Zeit abläuft und ob die Kosten für den Umzug in eine teurere Stufe bedeuten, dass Sie besser dran gewesen wären, von Anfang an einen anderen Dienst zu nutzen.

Die gute Nachricht, wenn Sie anfangen, ist, dass es viele Websites gibt, die "kostenlose" Computerumgebungen anbieten, die für Bewertung und Tests gedacht sind. Diese sind in der Regel ziemlich ressourcenbeschränkte/limitierte Umgebungen, und man muss sich bewusst sein, dass sie möglicherweise nach einer bestimmten Einführungszeit ablaufen oder andere Einschränkungen haben. Sie sind jedoch großartig für das Testen von Websites mit geringem Traffic in einer gehosteten Umgebung und können einen einfachen Übergang zum Bezahlen für mehr Ressourcen bieten, wenn Ihr Website-Verkehr zunimmt. 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 Computing-Power mit weniger Einschränkungen bietet. Railway, Heroku, und DigitalOcean sind Beispiele populärer Hosting-Anbieter, die eine relativ günstige grundlegende Computerkategorie haben (im Bereich von 5 bis 10 USD pro Monat).

Vorbereitung Ihrer Website zur Veröffentlichung

Die Hauptpunkte, die Sie bei der Veröffentlichung Ihrer Website berücksichtigen sollten, sind Web-Sicherheit und Leistung. Mindestens sollten Sie die Datenbankkonfiguration ändern, damit Sie eine andere Datenbank für die Produktion verwenden können und deren Anmeldeinformationen sichern, die Stack-Traces entfernen, die während der Entwicklung auf Fehlerseiten angezeigt werden, Ihre Protokollierung aufräumen und die entsprechenden Header setzen, um viele gängige Sicherheitsbedrohungen zu vermeiden.

In den folgenden Unterabschnitten skizzieren 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 Anmeldedaten im bin/www hartcodiert waren. Da die Entwicklungsdatenbank keine Informationen enthält, deren Preisgabe oder Beschädigung wir befürchten, besteht kein besonderes Risiko beim Leaken dieser Details. Wenn Sie jedoch mit realen Daten arbeiten, insbesondere persönlichen Benutzerinformationen, ist es sehr wichtig, Ihre Datenbank-Anmeldeinformationen zu schützen.

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

Wenn Ihr Hosting-Anbieter die Einrichtung von Umgebungsvariablen über eine Weboberfläche unterstützt (wie dies bei vielen der Fall ist), besteht eine Möglichkeit darin, den Server die Datenbank-URL aus einer Umgebungsvariable beziehen zu lassen. Unten modifizieren wir die LocalLibrary-Website, um die Datenbank-URI von einer Betriebssystem-Umgebungsvariablen zu bekommen, falls diese definiert wurde, und ansonsten die Entwicklungsdatenbank-URL zu verwenden.

Öffnen Sie bin.www und suchen Sie die Zeile, die die MongoDB-Verbindungsvariable setzt. Sie wird etwa so aussehen:

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 namens MONGODB_URI abzurufen, falls sie 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 Sie NODE_ENV auf 'production'

Wir können Stack-Trace-Anzeigen auf Fehlerseiten entfernen, indem wir die NODE_ENV-Umgebungsvariable auf production setzen (sie ist standardmäßig auf 'development' gesetzt). Zusätzlich zum Generieren weniger ausführlicher Fehlermeldungen cacht das Setzen der Variable auf production Ansichts-Templates und CSS-Dateien, die aus CSS-Erweiterungen generiert wurden. Tests zeigen, dass das Setzen von NODE_ENV auf production die App-Leistung um den Faktor drei verbessern kann!

Diese Änderung kann entweder mit export, einer Umgebungsdatei oder dem OS-Initialisierungssystem vorgenommen werden.

Protokollieren Sie entsprechend

Protokollaufrufe können sich auf eine stark frequentierte Website auswirken. In einer Produktionsumgebung müssen Sie möglicherweise Website-Aktivitäten protokollieren (z. B. den Verkehr verfolgen oder API-Aufrufe protokollieren), sollten aber versuchen, die Menge an Protokollierung, die zu Debug-Zwecken hinzugefügt wurde, zu minimieren.

Eine Möglichkeit, die "Debug"-Protokollierung in der Produktion zu minimieren, besteht darin, ein Modul wie debug zu verwenden, das Ihnen erlaubt, die durchgeführte Protokollierung durch Setzen einer Umgebungsvariablen zu steuern. Zum Beispiel zeigt das untenstehende Codefragment, wie Sie "author"-Logging einrichten könnten. Die debug-Variable wird mit dem Namen 'author' deklariert, und der Präfix "author" wird automatisch für alle Logs von 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 ein bestimmtes Set von Logs aktivieren, indem Sie sie als kommagetrennte Liste in der DEBUG-Umgebungsvariablen angeben. Sie können die Variablen für das Anzeigen von Autor- und Buch-Logs wie gezeigt festlegen (auch Wildcards werden 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: Produktions-Best-Practices: Leistung und Zuverlässigkeit.

Verwenden Sie gzip/deflate-Kompression für Antworten

Webserver können oft die HTTP-Antwort komprimieren, die an einen Client gesendet wird, wodurch die Zeit, die der Client benötigt, um die Seite zu erhalten und zu laden, erheblich reduziert wird. Die verwendete Kompressionsmethode hängt von den Dekompressionsmethoden ab, die der Client in der Anfrage angibt, dass er sie unterstützt (die Antwort wird unkomprimiert gesendet, wenn keine Kompressionsmethoden unterstützt werden).

Fügen Sie dies zu Ihrer Site hinzu, indem Sie compression Middleware verwenden. 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 Kompressionsbibliothek wie gezeigt ein. Fügen Sie die Kompressionsbibliothek mit der use()-Methode zur Mittelwarenkette 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 Sie Helmet, um vor bekannten Schwachstellen zu schützen

Helmet ist ein Middleware-Paket. Es kann geeignete HTTP-Header setzen, die Ihre App vor bekannten Web-Schwachstellen schützen (siehe die Dokumentation für weitere Informationen, welche Header es setzt und welche Schwachstellen es schützt).

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

npm install helmet

Öffnen Sie ./app.js und binden Sie die helmet-Bibliothek wie gezeigt ein. 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 den Subset der sicherheitsrelevanten Header hinzuzufügen, die für die meisten Sites sinnvoll sind. Im LocalLibrary-Base-Template enthalten wir jedoch einige Bootstrap-Skripte. Diese verletzen die default Content Security Policy (CSP) von helmet, die das Laden von Skripten über Querverweise nicht erlaubt. Um das Laden dieser Skripte zu ermöglichen, modifizieren wir die Helmet-Konfiguration so, dass sie CSP-Direktiven setzt, um das Laden von Skripten aus den angegebenen Domänen zu ermöglichen. Für Ihren eigenen Server können Sie spezifische Header nach Bedarf hinzufügen/deaktivieren, indem Sie den Anweisungen zur Verwendung von helmet hier folgen.

Fügen Sie Ratenbegrenzung zu den API-Routen hinzu

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 zu viele Anfragen an Ihre Seite gestellt werden könnten, wie z. B. Denial of Service-Angriffe, Brute-Force-Angriffe oder sogar nur ein Client oder Skript, das nicht wie erwartet funktioniert. Abgesehen von Leistungsproblemen, die durch zu viele Anfragen entstehen können, die dazu führen, dass Ihr Server langsamer läuft, können Ihnen auch Gebühren für den zusätzlichen Traffic berechnet werden. Dieses Paket kann verwendet werden, um die Anzahl der Anfragen zu begrenzen, die an eine bestimmte Route oder einen Satz von Routen gestellt werden können.

Installieren Sie dies 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 wie gezeigt ein. 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).

Setzen Sie die Node-Version

Bei 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 Einstiegspunktdatei zu erkennen.

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

>node --version
v16.17.1

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

{
  "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 er eine Version mit derselben Hauptversionsnummer oder einer neueren Version verwendet.

Beachten Sie, dass es andere Möglichkeiten geben kann, die Node-Version auf verschiedenen Hosting-Diensten anzugeben, aber der package.json-Ansatz wird weitgehend unterstützt.

Abhängigkeiten abrufen und erneut testen

Bevor wir fortfahren, testen wir die Site erneut und stellen sicher, dass sie nicht von unseren Änderungen betroffen war.

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

npm install

Nun führen Sie die Site aus (siehe Testing the routes für die relevanten Befehle) und prüfen Sie, ob die Site sich noch wie erwartet verhält.

Einrichten eines Anwendung-Repositories in GitHub

Viele Hosting-Dienste ermöglichen es Ihnen, Projekte aus einem lokalen Repository oder von cloudbasierten Quellcode-Versionskontrollplattformen zu importieren und/oder zu synchronisieren. Dies kann die Bereitstellung und 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. Wenn 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 verpflichtend sind, werden sie dringend empfohlen.

   • Geben Sie einen neuen Repositories-Namen ein (z. B. express-locallibrary-tutorial), und eine Beschreibung (wie "Local Library website written in Express").
   • Wählen Sie Node im Add .gitignore-Auswahlliste.
   • Wählen Sie Ihre bevorzugte Lizenz im Add license-Auswahlliste.
   • Aktivieren Sie Initialize this repository with a README.

   Warnung: Der Standardzugriff "Öffentlich" macht alle Quellcodes – einschließlich Ihrer Datenbank-Benutzernamen und -Passwörter – für jeden im Internet sichtbar! Stellen Sie sicher, dass der Quellcode Anmeldeinformationen nur aus Umgebungsvariablen liest und keine fest codierten Anmeldeinformationen enthält.

   Wählen Sie andernfalls die "Privat"-Option, um nur ausgewählten Personen den Zugriff auf den Quellcode zu erlauben.

4. Drücken Sie Repository erstellen.

5. Klicken Sie auf die grüne Schaltfläche Klonen oder herunterladen auf Ihrer neuen Repo-Seite.

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

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

1. Installieren Sie git für Ihren lokalen Computer (official Git download guide).

2. Öffnen Sie ein Befehlszeilen-/Terminal 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. Wechseln Sie in den Repo-Ordner.

   bash

   cd express-locallibrary-tutorial
   

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

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

2. Öffnen Sie ein Befehlszeilen-/Terminal 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 wollen Quellcodedateien und keine Binärdateien, temporären Dateien usw. einschließen). Es sollte in etwa so aussehen wie die unten stehende Auflistung.

   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 die Dateien in Ihrem lokalen Repo. Dies entspricht dem Unterzeichnen der Änderungen und dem offiziellen Teil des lokalen Repos machen.

   bash

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

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

   bash

   git push origin main
   

Wenn dieser Vorgang abgeschlossen ist, sollten Sie in der Lage sein, zur Seite auf GitHub zu gehen, auf der Sie Ihr Repo erstellt haben, die Seite zu aktualisieren und zu sehen, dass Ihre gesamte Anwendung jetzt hochgeladen wurde. Sie können Ihr Repo weiterhin aktualisieren, indem Sie diesen Zusatz-/Commit-/Push-Zyklus verwenden, wenn sich Dateien ändern.

Dies ist ein guter Zeitpunkt, eine Sicherung Ihres "Vanilla"-Projekts zu erstellen – während einige der Änderungen, die wir in den folgenden Abschnitten vornehmen, nützlich für die Bereitstellung auf jedem Hosting-Dienst (oder für die Entwicklung) sind, 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 den größten Teil der Infrastruktur, sodass Sie dies nicht tun müssen. Sich nicht um Server, Load Balancer, Reverse Proxies usw. kümmern zu müssen, macht den Einstieg viel einfacher.
• Railway konzentriert sich auf die Entwicklererfahrung für Entwicklung und Bereitstellung, was zu einer schnelleren und sanfteren Lernkurve führt als viele andere Alternativen.
• Die Fähigkeiten und Konzepte, die Sie beim Verwenden von Railway lernen, sind übertragbar. Während Railway einige ausgezeichnete neue Funktionen hat, verwenden viele andere beliebte Hosting-Dienste dieselben Ideen und Ansätze.
• Die Dokumentation von Railway ist klar und vollständig.
• Es hat einen vergleichsweise kostengünstigen Hobby-Tarif.
• Der Service scheint sehr zuverlässig zu sein, und wenn Sie ihn schätzen lernen, sind die Preise vorhersehbar, und das Hochskalieren Ihrer App ist sehr einfach.

Sie sollten sich die Zeit nehmen, um festzustellen, 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 die geeignete Umgebung und die Abhängigkeiten einrichten können und auch verstehen, wie sie gestartet wird.

Railway macht dies einfach, indem es viele verschiedene Webanwendungs-Frameworks und -Umgebungen basierend auf deren Verwendung von "generischen Konventionen" automatisch erkennen und installieren kann. Zum Beispiel erkennt Railway Node-Anwendungen, weil sie eine package.json-Datei haben, und kann den verwendeten Paketmanager für den Build anhand der "Lock"-Datei bestimmen. Zum Beispiel, wenn die Anwendung die Datei package-lock.json enthält, weiß Railway, dass es npm verwenden sollte, um die Pakete zu installieren, während es, wenn es yarn.lock findet, weiß, dass yarn verwendet werden soll. Nachdem alle Abhängigkeiten installiert wurden, sucht Railway nach Skripten namens "build" und "start" in der Paketdatei und verwendet diese, um den Code zu erstellen und auszuführen.

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

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

Das ist alles, was Sie brauchen, um die App bei Railway bereitzustellen. Als nächstes werden wir ein Railway-Konto einrichten, unsere Website und eine Datenbank installieren und den Railway-Client ausprobieren.

Ein Railway-Konto einrichten

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 aus, um sich mit Ihren GitHub-Anmeldedaten anzumelden.
• Es kann sein, dass Sie dann zu Ihrem E-Mail-Postfach gehen und Ihr Konto verifizieren müssen.
• Danach sind Sie im Railway.com-Dashboard eingeloggt: https://railway.com/dashboard.

Bereitstellung auf Railway von GitHub

Als nächstes richten wir Railway so ein, dass es unsere Bibliothek von GitHub bereitstellt. Wählen Sie zunächst die Dashboard-Option aus dem oberen Menü der Website und klicken Sie dann auf die Schaltfläche Neues Projekt:

Railway zeigt eine Liste von Optionen für das neue Projekt an, einschließlich der Möglichkeit, ein Projekt aus einer Vorlage zu erstellen, die zuerst in Ihrem GitHub-Konto erstellt wurde, und einer Reihe von Datenbanken. Wählen Sie Von GitHub-Repo bereitstellen.

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

Bestätigen Sie Ihre Bereitstellung, indem Sie Jetzt bereitstellen auswählen.

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

Wählen Sie nun den Einstellungen-Tab aus, scrollen Sie nach unten zum Abschnitt Domains und drücken Sie die Schaltfläche Domain generieren.

Dadurch wird die Site veröffentlicht und die Domain anstelle der Schaltfläche bereitgestellt, wie unten dargestellt.

Wählen Sie die Domain-URL aus, um Ihre Bibliotheksanwendung zu öffnen. Da wir keine Produktionsdatenbank angegeben haben, wird die lokale Bibliothek mit den Entwicklungsdaten geöffnet.

Eine MongoDB-Datenbank bereitstellen und verbinden

Erstellen wir nun anstelle der Entwicklungsdaten eine Produktions-MongoDB-Datenbank, die verwendet werden soll. Wir werden die Datenbank als Teil des Railway-Anwendungsprojekts erstellen, obwohl nichts dagegen spricht, sie in einem eigenen separaten Projekt zu erstellen oder eine MongoDB Atlas-Datenbank für Produktionsdaten zu verwenden, genau wie Sie es für die Entwicklungsdatenbank getan haben.

Wählen Sie auf Railway die Dashboard-Option aus dem oberen Menü der Website und wählen Sie dann Ihr Anwendungsprojekt. 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). Klicken Sie auf die Neu-Schaltfläche, die verwendet wird, um Dienste zu dem aktuellen Projekt hinzuzufügen.

Wählen Sie Datenbank aus, wenn Sie nach der Art des hinzuzufügenden Dienstes gefragt werden:

Wählen Sie dann MongoDB hinzufügen, um mit dem Hinzufügen der Datenbank zu beginnen.

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

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

Um dies der Bibliotheksanwendung zugänglich zu machen, müssen wir sie über eine Umgebungsvariable zum Anwendungsprozess hinzufügen. Öffnen Sie zunächst den Anwendungsdienst. Wählen Sie dann den Variablen-Tab und klicken Sie auf die Schaltfläche Neue Variable.

Geben Sie den Variablennamen MONGODB_URI und die Verbindungs-URL, die Sie für die Datenbank kopiert haben, ein (MONGODB_URI ist der Name der Umgebungsvariablen, aus der wir die Anwendung konfigurierten, um die Datenbankadresse zu lesen). Dies wird etwa so aussehen wie auf dem unten gezeigten Bildschirm.

Klicken Sie auf Hinzufügen, um die Variable hinzuzufügen.

Railway startet Ihre App neu, wenn es Variablen aktualisiert. Wenn Sie jetzt die Startseite überprüfen, sollte sie null Werte für Ihre Objektanzahlen anzeigen, da wir jetzt eine neue (leere) Datenbank verwenden.

Andere Konfigurationsvariablen

Sie erinnern sich aus einem vorhergehenden Abschnitt, dass wir NODE_ENV auf 'production' setzen müssen, um unsere Leistung zu verbessern und weniger ausführliche Fehlermeldungen zu generieren. Wir können dies auf demselben Bildschirm tun, in dem wir die MONGODB_URI-Variable gesetzt haben.

Öffnen Sie den Anwendungsdienst. Wählen Sie dann den Variablen-Tab, wo Sie sehen, dass MONGODB_URI bereits definiert ist, und klicken Sie auf die Schaltfläche Neue Variable.

Geben Sie NODE_ENV als Namen der neuen Variablen und production als Namen der Umgebung ein. Dann drücken Sie die Hinzufügen-Schaltfläche.

Die lokale Bibliotheksanwendung ist nun eingerichtet und für die Produktion konfiguriert. Sie können Daten über die Website-Oberfläche hinzufügen, und es sollte auf dieselbe Weise wie während der Entwicklung funktionieren (jedoch mit weniger offengelegten Debug-Informationen für ungültige Seiten).

Den Client installieren

Laden Sie den Railway-Client für Ihr lokales Betriebssystem herunter und installieren Sie ihn gemäß den Anweisungen hier.

Sobald der Client installiert ist, können Sie Befehle ausführen. Einige der wichtigeren Operationen umfassen das Bereitstellen des aktuellen Verzeichnisses Ihres Computers auf ein zugeordnetes Railway-Projekt (ohne auf GitHub hochladen zu müssen) und das lokale Ausführen Ihres Projekts mit denselben Einstellungen wie auf dem Produktionsserver.

Sie können eine Liste aller möglichen Befehle erhalten, indem Sie das Folgende in einem Terminal eingeben.

railway help

Debugging

Der Railway-Client bietet den logs-Befehl, um das Ende der Logs zu zeigen (ein umfassenderes Log ist für jedes Projekt auf der Site verfügbar):

railway logs

Zusammenfassung

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

Siehe auch

• Produktions-Best-Practices: Leistung und Zuverlässigkeit (Express-Dokumentation)

• Produktions-Best-Practices: Sicherheit (Express-Dokumentation)

• Railway-Dokumentation

  • CLI

• DigitalOcean

  • Express Tutorials
  • Node.js Tutorials

• Heroku

  • Getting Started auf Heroku mit Node.js (Heroku-Dokumentation)
  • Bereitstellen von Node.js-Anwendungen auf Heroku (Heroku-Dokumentation)
  • Heroku Node.js Unterstützung (Heroku-Dokumentation)
  • Optimierung der Node.js-Anwendungskonkurrenz (Heroku-Dokumentation)
  • Wie Heroku funktioniert (Heroku-Dokumentation)
  • Dynos und der Dyno-Manager (Heroku-Dokumentation)
  • Konfiguration und Konfigurationsvariablen (Heroku-Dokumentation)
  • Grenzen (Heroku-Dokumentation)

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