开发者服务门户安装

开发者服务门户 v. 4.16.05

请按以下步骤安装开发者渠道服务门户。

在继续安装之前,请备份整个 Drupal 网站根目录。默认安装位置是 /var/www/html,但您可能是在安装时更改了它。执行下述安装步骤后,您可以从备份恢复自定义设置。

1. 获取开发者渠道服务包

转到 http://community.apigee.com/content/apigee-customer-support,然后选择“登录支持门户”以通过以下两种方式之一请求开发者渠道服务 .tar 文件:

  • 请求访问 Edge for Private Cloud 下载目录。
  • 请求指向开发者渠道服务 .tar 文件的网址。

2. 确保您的系统符合系统要求

在安装门户之前,您的服务器必须满足以下要求:

  1. 确保您在受支持的 Red Hat Enterprise Linux、CentOS 或 Oracle 版本的 64 位版本上安装。请点击此处查看支持的版本列表。
  2. 确保已安装 Yum。
  3. (在没有互联网连接的服务器上安装)您必须先将所有必要的文件作为单个 .tar.gz 文件下载到具有互联网连接的服务器上。然后,您可以在没有互联网连接的情况下将该 .tar.gz 文件复制到服务器,以执行安装。
    1. 以 root 或超级用户身份登录具有互联网连接的服务器。
    2. 为安装文件创建一个目录,例如 portal_tar
    3. 将 CD 保存到新目录并下载开发者渠道服务 DeveloperServices_x.y.z.tar 文件,其中 x.y.z 对应于门户版本号。
    4. 使用以下命令提取开发者渠道服务 .tar 文件的内容:
      > tar -xvf <tar file>
    5. CD CDServices-4.x.y.z。
    6. 使用以下命令创建门户 .tar.gz 文件:
      > ./non-networked-install.sh

      该命令会将所有必要文件下载到一个 .tar.gz 文件中。然后将该 .tar.gz 文件复制到未连接到互联网的服务器以完成安装。
  4. 在门户服务器上的命令提示符处执行以下 c网址 命令,以测试与边缘管理服务器的连接:
    > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

    其中,EMAIL 和电子邮件的密码密码

    请务必指定特定于 Edge 安装的主机名和端口号。端口 8080 是 Edge 使用的默认端口。。















3. 使用自动安装脚本安装开发者渠道服务

请按以下步骤使用自动安装脚本安装门户。此过程适用于无论是否具有外部互联网连接的服务器。

  1. 以根用户身份或超级用户身份登录服务器。
  2. 为安装文件创建一个目录,例如 portal
  3. 在连接到互联网的服务器上
    1. 将 CD 保存到新的门户目录,并下载开发者渠道服务 DeveloperServices_x.y.z.tar 文件,其中 x.y.z 对应于门户版本号。

      您可以从 Apigee 在浏览器中向您发送的链接中下载文件,或复制该文件并将其添加到以下 c网址 命令中:
      > curl -kOL <paste link here>
    2. 使用以下命令提取开发者渠道服务 .tar 文件的内容:
      > tar -xvf <tar file>
    3. CD CDServices-4.x.y.z。
    4. 使用以下命令运行安装脚本:
      > ./networked-install.sh
  4. 在未连接到互联网的服务器上
    1. 复制您在上文第 2 步中创建的 .tar.gz 文件。确保您的系统符合系统要求。
    2. 使用以下命令提取 .tar.gz 文件的内容:
      > tar -xvf <tar file>
    3. CD 到 tar 命令创建的目录。
    4. 设置对 install-from-rpm-bundle.sh 脚本的权限:
      > chmod 755 install-from-rpm-bundle.sh
    5. 使用以下命令运行 install-from-rpm-bundle.sh 脚本:
      > ./install-from-rpm-bundle.sh
  5. 根据提示回答问题。
  6. 安装完成后,在浏览器中浏览服务器网址,例如:
    http://localhost。或者,如果您已配置特定的 IP 或 DNS,请转到 http://IP_addresshttp://DNS_name

    系统会将您重定向到 Apigee 配置文件数据库配置页面。

    注意:通常情况下,您已经配置了一个主机名,并在 DNS 服务器上注册该主机名,这样您就不必使用 http://localhost
  7. 配置与 MySQL 的连接。如果 MySQL 位于远程机器上,请展开高级选项部分,输入该机器的连接信息,然后选择保存并继续
  8. 输入以下信息,配置与 Apigee 端点的连接,然后选择保存
    如需详细了解这些值,请参阅开发者服务门户要求中的“开始安装之前需要提供的信息”。
    1. 开发者门户组织
    2. 开发门户端点网址
    3. 端点经过身份验证的用户
    4. 经过身份验证的用户的密码
  9. 出现提示时,选择安装示例 SmartDocs WADL 按钮以安装示例 SmartDocs WADL。如果跳过此步骤,示例 SmartDocs API 将不会在您的门户中显示。
    注意:如果您的门户连接到了适用于私有云的 Apigee Edge 安装,并且该边缘未安装互联网连接,那么您必须先对 SmartDocs 模块进行额外的配置,然后才能使用 SmartDocs。如需详细了解 SmartDocs,请参阅 http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis
  10. 配置 SMTP 服务器设置。Apigee 会要求您将 SMTP 服务器配置为从门户发送电子邮件。
    如需了解详情,请参阅 http://apigee.com/docs/developer-services/content/configure-email
  11. 输入以下信息来配置管理员用户,然后选择保存。请注意,Drupal 默认创建一个名为“admin”的管理员用户,因此请勿使用“admin”作为用户名。
    如果您跳过此步骤,则仍可使用 Drush 来创建管理员(如下文 4 中所述)。创建管理员用户。
    1. 开发者的名字和姓氏
    2. 开发者门户用户名
    3. 密码
    4. 电子邮件地址
  12. 安装完成后,在 settings.php 文件中设置权限:
    > chmod 640 /var/www/html/sites/default/settings.php
  13. 访问门户首页(网址为 http://localhost/)或门户的 DNS 名称。
  14. 使用管理员凭据登录门户。

4. 创建管理员用户

使用 Drush 为您的开发者渠道服务安装创建管理员用户。 默认情况下,Drupal 会自动创建一个名为“admin”的管理员用户,因此请勿使用“admin”作为用户名。

  1. CD 到您的 drupal_root/sites/default 目录。Drupal 根目录的标准位置为 /var/www/html:
    > cd <drupal_root>/sites/default
  2. 确保您对私有 Drupal 文件具有写入权限:
    > drush vget file_private_path

    此命令会返回私有 Drupal 文件的路径,例如:
    file_private_path: 'sites/default/private'

    对应于 /var/www/html/sites/default/private/。使用以下命令可以确保此目录可由所有者和群组写入:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. 输入以下命令以创建管理员用户,并将“< >”中的命令替换为您的值:
    > drush user-create <username> --mail"></email-address>" --password"></password>"
    > drush user-add-role Administrator <username>
  4. 使用上面指定的用户名和密码,以管理员身份登录开发者门户。

5. 设置 MySQL 根密码

如果您在门户安装期间安装了 MySQL,则安装脚本会将 MySQL 根密码设置为默认值(为空)。

使用以下命令设置根密码:

> mysqladmin -u root password NEWPASSWORD

如果您之前已设置根密码并想进行更改,请使用以下命令:

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

您还必须在 /var/www/html/sites/default/settings.php 文件中更新密码。

6. 确保已启用更新管理器模块

如需接收 Drupal 更新通知,请确保已启用 Drupal Update 管理器模块。从 Drupal 菜单中,选择 Modules,然后向下滚动到 Update manager 模块。如果未启用,请启用。

启用后,您可以使用报告 > 可用更新菜单项来查看可用更新。您也可以使用以下 Drush 命令:

> drush pm-info update

使用报告 > 可用更新 > 设置菜单项,将模块配置为在有可用更新时向您发送电子邮件,并设置检查更新的频率。

7. 可选 - 在生产服务器上部署

如果您要在生产服务器上部署门户,则应执行额外的安全步骤,包括:

  1. 运行以下脚本以保护您的 MySQL 安装:
    > /usr/bin/mysql_secure_installation

    此脚本 可设置根密码,并允许您将 root 访问权限限制为仅限 localhost,并移除默认创建的测试数据库和匿名用户。强烈建议生产服务器运行此脚本。
  2. 如果贵公司政策有要求,请启用和配置 SELinux。

8. 可选 - 配置 Apache Solr 搜索引擎

默认情况下,在安装门户时,连接到 Apache Solr 搜索引擎的 Drupal 模块处于停用状态。大多数门户都使用内部 Drupal 搜索引擎,因此不需要 Drupal Solr 模块。

如果您决定使用 Solr 作为搜索引擎,则必须在服务器上本地安装 Solr,然后在该门户上启用和配置 Drupal Solr 模块。

如需启用 Drupal Solr 模块,请执行以下操作:

  1. 以拥有管理员权限或内容创建权限的用户登录门户。
  2. 在 Drupal 菜单中选择 Modules
  3. 启用 Apache Solr Framework 模块和 Apache Solr Search 模块。
  4. 保存更改。
  5. 按照 https://drupal.org/node/1999280 中的说明配置 Solr。

9. 可选 - 安装 mod_ssl 以支持 HTTPS

mod_ssl 模块由 Apache HTTP Server 用于通过 HTTPS 提供网页。如果您想使用 HTTPS,请使用以下命令安装 mod_ssl

> yum install mod_ssl

如需详细了解如何将门户配置为使用 SSL,请参阅 http://apigee.com/docs/developer-services/content/using-ssl-portal

10. 可选 - 安装 SmartDocs

借助 SmartDocs,您可以在开发者服务门户上以能够让 API 文档实现完全互动的方式记录您的 API。不过,如需通过门户使用 SmartDocs,您必须先在 Edge 上安装 SmartDocs。

  • 如果您要将门户连接到 Edge Cloud 安装,则智能文档已安装,无需进一步配置。
  • 如要将该门户连接到适用于私有云的 Edge,则必须确保 SmartDoc 安装在 Edge 上。如需详细了解如何安装 Edge 和 SmartDocs,请参阅安装 SmartDocs

如需详细了解 SmartDocs,请参阅使用 SmartDocs 记录 API

11. 下一步做什么?

安装开发者服务门户后,下一步是针对您的具体需求进行配置和自定义。Apigee 网站上的文档包含有关如何配置门户、设置门户样式以及设置门户的所有信息。如需查看相关文档,请访问 http://apigee.com/docs/developer-services/content/what-developer-portal

下表列出了您在安装后执行的一些最常见任务,并包含指向 Apigee 文档的链接,供您了解详情:

任务

说明

自定义主题

主题用于定义门户的外观,包括颜色、样式和其他视觉方面。

自定义外观

首页包含主菜单、欢迎辞、页眉、页脚和标题。

添加和管理用户帐号

注册流程控制新开发者如何在门户上注册帐号。例如,新开发者是否可以立即访问该门户,或者是否必须经过管理员验证。此过程还可控制门户管理员在创建新帐号时如何获得通知。

配置电子邮件

门户会针对特定事件发送电子邮件。例如,当新开发者在门户上注册以及开发者丢失密码时。

添加和管理用户帐号

添加条款及条件页面,开发者必须先接受此页面才能访问门户。

添加和管理用户帐号

门户实现基于角色的授权模型。在允许开发者注册之前,请定义门户使用的权限和角色。

添加博客和论坛帖子

门户内置了对博客和话题式论坛的支持。定义查看、添加、修改和删除博文和论坛帖子所需的权限。

确保执行数据库备份

确保您备份了 Drupal 数据库。请注意,由于每次安装都是不同的,您需要决定如何备份数据库。

设置主机名

如果您没有在 DNS 服务器中设置主机名,则可以随时通过服务器的 IP 地址访问网站。如果您想使用主机名,可以为服务器配置 DNS,在没有基本配置的情况下,无需任何其他配置即可正常运行。

如果您设置负载平衡器,或由于其他原因而在您的网站上显示了错误的网址,您可以在开发门户 settings.php 文件中设置 $base_url,该文件默认位于 /var/www/html/sites/default 目录中。