Developer Services Portal v. 4.16.09
Prüfen Sie vor der Installation Folgendes:
- Sie führen die Installation auf der 64-Bit-Version einer unterstützten Version von Red Hat Enterprise Linux, CentOS oder Oracle aus. Hier finden Sie eine Liste der unterstützten Versionen.
- Yum ist installiert.
- Sie sichern vorhandene Installationen. Wenn Sie Code im Drupal-Kern oder in nicht benutzerdefinierten Modulen geändert haben, werden Ihre Änderungen überschrieben. Dazu gehören unter anderem alle Änderungen, die Sie möglicherweise an .htaccess vorgenommen haben. Sie sollten davon ausgehen, dass alles außerhalb des Verzeichnisses /sites Drupal gehört. Eine Ausnahme von dieser Regel ist robots.txt. Wenn diese Datei im Webstammverzeichnis vorhanden ist, wird sie beibehalten. Erstellen Sie vor der Installation eine Sicherung Ihres gesamten Drupal-Webstammverzeichnisses. Der Standardinstallationsort ist /var/www/html, aber Sie haben ihn möglicherweise bei der Installation geändert. Nachdem Sie die unten beschriebenen Installationsschritte ausgeführt haben, können Sie Ihre Anpassungen aus der Sicherung wiederherstellen.
Führen Sie die folgenden Schritte aus, um das Developer Channel Services-Portal zu installieren.
1. Developer Channel Services-Bundle herunterladen
Rufen Sie http://community.apigee.com/content/apigee-customer-support auf und wählen Sie „Login to your Support Portal“ (Im Supportportal anmelden) aus, um die TAR-Datei für die Entwicklerkanaldienste auf eine der folgenden zwei Arten anzufordern:
- Fordern Sie Zugriff auf das Downloadverzeichnis von Edge for Private Cloud an.
- Fordern Sie eine URL zur TAR-Datei der Developer Channel Services an.
2. Verbindung zu Apigee Edge testen
Testen Sie die Verbindung zum Edge-Verwaltungsserver, indem Sie den folgenden cURL-Befehl über eine Eingabeaufforderung auf dem Portalserver ausführen:
> curl -u
{EMAIL}:{PASSWORD}
https://{hostname}:8080/v1/organizations/{ORGNAME}
Dabei sind EMAIL und PASSWORD die E-Mail-Adresse und das Passwort des Administrators für ORGNAME.
Geben Sie den Hostnamen und die Portnummer für Ihre Edge-Installation an. Port 8080 ist der von Edge verwendete Standardport. Wenn Sie eine Verbindung zu einer Organisation in der Cloud herstellen, lautet die Anfrage-URL: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}
Wenn der Vorgang erfolgreich ist, gibt dieser Befehl eine Antwort wie die folgende zurück:
{
"createdAt" : 1348689232699,
"createdBy" : "USERNAME",
"displayName" : "cg",
"environments" : [ "test", "prod" ],
"lastModifiedAt" : 1348689232699,
"lastModifiedBy" : "foo@bar.com",
"name" : "cg",
"properties" : {
"property" : [ ]
},
"type" : "trial"
}
3. PHP-Versionen vor 7.0 entfernen
Das Installationsskript prüft vor Beginn der Installation, ob auf dem System PHP-Versionen vor 7.0 vorhanden sind. Wenn PHP-Versionen vor 7.0 vorhanden sind, wird die folgende Warnmeldung angezeigt:
The following packages present on your system conflict with software we are about to install. You will need to manually remove each one, then re-run this install script. php php-cli php-common php-gd php-mbstring php-mysql php-pdo php-pear php-pecl-apc php-process php-xml
Entfernen Sie für CentOS und Red Hat Enterprise Linux (RHEL) die PHP-Pakete mit dem folgenden Befehl:
yum remove <package-name>
4. Developer Channel Services mit dem automatisierten Installationsskript installieren
Verwenden Sie eines der folgenden Verfahren, um das Portal zu installieren, je nachdem, ob Sie es auf einem Server mit oder ohne Internetverbindung installieren.
Auf einem Server mit Internetverbindung:
So installieren Sie Developer Channel Services auf einem Server mit Internetverbindung:
- Melden Sie sich als Root- oder Superuser auf dem Server an.
- Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal.
- Wechseln Sie in das neue Verzeichnis portal und laden Sie die Datei DeveloperServices_x.y.z.tar für die Entwicklerkanaldienste herunter, wobei x.y.z der Versionsnummer des Portals entspricht.
Sie können eine Datei über den Link herunterladen, den Sie von Apigee in einem Browser erhalten haben, oder indem Sie sie kopieren und dann dem folgenden cURL-Befehl hinzufügen:
> curl -kOL <paste link here> - Extrahieren Sie den Inhalt der TAR-Datei für Developer Channel Services mit dem folgenden Befehl:
> tar -xvf <tar-Datei> - Wechseln Sie mit „cd“ zu DeveloperServices-4.x.y.z.
- Führen Sie das Installationsskript mit dem folgenden Befehl aus:
> ./networked-install.sh - Beantworten Sie die Fragen.
Auf einem Server ohne Internetverbindung:
Erstellen Sie zuerst ein Installationsskript ohne Netzwerkverbindung auf einem System mit Internetverbindung:
- Melden Sie sich auf einem System mit Internetverbindung als Root-Nutzer oder Superuser an.
- Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal_tar.
- Wechseln Sie in das Verzeichnis portal_tar und laden Sie die Datei DeveloperServices_x.y.z.tar für die Developer Channel Services herunter, wobei x.y.z der Versionsnummer des Portals entspricht.
- Extrahieren Sie den Inhalt der TAR-Datei für die Developer Channel Services mit dem folgenden Befehl:
> tar -xvf <tar-Datei> - Wechseln Sie zu DeveloperServices-4.x.y.z.
- Erstellen Sie die .tar.gz-Datei des Portals mit dem folgenden Befehl:
> ./non-networked-install.sh
Eine neue .tar.gz-Datei für die Installation ohne Netzwerk wird erstellt.
So installieren Sie Developer Channel Services auf einem Server ohne Internetverbindung:
- Melden Sie sich als Root- oder Superuser auf dem Server an.
- Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal.
- Wechseln Sie mit „cd“ in das Verzeichnis portal.
- Kopieren Sie die .tar.gz-Datei, die Sie für die Installation ohne Netzwerk (im obigen Verfahren) erstellt haben, in das Verzeichnis portal.
- Extrahieren Sie den Inhalt der .tar.gz-Datei mit dem folgenden Befehl:
> tar -xvf <tar-Datei> - Wechseln Sie in das Verzeichnis, das mit dem tar-Befehl erstellt wurde.
- Legen Sie die Berechtigungen für das Skript install-from-rpm-bundle.sh fest:
> chmod 755 install-from-rpm-bundle.sh - Führen Sie das Script install-from-rpm-bundle.sh mit dem folgenden Befehl aus:
> ./install-from-rpm-bundle.sh - Beantworten Sie die Fragen.
5. Entwicklerportal konfigurieren
Ein Großteil der Portalkonfiguration erfolgt ohne Ihr Zutun, z. B. die Installation von Drupal-Modulen und die Erstellung von Standardinhalten. Sie werden aufgefordert, die Datenbank einzurichten, den Edge-Endpunkt zu konfigurieren und einen neuen Administrator zu erstellen.
So konfigurieren Sie Ihr Entwicklerportal:
- Rufen Sie die Server-URL in einem Browser auf, z. B.
http://localhost. Wenn Sie eine bestimmte IP-Adresse oder einen bestimmten DNS-Namen konfiguriert haben, rufen Sie http://IP_address oder http://DNS_name auf.
Sie werden zur Seite „Datenbankkonfiguration“ des Apigee-Profils weitergeleitet.
Hinweis: In der Regel haben Sie bereits einen Hostnamen konfiguriert und auf Ihrem DNS-Server registriert, sodass Sie nicht http://localhost verwenden müssen. - Konfigurieren Sie die Verbindung zur Datenbank. Wenn sich die Datenbank auf einem Remote-Computer befindet, maximieren Sie den Abschnitt Erweiterte Optionen und geben Sie die Verbindungsinformationen für diesen Computer ein. Wählen Sie dann Speichern und fortfahren aus.
- Konfigurieren Sie die Verbindung zum Apigee-Endpunkt, indem Sie die folgenden Informationen eingeben, und wählen Sie dann Speichern aus.
Weitere Informationen zu diesen Werten finden Sie unter „Informationen, die vor Beginn der Installation erforderlich sind“ unter Anforderungen für das Entwicklerdienstportal.- Management API Org
- Management API Endpoint URL
- Endpoint Authenticated User
- Passwort authentifizierter Nutzer
- Konfigurieren Sie den Administratornutzer, indem Sie die folgenden Informationen eingeben, und wählen Sie dann „Speichern“ aus. Beachten Sie, dass Drupal standardmäßig einen Administrator mit dem Namen „admin“ erstellt. Verwenden Sie daher nicht „admin“ als Nutzernamen.
Wenn Sie diesen Schritt überspringen, können Sie trotzdem Drush verwenden, um einen Administrator zu erstellen, wie unten in 4 beschrieben. Erstellen Sie einen Administrator.- Vor- und Nachname des Entwicklers
- Nutzername im Entwicklerportal
- Passwort
- E-Mail-Adresse
- Legen Sie nach Abschluss der Installation die Berechtigungen für die Datei settings.php fest:
> chmod 640 /var/www/html/sites/default/settings.php - Rufen Sie die Startseite des Portals unter http://localhost/ oder den DNS-Namen Ihres Portals auf.
- Melden Sie sich mit den Administratoranmeldedaten im Portal an.
6. Administrator erstellen (optional)
Verwenden Sie Drush, um einen Administrator für Ihre Developer Channel Services-Installation zu erstellen. Drupal erstellt standardmäßig automatisch einen Administrator mit dem Namen „admin“. Verwenden Sie daher nicht „admin“ als Nutzernamen.
- Wechseln Sie in das Verzeichnis „drupal_root/sites/default“. Der Standardspeicherort für das Drupal-Stammverzeichnis ist /var/www/html:
> cd <drupal_root>/sites/default - Prüfen Sie, ob Sie Schreibberechtigungen für die privaten Drupal-Dateien haben:
> drush vget file_private_path
Dieser Befehl gibt den Pfad zu den privaten Drupal-Dateien zurück, z. B.:
file_private_path: 'sites/default/private'
Entspricht /var/www/html/sites/default/private/. Verwenden Sie den folgenden Befehl, um sicherzustellen, dass dieses Verzeichnis vom Inhaber und der Gruppe beschrieben werden kann:
chmod -R g+w dirPathAndName
chmod -R o+r dirPathAndName - Geben Sie die folgenden Befehle ein, um einen Administrator zu erstellen. Ersetzen Sie dabei die Befehle in „< >“ durch Ihre Werte:
> drush user-create <username> --mail="<email-address>" --password="<password>"
> drush user-add-role Administrator <username> - Melden Sie sich mit dem oben angegebenen Nutzernamen und Passwort als Administrator im Entwicklerportal an.
5. MySQL-Root-Passwort festlegen
Wenn Sie MySQL im Rahmen der Portalinstallation installiert haben, wird das MySQL-Root-Passwort vom Installationsskript auf den Standardwert gesetzt, der leer ist.
Verwenden Sie den folgenden Befehl, um das Root-Passwort festzulegen:
> mysqladmin -u root password NEWPASSWORD
Wenn Sie das Root-Passwort bereits festgelegt haben und es ändern möchten, verwenden Sie den folgenden Befehl:
> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD
Sie müssen das Passwort auch in der Datei /var/www/html/sites/default/settings.php aktualisieren.
6. Prüfen Sie, ob das Update Manager-Modul aktiviert ist.
Wenn Sie Benachrichtigungen zu Drupal-Updates erhalten möchten, muss das Drupal Update Manager-Modul aktiviert sein. Wählen Sie im Drupal-Menü Module aus und scrollen Sie nach unten zum Modul Update Manager. Wenn sie nicht aktiviert ist, aktivieren Sie sie.
Nach der Aktivierung können Sie die verfügbaren Updates über den Menüpunkt Berichte > Verfügbare Updates aufrufen. Sie können auch den folgenden Drush-Befehl verwenden:
> drush pm-info update
Verwenden Sie den Menüpunkt Berichte > Verfügbare Updates > Einstellungen, um das Modul so zu konfigurieren, dass Sie per E-Mail benachrichtigt werden, wenn Updates verfügbar sind, und um die Häufigkeit der Suche nach Updates festzulegen.
7. Auf einem Produktionsserver bereitstellen (optional)
Wenn Sie das Portal auf einem Produktionsserver bereitstellen, sollten Sie zusätzliche Sicherheitsschritte ausführen, darunter:
- Führen Sie das folgende Skript aus, um Ihre MySQL-Installation zu sichern:
> /usr/bin/mysql_secure_installation
Dieses Skript legt das Root-Passwort fest und bietet Ihnen die Möglichkeit, den Root-Zugriff auf den Localhost zu beschränken und die standardmäßig erstellten Testdatenbanken und anonymen Nutzer zu entfernen. Die Ausführung dieses Skripts wird für Produktionsserver dringend empfohlen. - Aktivieren und konfigurieren Sie SELinux, wenn dies gemäß Ihren Unternehmensrichtlinien erforderlich ist.
8. Apache Solr-Suchmaschine konfigurieren (optional)
Standardmäßig sind die Drupal-Module, die eine Verbindung zur Apache Solr-Suchmaschine herstellen, bei der Installation des Portals deaktiviert. Die meisten Portale verwenden die interne Drupal-Suchmaschine und benötigen daher die Drupal-Solr-Module nicht.
Wenn Sie Solr als Suchmaschine verwenden möchten, müssen Sie Solr lokal auf Ihrem Server installieren und dann die Drupal-Solr-Module im Portal aktivieren und konfigurieren.
So aktivieren Sie die Drupal Solr-Module:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Erstellungsberechtigungen an.
- Wählen Sie im Drupal-Menü Module aus.
- Aktivieren Sie das Modul Apache Solr Framework und das Modul Apache Solr Search.
- Speichern Sie die Änderungen.
- Konfigurieren Sie Solr wie unter https://drupal.org/node/1999280 beschrieben.
9. mod_ssl zur Unterstützung von HTTPS installieren (optional)
Das Modul „mod_ssl“ wird vom Apache HTTP Server verwendet, um Webseiten über HTTPS bereitzustellen. Wenn Sie HTTPS verwenden möchten, installieren Sie mod_ssl mit dem folgenden Befehl:
> yum install mod_ssl
Weitere Informationen zum Konfigurieren des Portals für die Verwendung von SSL finden Sie unter http://apigee.com/docs/developer-services/content/using-ssl-portal.
10. SmartDocs installieren (optional)
Mit SmartDocs können Sie Ihre APIs im Developer Services-Portal so dokumentieren, dass die API-Dokumentation vollständig interaktiv ist. Wenn Sie SmartDocs mit dem Portal verwenden möchten, müssen Sie SmartDocs zuerst in Edge installieren.
- Wenn Sie das Portal mit einer Edge Cloud-Installation verbinden, ist SmartDocs bereits installiert und es ist keine weitere Konfiguration erforderlich.
- Wenn Sie das Portal mit einer Edge for Private Cloud-Installation verbinden, müssen Sie dafür sorgen, dass SmartDocs auf Edge installiert ist. Weitere Informationen zur Installation von Edge und SmartDocs finden Sie unter SmartDocs installieren.
Weitere Informationen zu SmartDocs finden Sie unter APIs mit SmartDocs dokumentieren.
11. Nächste Schritte
Nach der Installation des Developer Services-Portals müssen Sie es für Ihre spezifischen Anforderungen konfigurieren und anpassen. Die Dokumentation auf der Apigee-Website enthält alle Informationen zum Konfigurieren, Gestalten und Verwalten eines Portals. Die Dokumentation finden Sie unter http://apigee.com/docs/developer-services/content/what-developer-portal.
In der folgenden Tabelle sind einige der häufigsten Aufgaben aufgeführt, die Sie nach der Installation ausführen, sowie Links zur Apigee-Dokumentation mit weiteren Informationen:
|
Aufgabe |
Beschreibung |
|
Das Design definiert das Erscheinungsbild des Portals, einschließlich Farben, Stil und anderer visueller Aspekte. |
|
|
Die Startseite enthält das Hauptmenü, die Begrüßungsnachricht, die Kopfzeile, die Fußzeile und den Titel. |
|
|
Der Registrierungsprozess steuert, wie neue Entwickler ein Konto im Portal registrieren. Beispielsweise, ob neue Entwickler sofortigen Zugriff auf das Portal erhalten oder von einem Administrator verifiziert werden müssen. Dieser Prozess steuert auch, wie ein Portaladministrator benachrichtigt wird, wenn ein neues Konto erstellt wird. |
|
|
Das Portal sendet E-Mails bei bestimmten Ereignissen. Beispielsweise, wenn sich ein neuer Entwickler im Portal registriert und wenn ein Entwickler sein Passwort verliert. |
|
|
Fügen Sie eine Seite mit Nutzungsbedingungen hinzu, die Entwickler akzeptieren müssen, bevor sie auf das Portal zugreifen dürfen. |
|
|
Das Portal implementiert ein rollenbasiertes Autorisierungsmodell. Bevor Sie Entwicklern die Registrierung erlauben, definieren Sie die Berechtigungen und Rollen, die vom Portal verwendet werden. |
|
|
Das Portal bietet integrierte Unterstützung für Blogs und Foren mit Diskussions-Threads. Definieren Sie die Berechtigungen, die zum Ansehen, Hinzufügen, Bearbeiten und Löschen von Blog- und Forumsbeiträgen erforderlich sind. |
|
|
Datenbanksicherungen erstellen |
Sichern Sie die Drupal-Datenbank. Da jede Installation anders ist, müssen Sie selbst entscheiden, wie Sie die Datenbank am besten sichern. |
|
Hostname einrichten |
Wenn Sie keinen Hostnamen auf Ihrem DNS-Server einrichten, können Sie die Website jederzeit über die IP-Adresse des Servers aufrufen. Wenn Sie einen Hostnamen verwenden möchten, können Sie DNS für den Server konfigurieren. Das sollte bei einer einfachen Einrichtung ohne weitere Konfiguration funktionieren. Wenn Sie einen Load Balancer einrichten oder aus einem anderen Grund falsche URLs auf Ihrer Website erhalten, können Sie $base_url in der Datei settings.php des Entwicklerportals festlegen, die sich standardmäßig im Verzeichnis /var/www/html/sites/default befindet. |