Penginstalan portal Layanan Developer

Portal Layanan Developer v. 4.16.05

Ikuti langkah-langkah berikut untuk menginstal portal Layanan Saluran Developer.

Sebelum melanjutkan penginstalan, cadangkan seluruh direktori root web Drupal Anda. Lokasi penginstalan default adalah /var/www/html, tetapi Anda mungkin telah mengubahnya pada waktu penginstalan. Setelah melakukan langkah-langkah penginstalan yang dijelaskan di bawah, Anda dapat memulihkan penyesuaian dari cadangan.

1. Mendapatkan paket Layanan Saluran Developer

Buka http://community.apigee.com/content/apigee-customer-support dan pilih Login ke Portal Dukungan Anda untuk meminta file .tar Layanan Saluran Developer dengan salah satu dari dua cara berikut:

  • Minta akses ke direktori download Edge for Private Cloud.
  • Minta URL ke file .tar Layanan Saluran Developer.

2. Pastikan sistem Anda memenuhi persyaratan sistem

Sebelum menginstal portal, server Anda harus memenuhi persyaratan berikut:

  1. Pastikan Anda melakukan penginstalan pada versi 64-bit dari Red Hat Enterprise Linux, CentOS, atau Oracle yang didukung. Lihat daftar versi yang didukung di sini.
  2. Pastikan Yum terinstal.
  3. (Untuk penginstalan pada server tanpa koneksi Internet) Anda harus mendownload semua file yang diperlukan terlebih dahulu ke server yang memiliki koneksi Internet sebagai satu file .tar.gz. Kemudian, salin file .tar.gz tersebut ke server tanpa koneksi Internet untuk menjalankan penginstalan.
    1. Masuk ke server dengan koneksi Internet sebagai {i>root<i} atau sebagai {i>superuser<i}.
    2. Buat direktori untuk file instal, seperti portal_tar.
    3. CD ke direktori baru dan download file DeveloperServices_x.y.z.tar Layanan Saluran Developer, dengan x.y.z sesuai dengan nomor versi portal.
    4. Ekstrak konten file .tar Layanan Saluran Developer menggunakan perintah:
      > tar -xvf <tar file>
    5. CD ke DeveloperServices-4.x.y.z.
    6. Buat file .tar.gz portal menggunakan perintah:
      > ./non-networked-install.sh

      Perintah tersebut akan mendownload semua file yang diperlukan dan file tersebut menjadi satu file .tar.gz. Kemudian, salin file .tar.gz tersebut ke server Anda yang tidak memiliki koneksi internet untuk menyelesaikan penginstalan.
  4. Uji koneksi Anda ke server pengelolaan Edge dengan menjalankan perintah cURL berikut dari command prompt di server portal:
    > curl -u {EMAIL}:{KATA SANDI} https://{nama host}:8080/v1/organizations/{ORGNAME}

    Tempat EMAIL dan KATA SANDI adalah administrator email EMAIL dan SANDI

    Pastikan Anda menentukan nama host dan nomor port khusus untuk penginstalan Edge. Port 8080 adalah port default yang digunakan oleh Edge. Jika Anda menghubungkan ke organisasi di cloud, maka URL permintaannya adalah:
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    Jika berhasil, perintah ini akan menampilkan respons yang serupa dengan berikut:
    {
    "createdAt" : 1348689232699,
    "createdBy" : "









3. Instal Layanan Saluran Developer menggunakan skrip penginstalan otomatis

Gunakan prosedur berikut untuk menginstal portal menggunakan skrip penginstalan otomatis. Prosedur ini berfungsi untuk server dengan atau tanpa koneksi Internet eksternal.

  1. Masuk ke server sebagai {i>root <i}atau sebagai {i>superuser<i}.
  2. Buat direktori untuk file instal, seperti portal.
  3. Di server dengan koneksi Internet:
    1. CD ke direktori portal baru dan download file DeveloperServices_x.y.z.tar Layanan Saluran Developer, dengan x.y.z sesuai dengan nomor versi portal.

      Anda dapat mendownload file dari link yang dikirimkan oleh Apigee di browser atau dengan menyalinnya, lalu menambahkannya ke perintah cURL berikut:
      > curl -kOL <paste link here>
    2. Ekstrak konten file .tar Layanan Saluran Developer menggunakan perintah:
      > tar -xvf <tar file>
    3. CD ke DeveloperServices-4.x.y.z.
    4. Jalankan skrip penginstalan menggunakan perintah berikut:
      > ./networked-install.sh
  4. Di server tanpa koneksi Internet:
    1. Salin file .tar.gz yang Anda buat di atas di bagian 2. Pastikan sistem Anda memenuhi persyaratan sistem.
    2. Ekstrak konten file .tar.gz menggunakan perintah:
      > tar -xvf <tar file>
    3. CD ke direktori yang dibuat oleh perintah {i>tar<i}.
    4. Tetapkan izin pada skrip install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
    5. Jalankan skrip install-from-rpm-bundle.sh menggunakan perintah:
      > ./install-from-rpm-bundle.sh
  5. Jawab petunjuknya.
  6. Setelah penginstalan selesai, buka URL server di browser, seperti:
    http://localhost. Atau, jika Anda memiliki IP atau DNS tertentu yang dikonfigurasi, buka http://IP_address atau http://DNS_name.

    Anda akan dialihkan ke halaman konfigurasi Database profil Apigee.

    Catatan: Biasanya, Anda telah mengonfigurasi nama host dan mendaftarkannya dengan server DNS sehingga Anda tidak perlu menggunakan http://localhost.
  7. Mengonfigurasi koneksi ke MySQL. Jika MySQL berada di perangkat jarak jauh, luaskan bagian Advanced Options dan masukkan informasi koneksi ke komputer tersebut, lalu Pilih Save and continue.
  8. Konfigurasi koneksi ke Endpoint Apigee dengan memasukkan informasi berikut, lalu pilih Save:
    Untuk mengetahui informasi selengkapnya tentang nilai ini, lihat "Informasi yang Diperlukan Sebelum Memulai Penginstalan" di Persyaratan portal Layanan Developer.
    1. Org Portal Dev
    2. URL Endpoint Portal Dev
    3. Pengguna yang Diautentikasi Endpoint
    4. Sandi Pengguna yang Diautentikasi
  9. Saat diminta, pilih tombol Install Sample SmartDocs WADL untuk menginstal contoh SmartDocs WADL. Jika Anda melewati langkah ini, contoh SmartDocs API tidak akan muncul di portal Anda.
    Catatan: Jika portal Anda terhubung ke penginstalan Apigee Edge untuk Private Cloud, dan penginstalan Edge tersebut tidak memiliki koneksi internet eksternal, Anda harus melakukan konfigurasi tambahan modul SmartDocs sebelum dapat menggunakan SmartDocs. Untuk informasi selengkapnya tentang SmartDocs, lihat http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Konfigurasi Setelan Server SMTP. Apigee mengharuskan Anda mengonfigurasi server SMTP untuk mengirim pesan email dari portal.
    Untuk informasi selengkapnya, lihat http://apigee.com/docs/developer-services/content/configuring-email.
  11. Konfigurasikan pengguna administrator dengan memasukkan informasi berikut, lalu pilih Save. Perlu diperhatikan bahwa Drupal membuat pengguna admin bernama 'admin' secara default, jadi jangan gunakan 'admin' sebagai nama pengguna.
    Jika melewati langkah ini, Anda masih dapat menggunakan Drush untuk membuat administrator seperti yang dijelaskan di bawah dalam 4. Membuat pengguna admin.
    1. Nama depan dan belakang developer
    2. Nama pengguna portal developer
    3. Password
    4. Alamat email
  12. Setelah penginstalan selesai, tetapkan izin pada file settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. Buka halaman beranda portal di http://localhost/ atau nama DNS portal Anda.
  14. Login ke portal menggunakan kredensial administrator.

4. Membuat pengguna admin

Gunakan Drush untuk membuat pengguna administratif untuk penginstalan Layanan Saluran Developer. Drupal secara otomatis membuat pengguna admin bernama 'admin' secara default, jadi jangan gunakan 'admin' sebagai nama pengguna.

  1. CD ke direktori {i> drupal_root/sites/default<i} Anda. Lokasi standar untuk direktori utama Drupal adalah /var/www/html:
    > cd <drupal_root>/sites/default
  2. Pastikan Anda memiliki izin tulis di file Drupal pribadi:
    > drush vget file_private_path

    Perintah ini akan menampilkan jalur ke file Drupal pribadi, misalnya:
    file_private_path: 'sites/default/private'

    Terkait dengan /var/www/html/sites/default/private/. Gunakan perintah berikut untuk memastikan bahwa direktori ini dapat ditulis oleh pemilik dan grup:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Masukkan perintah berikut untuk membuat pengguna admin, dengan mengganti perintah di “< >” dengan nilai Anda:
    > drush user-create <username> --mail="<email-address>" --password="<password>"
    > drush user-add-role Administrator <username>
  4. Login ke portal developer sebagai admin dengan menggunakan nama pengguna dan sandi yang ditentukan di atas.

5. Menyetel sandi root MySQL

Jika Anda menginstal MySQL sebagai bagian dari penginstalan portal, skrip penginstalan akan membiarkan sandi root MySQL ditetapkan ke nilai defaultnya, yaitu kosong.

Gunakan perintah berikut untuk menyetel sandi root:

> mysqladmin -u root password NEWPASSWORD

Jika sebelumnya Anda telah menetapkan sandi root dan ingin mengubahnya, gunakan perintah berikut:

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

Anda juga harus memperbarui sandi dalam file /var/www/html/sites/default/settings.php.

6. Pastikan modul Update manager diaktifkan

Untuk menerima notifikasi update Drupal, pastikan modul pengelola Update Drupal diaktifkan. Dari menu Drupal, pilih Modules, lalu scroll ke bawah ke modul Update manager. Jika tidak diaktifkan, aktifkan.

Setelah diaktifkan, Anda dapat melihat pembaruan yang tersedia menggunakan item menu Laporan > Update yang Tersedia. Anda juga dapat menggunakan perintah Drush berikut:

> drush pm-info update

Gunakan item menu Laporan > Update yang Tersedia > Setelan untuk mengonfigurasi modul agar dapat mengirimkan email kepada Anda jika update tersedia dan menetapkan frekuensi pemeriksaan update.

7. Opsional - Men-deploy di server produksi

Jika Anda men-deploy portal di server produksi, lakukan langkah-langkah keamanan tambahan, termasuk:

  1. Jalankan skrip berikut untuk mengamankan penginstalan MySQL Anda:
    > /usr/bin/mysql_secure_installation

    Skrip ini menetapkan sandi root dan memberi Anda opsi untuk membatasi akses root hanya ke localhost serta untuk menghapus database pengujian dan pengguna anonim yang dibuat secara default. Menjalankan skrip ini sangat direkomendasikan untuk server produksi.
  2. Jika diwajibkan oleh kebijakan perusahaan Anda, aktifkan dan konfigurasi SELinux.

8. Opsional - Konfigurasikan mesin telusur Apache Solr

Secara default, modul Drupal yang terhubung ke mesin telusur Apache Solr akan dinonaktifkan saat Anda menginstal portal. Sebagian besar portal menggunakan mesin telusur Drupal internal, sehingga tidak memerlukan modul Drupal Solr.

Jika memutuskan untuk menggunakan Solr sebagai mesin telusur, Anda harus menginstal Solr secara lokal di server Anda, lalu mengaktifkan dan mengonfigurasi modul Drupal Solr di portal tersebut.

Untuk mengaktifkan modul Drupal Solr:

  1. Login ke portal Anda sebagai pengguna yang memiliki hak istimewa pembuatan konten atau admin.
  2. Pilih Modules di menu Drupal.
  3. Aktifkan modul Apache Solr Framework dan modul Apache Solr Search.
  4. Simpan perubahan.
  5. Konfigurasikan Solr seperti yang dijelaskan di https://drupal.org/node/1999280.

9. Opsional - Instal mod_ssl untuk mendukung HTTPS

Modul mod_ssl digunakan oleh Server HTTP Apache untuk menyalurkan laman web melalui HTTPS. Jika Anda ingin menggunakan HTTPS, gunakan perintah berikut untuk menginstal mod_ssl:

> yum install mod_ssl

Untuk informasi selengkapnya tentang cara mengonfigurasi portal untuk menggunakan SSL, lihat http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Opsional - Instal SmartDocs

SmartDocs memungkinkan Anda mendokumentasikan API di portal Layanan Developer dengan cara yang membuat dokumentasi API menjadi sepenuhnya interaktif. Namun, untuk menggunakan SmartDocs dengan portal, Anda harus menginstal SmartDocs di Edge terlebih dahulu.

  • Jika Anda menghubungkan portal ke penginstalan Edge Cloud, SmartDocs sudah terinstal dan tidak diperlukan konfigurasi lebih lanjut.
  • Jika menghubungkan portal ke Edge untuk penginstalan Private Cloud, Anda harus memastikan bahwa SmartDocs diinstal di Edge. Untuk mengetahui informasi selengkapnya tentang cara menginstal Edge dan SmartDocs, lihat Menginstal SmartDocs.

Untuk informasi selengkapnya tentang SmartDocs, lihat Menggunakan SmartDocs untuk mendokumentasikan API.

11. Bagaimana selanjutnya?

Langkah berikutnya setelah Anda menginstal portal Layanan Developer adalah mengonfigurasi dan menyesuaikannya untuk kebutuhan khusus Anda. Dokumentasi di situs web Apigee berisi semua informasi tentang cara mengonfigurasi, menata gaya, dan mengelola portal. Akses dokumentasinya di http://apigee.com/docs/developer-services/content/what-developer-portal.

Tabel berikut mencantumkan beberapa tugas paling umum yang Anda lakukan setelah penginstalan, dan menyertakan link ke dokumentasi Apigee yang dapat Anda gunakan untuk menemukan informasi lebih lanjut:

Tugas

Deskripsi

Menyesuaikan tema

Tema menentukan tampilan portal, termasuk warna, gaya, dan aspek visual lainnya.

Menyesuaikan tampilan

Halaman beranda mencakup menu utama, pesan selamat datang, header, footer, dan judul.

Menambahkan dan mengelola akun pengguna

Proses pendaftaran mengontrol cara developer baru mendaftarkan akun di portal. Misalnya, apakah developer baru mendapatkan akses langsung ke portal, atau apakah mereka harus diverifikasi oleh administrator. Proses ini juga mengontrol cara administrator portal diberi tahu saat akun baru dibuat.

Mengonfigurasi email

Portal tersebut mengirim email sebagai tanggapan terhadap peristiwa tertentu. Misalnya, saat developer baru mendaftar di portal dan saat developer kehilangan sandi.

Menambahkan dan mengelola akun pengguna

Tambahkan halaman Persyaratan & Ketentuan yang harus disetujui developer sebelum diizinkan untuk mengakses portal.

Menambahkan dan mengelola akun pengguna

Portal ini menerapkan model otorisasi berbasis peran. Sebelum mengizinkan developer untuk mendaftar, tentukan izin dan peran yang digunakan oleh portal.

Menambahkan postingan blog dan forum

Portal ini memiliki dukungan bawaan untuk blog dan forum berangkai. Tentukan izin yang diperlukan untuk melihat, menambahkan, mengedit, dan menghapus postingan blog dan forum.

Pastikan Anda melakukan pencadangan database

Pastikan Anda mencadangkan database Drupal. Perhatikan bahwa karena setiap penginstalan berbeda-beda, Anda bebas menentukan cara terbaik untuk mencadangkan database.

Menyiapkan nama host

Jika tidak menyiapkan nama host di server DNS, Anda selalu dapat mengakses situs melalui alamat IP server. Jika ingin menggunakan nama host, Anda dapat mengonfigurasi DNS untuk server, yang akan berfungsi dengan benar tanpa konfigurasi lain pada penyiapan dasar.

Jika Anda menyiapkan load balancer atau mendapatkan URL yang salah di situs karena alasan lain, Anda dapat menetapkan $base_url dalam file settings.php Portal Dev, yang secara default terletak di direktori /var/www/html/sites/default.