开发者服务门户安装

开发者服务门户 v. 4.16.05

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

在继续安装之前,请备份整个 Drupal Web 根目录。默认安装位置为 /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. 切换到新目录,然后下载开发者渠道服务 DeveloperServices_x.y.z.tar 文件,其中 x.y.z 对应于门户版本号。
    4. 使用以下命令解压缩开发者渠道服务 .tar 文件的内容:
      > tar -xvf <tar file>
    5. 使用 cd 命令转到 DeveloperServices-4.x.y.z。
    6. 使用以下命令创建门户 .tar.gz 文件:
      > ./non-networked-install.sh

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

    其中,EMAIL 和 PASSWORD 是 ORGNAME 的管理员的电子邮件地址和密码。

    请务必指定特定于 Edge 安装的主机名和端口号。端口 8080 是 Edge 使用的默认端口。如果您要连接到云中的组织,则请求网址为:
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    如果成功,此命令将返回类似于以下内容的响应:
    {
    "createdAt" : 1348689232699,
    "createdBy" : "USERNAME",
    "displayName" : "cg",
    "environments" : [ "test", "prod" ],
    "lastModifiedAt" : 1348689232699,
    "lastModifiedBy" : "foo@bar.com",
    "name" : "cg",
    "properties" : {
    "property" : [ ]
    },
    "type" : "trial"
    }

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

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

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

      您可以在浏览器中通过 Apigee 发送给您的链接下载文件,也可以复制该链接,然后将其添加到以下 cURL 命令中:
      > curl -kOL <paste link here>
    2. 使用以下命令解压缩开发者渠道服务 .tar 文件的内容:
      > tar -xvf <tar file>
    3. 使用 cd 命令转到 DeveloperServices-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_address 或 http://DNS_name。

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

    注意:通常,您已经配置了主机名并将其注册到 DNS 服务器,因此您不必使用 http://localhost。
  7. 配置与 MySQL 的连接。如果 MySQL 位于远程机器上,请展开高级选项部分,输入该机器的连接信息,然后选择保存并继续。
  8. 通过输入以下信息来配置与 Apigee 端点的连接,然后选择保存:
    如需详细了解这些值,请参阅开发者服务门户要求中的“开始安装之前所需的信息”。
    1. 开发者门户组织
    2. Dev Portal Endpoint URL(开发者门户端点网址)
    3. 端点经过身份验证的用户
    4. 经过身份验证的用户的密码
  9. 出现提示时,选择安装示例 SmartDocs WADL 按钮以安装示例 SmartDocs WADL。如果您跳过此步骤,则示例 SmartDocs API 将不会显示在您的门户中。
    注意:如果您的门户连接到 Apigee Edge for Private Cloud 的安装,并且该 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/configuring-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 为 Developer Channel Services 安装创建管理员用户。 默认情况下,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 的 root 密码设置为默认值(即空白)。

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

> mysqladmin -u root password NEWPASSWORD

如果您之前设置了根密码并想要更改该密码,请使用以下命令:

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

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

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

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

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

> drush pm-info update

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

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

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

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

    此脚本会设置根密码,并为您提供以下选项:将根访问权限限制为仅限 localhost,以及移除默认创建的测试数据库和匿名用户。强烈建议在生产服务器上运行此脚本。
  2. 如果公司政策有要求,请启用并配置 SELinux。

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

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

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

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

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

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

Apache HTTP Server 使用 mod_ssl 模块通过 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 安装,则 SmartDocs 已安装,无需进一步配置。
  • 如果您要将门户连接到 Edge for Private Cloud 安装,则必须确保在 Edge 上安装了 SmartDocs。如需详细了解如何安装 Edge 和 SmartDocs,请参阅安装 SmartDocs。

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

11. 接下来呢?

安装 Developer Services 门户后,下一步是根据您的特定要求对其进行配置和自定义。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 目录中。