Instalacja portalu usług dla deweloperów

Developer Services Portal w wersji 4.16.05

Aby zainstalować portal usług kanału dla programistów, wykonaj te czynności.

Przed kontynuowaniem instalacji utwórz kopię zapasową całego katalogu głównego internetowego Drupal. Domyślna lokalizacja instalacji to /var/www/html, ale mogła zostać zmieniona podczas instalacji. Po wykonaniu opisanych poniżej kroków instalacji możesz przywrócić dostosowania z kopii zapasowej.

1. Pobierz pakiet usług kanału dla programistów

Otwórz stronę http://community.apigee.com/content/apigee-customer-support i wybierz Zaloguj się do swojego portalu pomocy, aby poprosić o plik .tar usług kanału dla programistów na 2 sposoby:

  • Poproś o dostęp do katalogu pobierania Edge for Private Cloud.
  • Poproś o adres URL pliku tar usług kanału dla programistów.

2. Sprawdź, czy Twój system spełnia wymagania systemowe

Zanim zainstalujesz portal, serwer musi spełniać te wymagania:

  1. Sprawdź, czy instalujesz 64-bitową wersję obsługiwanej wersji systemu Red Hat Enterprise Linux, CentOS lub Oracle. Listę obsługiwanych wersji znajdziesz tutaj.
  2. Upewnij się, że zainstalowano Yum.
  3. (W przypadku instalacji na serwerze bez połączenia z internetem) Musisz najpierw pobrać wszystkie niezbędne pliki na serwer z połączeniem internetowym jako pojedynczy plik .tar.gz. Następnie skopiuj ten plik .tar.gz na serwer bez połączenia z internetem, aby przeprowadzić instalację.
    1. Zaloguj się na serwer z połączeniem internetowym jako użytkownik root lub superużytkownik.
    2. Utwórz katalog z plikami instalacyjnymi, np. portal_tar.
    3. Umieść na CD nowy katalog i pobierz plik DeveloperServices_x.y.z.tar usług kanału dla programistów, gdzie x.y.z odpowiada numerowi wersji portalu.
    4. Wyodrębnij zawartość pliku tar w usługach kanału dla programistów za pomocą polecenia:
      > tar -xvf <plik tar>
    5. CD do DeveloperServices-4.x.y.z.
    6. Utwórz plik .tar.gz portalu, używając polecenia:
      > ./non-networked-install.sh

      To polecenie pobierze wszystkie niezbędne pliki i umieści je w jednym pliku .tar.gz. Następnie skopiuj ten plik .tar.gz na serwer, który nie ma połączenia z internetem, aby dokończyć instalację.
  4. Przetestuj połączenie z serwerem zarządzania brzegowym, wykonując to polecenie cURL z wiersza polecenia na serwerze portalu:
    > curl -u {EMAIL}:{PASSWORD}



    Podaj nazwę hosta i numer portu właściwe dla instalacji Edge. Port 8080 to port domyślny używany przez Edge. Jeśli łączysz się z organizacją w chmurze, "request URL", "request URL"
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    W przypadku powodzenia to polecenie zwraca odpowiedź podobną do:
    {
    "createdAt" : 1348689232699,
    createName:









3. Zainstaluj usługi kanału dewelopera za pomocą automatycznego skryptu instalacji

Aby zainstalować portal za pomocą automatycznego skryptu instalacji, wykonaj czynności opisane poniżej. Ta procedura działa w przypadku serwerów z zewnętrznym połączeniem internetowym lub bez niego.

  1. Zaloguj się na serwerze jako root lub superużytkownik.
  2. Utwórz katalog z plikami instalacyjnymi, np. portal.
  3. Na serwerze z połączeniem internetowym:
    1. Dodaj dysk CD do nowego katalogu portal i pobierz plik DeveloperServices_x.y.z.tar usług kanału programisty, gdzie x.y.z odpowiada numerowi wersji portalu.

      Możesz pobrać plik z linku przesłanego przez Apigee w przeglądarce lub skopiować go i dodać do tego polecenia cURL:
      > curl -kOL <wklej link tutaj>
    2. Wyodrębnij zawartość pliku tar w usługach kanału dla programistów za pomocą polecenia:
      > tar -xvf <plik tar>
    3. CD do DeveloperServices-4.x.y.z.
    4. Uruchom skrypt instalacyjny za pomocą tego polecenia:
      > ./networked-install.sh
  4. Na serwerze bez połączenia z internetem:
    1. Skopiuj plik .tar.gz utworzony w sekcji 2. Sprawdź, czy Twój system spełnia wymagania systemowe.
    2. Wyodrębnij zawartość pliku .tar.gz za pomocą polecenia:
      > tar -xvf <plik tar>
    3. CD do katalogu utworzonego przez polecenie tar.
    4. Ustaw uprawnienia w skrypcie install-from-rpm-bundle.sh:
      > chmod 755 instalacja-from-rpm-bundle.sh
    5. Uruchom skrypt install-from-rpm-bundle.sh za pomocą polecenia:
      > ./install-from-rpm-bundle.sh
  5. Odpowiedz na pytania.
  6. Po zakończeniu instalacji otwórz w przeglądarce adres URL serwera, na przykład:
    http://localhost. Jeśli masz skonfigurowany określony adres IP lub DNS, otwórz adres http://adres_IP lub http://nazwa_DNS.

    Nastąpi przekierowanie na stronę konfiguracji bazy danych profilu Apigee.

    Uwaga: zwykle nazwa hosta jest skonfigurowana i zarejestrowana na Twoim serwerze DNS, dzięki czemu nie musisz używać http://localhost.
  7. Skonfiguruj połączenie z MySQL. Jeśli MySQL działa na komputerze zdalnym, rozwiń sekcję Opcje zaawansowane i wpisz informacje o połączeniu z tym komputerem, a potem kliknij Zapisz i kontynuuj.
  8. Skonfiguruj połączenie z punktem końcowym Apigee, wpisując poniższe informacje, a następnie klikając Zapisz:
    Więcej informacji o tych wartościach znajdziesz w sekcji „Informacje wymagane przed rozpoczęciem instalacji” w wymaganiach portalu usług dla deweloperów.
    1. Organizacja portalu dla programistów
    2. URL punktu końcowego portalu dla programistów
    3. Uwierzytelniony użytkownik punktu końcowego
    4. Uwierzytelnione hasło użytkowników
  9. Gdy pojawi się prośba, kliknij przycisk Zainstaluj przykładowe dokumenty WADL, aby zainstalować przykładowy format SmartDokumentacja w formacie WADL. Jeśli pominiesz ten krok, przykładowy interfejs SmartDokumentacja API nie będzie widoczny w Twoim portalu.
    Uwaga: jeśli Twój portal łączy się z instalacją Apigee Edge dla Private Cloud, a instalacja Edge nie ma zewnętrznego połączenia z internetem, to aby korzystać z aplikacji SmartDokumentacja, musisz przeprowadzić dodatkową konfigurację modułu. Więcej informacji o SmartDokumentach znajdziesz na stronie http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Skonfiguruj Ustawienia serwera SMTP. Apigee wymaga skonfigurowania serwera SMTP do wysyłania e-maili z portalu.
    Więcej informacji znajdziesz na stronie http://apigee.com/docs/developer-services/content/configuring-email.
  11. Skonfiguruj administratora, wpisując poniższe informacje, a potem kliknij Zapisz. Pamiętaj, że w Drupal domyślnie tworzony jest administrator o nazwie „admin”, więc nie używaj słowa „admin” jako nazwy użytkownika.
    Nawet jeśli pominiesz ten krok, nadal możesz użyć Drush, aby utworzyć administratora w sposób opisany w kroku 4. Utwórz administratora.
    1. Imię i nazwisko dewelopera
    2. Nazwa użytkownika portalu dla programistów
    3. Hasło
    4. Adres e-mail
  12. Po zakończeniu instalacji ustaw uprawnienia w pliku settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. Wejdź na stronę główną portalu (http://localhost/) lub do nazwy DNS portalu.
  14. Zaloguj się w portalu przy użyciu danych logowania administratora.

4. Tworzenie administratora

Użyj Drush, aby utworzyć użytkownika administracyjnego do instalacji usług kanału dla programistów. Drupal automatycznie tworzy administratora o domyślnej nazwie „admin”, więc nie używaj słowa „admin” jako nazwy użytkownika.

  1. Dysk CD do katalogu drupal_root/sites/default. Standardowa lokalizacja katalogu głównego Drupal to /var/www/html:
    > cd <drupal_root>/sites/default
  2. Sprawdź, czy masz uprawnienia do zapisu w prywatnych plikach Drupal:
    > drush vget file_private_path

    To polecenie zwraca ścieżkę do prywatnych plików Drupala, na przykład:
    file_private_path: 'sites/default/private'

    Odpowiada to adresowi /var/www/html/sites/default/private/. Użyj tego polecenia, aby upewnić się, że właściciel i grupa mogą zapisywać w tym katalogu:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Wpisz te polecenia, aby utworzyć administratora, zastępując polecenia w elemencie „< >” własnymi wartościami:
    > drush user-create <nazwa_użytkownika> --mail="<adres-e-mail>" --password="<hasło>"
    > drush user-add-role Administrator <nazwa_użytkownika>
  4. Zaloguj się w portalu dla programistów jako administrator przy użyciu nazwy użytkownika i hasła podanych powyżej.

5. Ustawianie głównego hasła do MySQL

Jeśli podczas instalacji portalu zainstalowano MySQL, skrypt instalacyjny pozostawia domyślne hasło główne MySQL ustawione na wartość domyślną, która jest pusta.

Aby ustawić hasło roota, użyj tego polecenia:

> mysqladmin -u root password NEWPASSWORD

Jeśli masz już ustawione hasło roota i chcesz je zmienić, użyj tego polecenia:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

Musisz też zaktualizować hasło w pliku /var/www/html/sites/default/settings.php.

6. Sprawdź, czy moduł menedżera aktualizacji jest włączony

Aby otrzymywać powiadomienia o aktualizacjach w serwisie Drupal, musisz włączyć moduł menedżera aktualizacji Drupal. W menu Drupal wybierz Modules (Moduły) i przewiń w dół do modułu Zaktualizuj menedżera. Jeśli nie jest włączony, włącz go.

Po włączeniu tej funkcji możesz zobaczyć dostępne aktualizacje w menu Raporty > Dostępne aktualizacje. Możesz też użyć tego polecenia w Drush:

> drush pm-info update

Użyj opcji Raporty > Dostępne aktualizacje > Ustawienia, aby skonfigurować wysyłanie e-maili z modułem o dostępności aktualizacji oraz ustawić częstotliwość sprawdzania dostępności aktualizacji.

7. Opcjonalnie – wdrażanie na serwerze produkcyjnym

Jeśli wdrażasz portal na serwerze produkcyjnym, wykonaj dodatkowe czynności związane z bezpieczeństwem, takie jak:

  1. Uruchom ten skrypt, aby zabezpieczyć swoją instalację MySQL:
    > /usr/bin/mysql_secure_installation

    Skrypt ten ustawia hasło roota i umożliwia ograniczenie dostępu roota tylko do hosta lokalnego oraz usunięcie domyślnie utworzonych testowych baz danych i anonimowego użytkownika. Uruchomienie tego skryptu jest zdecydowanie zalecane w przypadku serwerów produkcyjnych.
  2. Jeśli wymagają tego zasady obowiązujące w firmie, włącz i skonfiguruj SELinux.

8. Opcjonalnie – skonfiguruj wyszukiwarkę Apache Solr

Domyślnie moduły Drupal łączące się z wyszukiwarką Apache Solr są wyłączone podczas instalacji portalu. Większość portali używa wewnętrznej wyszukiwarki Drupal, więc nie wymagają one modułów Drupal Solr.

Jeśli chcesz używać Solr jako wyszukiwarki, musisz zainstalować Solr lokalnie na serwerze, a następnie włączyć i skonfigurować moduły Drupal Solr w portalu.

Aby włączyć moduły Drupal Solr:

  1. Zaloguj się w portalu jako użytkownik z uprawnieniami administratora lub z uprawnieniami do tworzenia treści.
  2. W menu Drupal wybierz Modules (Moduły).
  3. Włącz moduł Apache Solr Framework i Apache Solr Search.
  4. Zapisz zmiany.
  5. Skonfiguruj oprogramowanie Solr w sposób opisany na stronie https://drupal.org/node/1999280.

9. Opcjonalnie – zainstaluj mod_ssl, aby obsługiwać HTTPS

Moduł mod_ssl jest używany przez serwer HTTP Apache do wyświetlania stron internetowych przez HTTPS. Jeśli chcesz korzystać z protokołu HTTPS, zainstaluj mod_ssl za pomocą tego polecenia:

> yum install mod_ssl

Więcej informacji o konfigurowaniu portalu do używania protokołu SSL znajdziesz na stronie http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Opcjonalnie – zainstaluj SmartDokumentacja

SmartDokumentacja umożliwia dokumentowanie interfejsów API w portalu usług dla programistów w taki sposób, że dokumentacja interfejsu API jest w pełni interaktywna. Jeśli jednak chcesz używać aplikacji SmartDokumentacja w portalu, musisz najpierw zainstalować te dokumenty w przeglądarce Edge.

  • Jeśli łączysz portal z instalacją Edge Cloud, aplikacja SmartDokumentacja jest już zainstalowana i nie jest wymagana żadna dodatkowa konfiguracja.
  • Jeśli łączysz portal z instalacją Edge dla Private Cloud, musisz zainstalować aplikację SmartDokumentacja w Edge. Więcej informacji o instalowaniu Edge i SmartDokumentów znajdziesz w artykule Instalowanie SmartDokumentów.

Więcej informacji o SmartDokumentach znajdziesz w artykule Używanie SmartDokumentów do dokumentowania interfejsów API.

11. Co dalej?

Następnym krokiem po zainstalowaniu portalu usług dla programistów jest jego skonfigurowanie i dostosowanie do swoich potrzeb. Dokumentacja w witrynie Apigee zawiera wszystkie informacje na temat konfigurowania portalu i określania jego stylu oraz zarządzania nim. Zapoznaj się z dokumentacją na stronie http://apigee.com/docs/developer-services/content/what-developer-portal.

W tabeli poniżej znajdziesz niektóre z najczęstszych zadań, które wykonujesz po instalacji, oraz linki do dokumentacji Apigee, gdzie znajdziesz więcej informacji:

Zadanie

Opis

Dostosowywanie motywu

Motyw określa wygląd portalu, w tym kolory, styl i inne aspekty wizualne.

Dostosowywanie wyglądu

Strona główna zawiera menu główne, wiadomość powitalną, nagłówek, stopkę i tytuł.

Dodawanie kont użytkowników i zarządzanie nimi

Proces rejestracji kontroluje sposób, w jaki nowi deweloperzy rejestrują konto w portalu. Na przykład nowi deweloperzy uzyskają natychmiastowy dostęp do portalu lub muszą zostać zweryfikowani przez administratora. Ten proces określa też sposób powiadamiania administratora portalu o utworzeniu nowego konta.

Konfiguruję pocztę e-mail

Portal wysyła e-maile w odpowiedzi na określone zdarzenia. na przykład gdy nowy deweloper zarejestruje się w portalu i utraci hasło.

Dodawanie kont użytkowników i zarządzanie nimi

Dodaj stronę z warunkami korzystania z usługi, którą deweloperzy muszą zaakceptować, zanim będą mogli uzyskać dostęp do portalu.

Dodawanie kont użytkowników i zarządzanie nimi

Portal stosuje model autoryzacji na podstawie ról. Zanim zezwolisz deweloperom na rejestrację, określ uprawnienia i role używane przez portal.

Dodawanie postów na blogu i forum

Portal ma wbudowaną obsługę blogów i forów z wątkami. Określ uprawnienia wymagane do wyświetlania, dodawania, edytowania i usuwania postów na blogu i forum.

Sprawdź, czy wykonujesz kopie zapasowe bazy danych

Upewnij się, że tworzysz kopię zapasową bazy danych Drupal. Każda instalacja jest inna, dlatego to Ty decydujesz, jak najlepiej utworzyć kopię zapasową bazy danych.

Skonfiguruj nazwę hosta

Jeśli nie skonfigurujesz nazwy hosta na serwerze DNS, zawsze możesz uzyskać dostęp do witryny za pomocą adresu IP serwera. Jeśli chcesz używać nazwy hosta, możesz dla niego skonfigurować DNS. Powinien on działać prawidłowo bez żadnej innej konfiguracji w ramach konfiguracji podstawowej.

Jeśli skonfigurujesz system równoważenia obciążenia lub z jakiegoś powodu w witrynie otrzymujesz nieprawidłowe adresy URL, możesz ustawić parametr $base_url w pliku settings.php portalu dla programistów, który domyślnie znajduje się w katalogu /var/www/html/sites/default.