Cài đặt cổng dịch vụ dành cho nhà phát triển

Cổng dịch vụ dành cho nhà phát triển phiên bản 4.16.05

Hãy làm theo các bước sau để cài đặt cổng Dịch vụ kênh dành cho nhà phát triển.

Trước khi tiếp tục cài đặt, hãy sao lưu toàn bộ thư mục gốc của trang web Drupal. Vị trí cài đặt mặc định là /var/www/html, nhưng bạn có thể đã thay đổi vị trí này tại thời điểm cài đặt. Sau khi thực hiện các bước cài đặt như mô tả bên dưới, bạn có thể khôi phục các nội dung tuỳ chỉnh của mình từ bản sao lưu.

1. Tải gói Dịch vụ kênh dành cho nhà phát triển

Truy cập http://community.apigee.com/content/apigee-customer-support rồi chọn Đăng nhập vào Cổng hỗ trợ của bạn để yêu cầu tệp .tar Dịch vụ kênh dành cho nhà phát triển theo một trong hai cách:

  • Yêu cầu quyền truy cập vào thư mục tải xuống Edge for Private Cloud.
  • Yêu cầu URL tới tệp .tar của Dịch vụ kênh dành cho nhà phát triển.

2. Đảm bảo rằng hệ thống của bạn đáp ứng các yêu cầu về hệ thống

Trước khi bạn cài đặt cổng thông tin, máy chủ của bạn phải đáp ứng các yêu cầu sau:

  1. Đảm bảo rằng bạn đang thực hiện cài đặt trên phiên bản 64 bit của một phiên bản được hỗ trợ của Red Hat Enterprise Linux, CentOS hoặc Oracle. Xem danh sách các phiên bản được hỗ trợ tại đây.
  2. Đảm bảo bạn đã cài đặt Yum.
  3. (Để cài đặt trên một máy chủ không có kết nối Internet) Trước tiên, bạn phải tải tất cả các tệp cần thiết xuống một máy chủ có kết nối Internet dưới dạng một tệp .tar.gz duy nhất. Sau đó, bạn sao chép tệp .tar.gz đó vào máy chủ mà không cần kết nối Internet để cài đặt.
    1. Đăng nhập vào máy chủ có kết nối Internet với vai trò là cấp độ gốc hoặc siêu người dùng.
    2. Tạo một thư mục cho các tệp cài đặt, chẳng hạn như portal_tar.
    3. CD vào thư mục mới rồi tải tệp DeveloperServices_x.y.z.tar của Dịch vụ kênh nhà phát triển, trong đó x.y.z tương ứng với số phiên bản của cổng thông tin.
    4. Trích xuất nội dung của tệp .tar trên Dịch vụ kênh dành cho nhà phát triển bằng lệnh:
      > tar -xvf <tar file>
    5. CD sang DeveloperServices-4.x.y.z.
    6. Tạo tệp .tar.gz của cổng bằng cách dùng lệnh:
      > ./non-networked-install.sh

      Lệnh này sẽ tải tất cả tệp cần thiết xuống rồi tải chúng vào một tệp .tar.gz duy nhất. Sau đó, hãy sao chép tệp .tar.gz đó vào máy chủ không có kết nối Internet để hoàn tất quá trình cài đặt.
  4. Kiểm tra kết nối của bạn với máy chủ quản lý Edge bằng cách thực thi lệnh cURL sau đây từ lời nhắc lệnh trên máy chủ cổng:
    > curl -u {EMAIL}:{passwords} https://{hostname}:8080/v1/organizations/{ORGNAME}

    Trong đó EMAILEMAILEMAIL là địa chỉ email của EMAILEMAIL là địa chỉ email

    Hãy nhớ chỉ định tên máy chủ và số cổng dành riêng cho việc cài đặt Edge. Cổng 8080 là cổng mặc định mà Edge sử dụng. Sửa đổi:















3. Cài đặt Dịch vụ kênh của nhà phát triển bằng tập lệnh cài đặt tự động

Sử dụng quy trình sau để cài đặt cổng thông tin bằng cách sử dụng tập lệnh cài đặt tự động. Quy trình này áp dụng cho máy chủ có hoặc không có kết nối Internet bên ngoài.

  1. Đăng nhập vào máy chủ với tư cách là cấp độ gốc hoặc siêu người dùng.
  2. Tạo thư mục cho các tệp cài đặt, chẳng hạn như cổng thông tin.
  3. Trên máy chủ có kết nối Internet:
    1. CD vào thư mục cổng mới và tải tệp DeveloperServices_x.y.z.tar của Dịch vụ kênh dành cho nhà phát triển, trong đó x.y.z tương ứng với số phiên bản của cổng thông tin.

      Bạn có thể tải một tệp xuống qua đường liên kết mà Apigee gửi cho bạn trong một trình duyệt hoặc bằng cách sao chép tệp đó rồi thêm tệp đó vào lệnh cURL sau:
      > curl -kOL <paste link here>
    2. Trích xuất nội dung của tệp .tar trên Dịch vụ kênh dành cho nhà phát triển bằng lệnh:
      > tar -xvf <tar file>
    3. CD sang DeveloperServices-4.x.y.z.
    4. Chạy tập lệnh cài đặt bằng cách dùng lệnh sau:
      > ./networked-install.sh
  4. Trên máy chủ không có kết nối Internet:
    1. Sao chép tệp .tar.gz mà bạn đã tạo ở trên trong phần 2. Đảm bảo hệ thống của bạn đáp ứng các yêu cầu về hệ thống.
    2. Trích xuất nội dung của tệp .tar.gz bằng lệnh:
      > tar -xvf <tar file>
    3. CD vào thư mục được tạo bằng lệnh tar.
    4. Thiết lập các quyền trên tập lệnh install-from-rpm-bundle.sh:
      > chmod 755 install-from-RPM-bundle.sh
    5. Chạy tập lệnh install-from-rpm-bundle.sh bằng cách dùng lệnh:
      > ./install-from-RPM-bundle.sh
  5. Trả lời các câu lệnh.
  6. Sau khi cài đặt xong, hãy chuyển đến URL máy chủ trong một trình duyệt, chẳng hạn như:
    http://localhost. Hoặc nếu bạn đã định cấu hình IP hoặc DNS cụ thể, hãy truy cập vào http://IP_address hoặc http://DNS_name.

    Bạn sẽ được chuyển hướng đến trang cấu hình Cơ sở dữ liệu hồ sơ Apigee.

    Lưu ý: Thông thường, bạn sẽ định cấu hình một tên máy chủ và đăng ký tên máy chủ đó với máy chủ DNS của mình để không phải sử dụng http://localhost.
  7. Định cấu hình kết nối với MySQL. Nếu MySQL nằm trên một máy từ xa, hãy mở rộng phần Advanced Options (Tuỳ chọn nâng cao) rồi nhập thông tin kết nối vào máy đó, sau đó Chọn Save and continue (Lưu và tiếp tục).
  8. Định cấu hình kết nối với Điểm cuối Apigee bằng cách nhập thông tin sau rồi chọn Lưu:
    Để biết thêm thông tin về các giá trị này, hãy xem phần "Thông tin bắt buộc trước khi bạn bắt đầu cài đặt" tại phần Các yêu cầu của cổng Dịch vụ dành cho nhà phát triển.
    1. Cổng thông tin cho nhà phát triển (đơn vị tổ chức)
    2. URL điểm cuối Cổng thông tin của nhà phát triển
    3. Người dùng được xác thực tại thiết bị đầu cuối
    4. Mật khẩu của người dùng đã xác thực
  9. Khi được nhắc, hãy chọn nút Install Sample SmartDocs WADL để cài đặt WADL mẫu SmartDocs. Nếu bạn bỏ qua bước này, thì ví dụ về API SmartDocs sẽ không xuất hiện trên cổng thông tin của bạn.
    Lưu ý: Nếu cổng thông tin của bạn kết nối với bản cài đặt Apigee Edge for Private Cloud và quá trình cài đặt Edge không có kết nối Internet bên ngoài, thì bạn phải định cấu hình thêm cho mô-đun SmartDocs trước khi có thể sử dụng SmartDocs. Để biết thêm thông tin về SmartDocs, hãy xem http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Định cấu hình Cài đặt máy chủ SMTP. Apigee yêu cầu bạn định cấu hình một máy chủ SMTP để gửi email từ cổng thông tin.
    Để biết thêm thông tin, hãy truy cập http://apigee.com/docs/developer-services/content/configuring-email.
  11. Định cấu hình người dùng quản trị viên bằng cách nhập thông tin sau đây rồi chọn Lưu. Xin lưu ý rằng Drupal tạo một người dùng quản trị có tên là "quản trị viên" theo mặc định, vì vậy, không sử dụng "quản trị viên" làm tên người dùng.
    Nếu bỏ qua bước này, bạn vẫn có thể sử dụng Drush để tạo quản trị viên như mô tả trong phần 4 dưới đây. Tạo người dùng quản trị.
    1. Họ và tên của nhà phát triển
    2. Tên người dùng trên cổng thông tin của nhà phát triển
    3. Mật khẩu
    4. Địa chỉ email
  12. Sau khi cài đặt xong, hãy thiết lập quyền truy cập trên tệp settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. Chuyển đến trang chủ của cổng thông tin tại http://localhost/ hoặc đến tên DNS của cổng thông tin của bạn.
  14. Đăng nhập vào cổng thông tin bằng thông tin đăng nhập của quản trị viên.

4. Tạo người dùng quản trị

Hãy sử dụng Drush để tạo người dùng quản trị cho quá trình cài đặt Dịch vụ kênh dành cho nhà phát triển. Theo mặc định, Drupal tự động tạo một người dùng quản trị có tên là "quản trị viên", vì vậy, không nên dùng "quản trị viên" làm tên người dùng.

  1. CD vào thư mục drupal_root/sites/default của bạn. Vị trí tiêu chuẩn cho thư mục gốc của Drupal là /var/www/html:
    > cd <drupal_root>/sites/default
  2. Đảm bảo rằng bạn có quyền ghi trên các tệp Drupal riêng tư:
    > drush vget file_private_path

    Lệnh này trả về đường dẫn đến các tệp Drupal riêng tư, ví dụ:
    file_private_path: 'sites/default/private'

    Tương ứng với /var/www/html/sites/default/private/. Sử dụng lệnh sau để đảm bảo rằng chủ sở hữu và nhóm có thể ghi thư mục này:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Nhập các lệnh sau để tạo người dùng quản trị, thay thế các lệnh trong “< >” bằng các giá trị của bạn:
    > drush user-create <username> --mail="<email-address>" --password="<password>"
    > drush user-add-role Administrator <username>
  4. Đăng nhập vào cổng thông tin dành cho nhà phát triển với tư cách quản trị viên bằng cách sử dụng tên người dùng và mật khẩu được chỉ định ở trên.

5. Đặt mật khẩu gốc MySQL

Nếu bạn đã cài đặt MySQL trong quá trình cài đặt cổng thông tin, tập lệnh cài đặt sẽ để trống mật khẩu gốc MySQL được đặt về giá trị mặc định và giá trị này sẽ để trống.

Sử dụng lệnh sau để đặt mật khẩu gốc:

> mysqladmin -u root password NEWPASSWORD

Nếu trước đó bạn đã đặt mật khẩu gốc và giờ muốn thay đổi mật khẩu đó, hãy dùng lệnh sau:

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

Bạn cũng phải cập nhật mật khẩu trong tệp /var/www/html/sites/default/settings.php.

6. Đảm bảo rằng bạn đã bật mô-đun Trình quản lý bản cập nhật

Để nhận thông báo về nội dung cập nhật của Drupal, hãy đảm bảo rằng bạn đã bật mô-đun trình quản lý Bản cập nhật Drupal. Trên trình đơn của Drupal, hãy chọn Mô-đun rồi cuộn xuống mô-đun Trình quản lý cập nhật. Nếu chưa bật, hãy bật.

Sau khi bật, bạn có thể xem các bản cập nhật có sẵn bằng cách sử dụng mục trong trình đơn Báo cáo > Nội dung cập nhật có sẵn. Bạn cũng có thể dùng lệnh Drush sau đây:

> drush pm-info update

Sử dụng mục trong trình đơn Báo cáo > Bản cập nhật có sẵn > Cài đặt để định cấu hình mô-đun gửi email cho bạn khi có bản cập nhật và đặt tần suất kiểm tra các bản cập nhật.

7. Không bắt buộc – Triển khai trên máy chủ sản xuất

Nếu đang triển khai cổng thông tin trên máy chủ sản xuất, bạn nên thực hiện các bước bảo mật bổ sung, bao gồm:

  1. Chạy tập lệnh sau để đảm bảo an toàn cho việc cài đặt MySQL:
    > /usr/bin/mysql_secure_installation

    Tập lệnh này đặt mật khẩu gốc và cung cấp cho bạn tuỳ chọn để chỉ cho phép truy cập thư mục gốc vào máy chủ cục bộ và xoá cơ sở dữ liệu kiểm thử cũng như người dùng ẩn danh đã tạo theo mặc định. Bạn nên chạy tập lệnh này đối với máy chủ sản xuất.
  2. Nếu chính sách của công ty bạn yêu cầu, hãy bật và định cấu hình SELinux.

8. Không bắt buộc – Định cấu hình công cụ tìm kiếm Apache Solr

Theo mặc định, các mô-đun Drupal kết nối với công cụ tìm kiếm Apache Solr sẽ bị vô hiệu hóa khi bạn cài đặt cổng. Hầu hết các cổng thông tin đều sử dụng công cụ tìm kiếm nội bộ của Drupal và do đó không yêu cầu mô-đun Drupal Solr.

Nếu quyết định sử dụng Solr làm công cụ tìm kiếm, bạn phải cài đặt Solr cục bộ trên máy chủ của mình, sau đó bật và định cấu hình các mô-đun Drupal Solr trên cổng thông tin.

Cách bật các mô-đun Drupal Solr:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Mô-đun trong trình đơn Drupal.
  3. Bật mô-đun Apache Solr Framework và mô-đun Apache Solr Search.
  4. Lưu các thay đổi.
  5. Định cấu hình Solr như mô tả tại https://drupal.org/node/1999280.

9. Không bắt buộc – Cài đặt mod_SSL để hỗ trợ HTTPS

Mô-đun mod_SSL được Máy chủ Apache HTTP sử dụng để phân phối trang web qua HTTPS. Nếu bạn muốn sử dụng HTTPS, hãy sử dụng lệnh sau để cài đặt mod_ssl:

> yum install mod_ssl

Để biết thêm thông tin về cách định cấu hình cổng thông tin để sử dụng SSL, hãy xem http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Không bắt buộc – Cài đặt SmartDocs

SmartDocs cho phép bạn ghi lại API của mình trên cổng Dịch vụ dành cho nhà phát triển theo cách khiến tài liệu API có khả năng tương tác đầy đủ. Tuy nhiên, để sử dụng SmartDocs với cổng thông tin, trước tiên, bạn phải cài đặt SmartDocs trên Edge.

  • Nếu bạn kết nối cổng với một bản cài đặt Edge Cloud, thì SmartDocs đã được cài đặt và không cần định cấu hình thêm.
  • Nếu đang kết nối cổng thông tin với một Edge để cài đặt đám mây riêng tư, bạn phải đảm bảo rằng SmartDocs được cài đặt trên Edge. Để biết thêm thông tin về cách cài đặt Edge và SmartDocs, hãy xem phần Cài đặt SmartDocs.

Để biết thêm thông tin về SmartDocs, hãy xem phần Sử dụng SmartDocs để ghi tài liệu API.

11. Tiếp theo sẽ là gì?

Các bước tiếp theo sau khi cài đặt cổng Dịch vụ dành cho nhà phát triển là định cấu hình và tuỳ chỉnh cổng thông tin cho các yêu cầu cụ thể của bạn. Tài liệu trên trang web Apigee có mọi thông tin về cách định cấu hình, định kiểu và quản lý cổng thông tin. Truy cập tài liệu tại http://apigee.com/docs/developer-services/content/what-developer-portal.

Bảng sau đây liệt kê một số tác vụ phổ biến nhất mà bạn thực hiện sau khi cài đặt, đồng thời có các đường liên kết đến tài liệu về Apigee để bạn có thể tìm thêm thông tin:

Việc cần làm

Mô tả

Tuỳ chỉnh giao diện

Giao diện xác định giao diện của cổng, bao gồm màu sắc, kiểu và các khía cạnh hình ảnh khác.

Tuỳ chỉnh giao diện

Trang chủ bao gồm trình đơn chính, thư chào mừng, đầu trang, chân trang và tiêu đề.

Thêm và quản lý tài khoản người dùng

Quy trình đăng ký này kiểm soát cách nhà phát triển mới đăng ký tài khoản trên cổng thông tin. Ví dụ: nhà phát triển mới có quyền truy cập ngay vào cổng thông tin hay không, hay họ phải được quản trị viên xác minh. Quy trình này cũng kiểm soát cách quản trị viên cổng thông tin nhận được thông báo khi tài khoản mới được tạo.

Định cấu hình email

Cổng thông tin này gửi email để phản hồi cho một số sự kiện nhất định. Ví dụ: khi một nhà phát triển mới đăng ký trên cổng thông tin và khi nhà phát triển mất mật khẩu của họ.

Thêm và quản lý tài khoản người dùng

Thêm trang Điều khoản và điều kiện mà nhà phát triển phải chấp nhận trước khi được phép truy cập vào cổng thông tin này.

Thêm và quản lý tài khoản người dùng

Cổng thông tin này triển khai mô hình uỷ quyền dựa trên vai trò. Trước khi cho phép nhà phát triển đăng ký, hãy xác định các quyền và vai trò mà cổng sử dụng.

Thêm bài đăng trên blog và diễn đàn

Cổng thông tin được tích hợp sẵn tính năng hỗ trợ cho blog và diễn đàn theo chuỗi. Xác định các quyền cần thiết để xem, thêm, chỉnh sửa cũng như xoá bài đăng trên blog và diễn đàn.

Đảm bảo rằng bạn đang thực hiện sao lưu cơ sở dữ liệu

Đảm bảo rằng bạn đang sao lưu cơ sở dữ liệu của Drupal. Hãy lưu ý rằng vì mỗi lượt cài đặt đều khác nhau nên bạn có quyền quyết định cách tốt nhất để sao lưu cơ sở dữ liệu.

Thiết lập tên máy chủ

Nếu không thiết lập tên máy chủ trong máy chủ DNS, thì bạn luôn có thể truy cập vào trang web qua địa chỉ IP của máy chủ. Nếu muốn sử dụng một tên máy chủ, bạn có thể định cấu hình DNS cho máy chủ. DNS này sẽ hoạt động chính xác mà không cần bất kỳ cấu hình nào khác trong quy trình thiết lập cơ bản.

Nếu đã thiết lập trình cân bằng tải hoặc nhận được URL không chính xác trên trang web của mình vì một số lý do khác, bạn có thể đặt $base_url trong tệp settings.php trên Cổng thông tin cho nhà phát triển, tệp này nằm trong thư mục /var/www/html/sites/default theo mặc định.