开发者服务门户安装

适用于私有云的 Edge v. 4.17.09

在安装之前，请确保：

  • 您应先安装 Postgres，然后再安装门户。你可以将 Postgres 作为 或独立安装 Postgres 以供门户使用。
    • 如果您独立安装 Postgres，它可以与门户位于同一节点上。
    • 如果您要连接到作为 Edge 的一部分安装的 Postgres，并且已配置了 Postgres 在主/备用模式下，指定主 Postgres 服务器的 IP 地址。
  • 您在受支持的 Red Hat 的 64 位版本上执行安装 Enterprise Linux、CentOS 或 Oracle。请参阅支持的软件和支持的版本，了解受支持的版本列表。
  • 已安装 Yum。

安装程序仅包含由 Drupal 提供的模块，这些模块在 Apigee Developer Services 门户（简称门户）。如需了解如何安装其他贡献模块，请参阅 扩展 Drupal 7。

安装概览

在节点上安装 Edge apigee-setup 实用程序后，使用 实用程序在节点上安装门户。apigee-setup 实用程序采用以下格式：

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

将配置文件传递给 apigee-setup 实用程序，其中包含 有关安装的信息如果配置文件缺少任何必需的 apigee-setup 实用程序会提示您在命令行中输入代码。

唯一的要求是配置文件必须可供 “apigee”用户。

例如，使用以下命令安装门户：

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

请参阅安装 Edge apigee-setup 实用程序 。

创建配置文件

以下是门户安装的静默配置文件示例。修改此文件 。使用 -f 选项通过 setup.sh 添加此文件。

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres. 
PG_NAME=devportal 

# Specify the Postgres admin credentials. 
# The portal connects to Postgres by using the 'apigee' user. 
# If you changed the Postgres password from the default of 'postgres' 
# then set PG_PWD accordingly. 
# If connecting to a Postgres node installed with Edge, 
# contact the Edge sys admin to get these credentials. 
PG_USER=apigee 
PG_PWD=postgres 

# The IP address of the Postgres server. 
# If it is installed on the same node as the portal, specify that IP. 
# If connecting to a remote Postgres server,specify its IP address. 
PG_HOST=$IP1 

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# You must configure the SMTP server used by the portal. 
# The properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. 测试与 Apigee Edge 的连接

执行以下 c网址 命令，测试与边缘管理服务器的连接 从门户服务器上的命令提示符中输入以下内容：

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

或者：

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/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"
}

2. 移除 7.0 之前的 PHP 版本

在启动 安装。如果存在 7.0 之前的 PHP 版本，系统会显示以下警告消息：

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

使用以下命令移除 PHP 软件包：

yum remove <package-name>

3. 安装 Postgres

该门户需要先安装 Postgres，然后才能安装该门户。您可以执行以下任一操作 在安装 Edge 时安装 Postgres，或单独安装 Postgres 以供 。

  • 如果您要连接到作为 Edge 的一部分安装的 Postgres，并在 在主/备用模式下，指定主 Postgres 服务器的 IP 地址。
  • 如果您独立安装 Postgres，它可以与门户位于同一节点上。

如需了解如何在安装 Edge 时安装 Postgres，请参阅在节点上安装 Edge 组件。

如需独立安装 Postgres，请执行以下操作：

  1. 使用 或非互联网过程。如需了解更多详情，请参阅安装 Edge apigee-setup 实用程序。 。
  2. 为 Postgres 创建一个配置文件，如下所示：

    # 必须解析为 IP 地址或 DNS 主机名称 - 而不是 127.0.0.1 或 localhost。
    HOSTIP=$(主机名 -i)

    # Postgres 的 Pod 和区域。请使用下方显示的默认值。
    MP_POD=gateway
    REGION=dc-1

    # 设置 Postgres 密码。默认值为“postgres”。
    PG_PWD=postgres
  3. 在命令提示符处，运行设置脚本以安装 Postgres：
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

    “-p pdb”选项指定安装 Postgre。

    配置文件必须可供“apigee”访问或读取用户。

4. 安装门户

如需安装门户，请执行以下操作：

  1. 安装 Edge apigee-setup 实用程序， 使用互联网或非互联网过程的节点。如需了解更多详情，请参阅安装 Edge apigee-setup 实用程序。 。
  2. 确保您已安装 Postgres（独立安装或作为 Postgres 的一部分） 安装 Edge。
  3. 在命令提示符下，运行设置脚本：
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    “-p dp”选项指定安装门户。

    配置文件必须可供“apigee”访问或读取用户。
  4. 前往门户首页（位于 http://localhost:8079）或 你的门户
  5. 使用您在配置文件中设置的管理员凭据登录门户， 请确保门户运行正常
  6. 选择报告 >状态报告，以确保 可以查看门户的当前状态。

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

要接收 Drupal 更新的通知，请确保已打开 Drupal 更新管理器模块 。从 Drupal 菜单中选择 Modules 并向下滚动到 更新管理器模块。如果未启用，请启用。

启用后，您可以使用报告 >可用 更新菜单项。您还可以使用以下 Drush 命令：

> drush pm-info update

您必须从网站的根目录运行此命令。默认情况下，开发者 门户安装在 /opt/apigee/apigee-drupal/wwwroot。因此， 您应该先将目录更改为 /opt/apigee/apigee-drupal/wwwroot， 运行命令。如果您未在默认目录中安装门户，请改用您的 安装目录中。

使用报告 >可用更新 >Settings 菜单项进行配置 该模块在有可用更新时向您发送电子邮件，并设置检查 更新。

6. 配置 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。

7. 安装 SmartDocs（可选）

借助 SmartDocs，您可以在开发者服务门户上记录 API，并且 API 文档提供全面互动。但是，要通过该门户使用 SmartDocs，您必须先 在 Edge 上安装 SmartDocs。

  • 如果您要将门户连接到 Edge Cloud 安装，则 SmartDocs 已经 无需进一步配置。
  • 如果要将门户连接到 Edge 以进行私有云安装，您必须确保 SmartDocs 已安装在 Edge 上。如需详细了解如何安装 Edge 和 SmartDocs，请参阅安装 SmartDocs。

您还必须在该门户上启用 SmartDocs。有关 SmartDocs 的详情，请参阅使用 SmartDocs 进行记录 API。

8. 配置 适用于非互联网安装的 JQuery 更新模块（可选）

如果您在非互联网安装中安装和使用 JQuery 更新模块，则需要 将模块配置为使用 JQuery 的本地版本。如果您将模块配置为使用 CDN 非互联网安装，它将尝试访问 CDN，并导致网页出现延迟 正在加载。如需详细了解 JQuery 更新模块，请参阅 https://www.drupal.org/project/jquery_update。

要将 JQuery 更新模块配置为使用 JQuery 的本地版本，请执行以下操作：

  1. 以拥有管理员或内容创建权限的用户身份登录门户。
  2. 选择配置 >制作 >Drupal 菜单中的 JQuery 更新。
  3. 点击左侧导航栏中的效果。
  4. 在 JQuery 和 JQuery 界面 CDN 下拉菜单中，选择无。
  5. 点击 Save configuration（保存配置）。

9. 接下来该怎么做？

安装开发者服务门户后，您需要配置和自定义 以满足您的特定要求。Apigee 网站上的文档介绍了 了解如何配置和管理门户的样式。访问 http://apigee.com/docs/developer-services/content/what-developer-portal 访问相关文档。

下表列出了安装后执行的一些最常见任务。 中提供了指向 Apigee 文档的链接，您可以在文档中了解更多信息：

任务 说明

自定义主题背景

主题定义门户的外观，包括颜色、样式和其他 视觉元素。

自定义 外观

首页包括主菜单、欢迎信息、页眉、页脚和标题。

将和 管理用户账号

注册流程控制新开发者在 。例如，新开发者是可以立即访问该门户，还是 必须经过管理员验证。此流程还会控制 系统会在您创建新账号后通知管理员。

配置 电子邮件地址

该门户会针对某些事件发送电子邮件。例如，当新的 在开发者门户上注册，以及当开发者丢失密码时，

将和 管理用户账号

添加字词和开发者必须接受相关条件页面后才能执行以下操作： 访问门户网站

将和 管理用户账号

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

添加博客和 论坛帖子

该门户本身就支持博客和会话式论坛。定义权限 查看、添加、修改和删除博客和论坛帖子的权限。

确保正在进行数据库备份

确保您备份了 Drupal 数据库。请注意，由于每 不同的安装方式，则由您自己决定如何以最佳方式备份 数据库。

注意：备份和迁移模块与 Postgres 不兼容 数据库。

另请参阅备份门户。

设置主机名

如果您没有在 DNS 服务器中设置主机名，则随时可以通过 服务器 IP 地址如果您想使用主机名，可以配置 DNS， 服务器，因此在基本设置中无需任何其他配置即可正常工作。

如果您设置了负载平衡器，或在网站上收到错误的网址， 您也可以在以下文件中设置 $base_url： 

/opt/apigee/apigee-drupal-devportal-opdk_version/source/conf/settings.php

如果您升级门户，此值将被覆盖。
自定义开发 您可能还需要通过自定义代码来扩展门户的功能， 主题。为此，请按照 Drupal 的模块中所述创建您自己的 Drupal 模块 开发主题，并将模块放在 /sites/all/modules 中。 目录。