开发者服务门户安装

适用于私有云的 Edge v. 4.17.01

安装前，请确保：

• 您需要先安装 Postgres，然后才能安装门户。您可以在安装 Edge 的过程中安装 Postgres，也可以独立安装 Postgres 以供门户使用。
  • 如果您单独安装 Postgres，则可以将其安装在门户所在的节点上。
  • 如果您要连接到作为 Edge 的一部分安装的 Postgres，并且 Postgres 配置为主/备用模式，请指定主 Postgres 服务器的 IP 地址。
• 您是在受支持版本的 Red Hat Enterprise Linux、CentOS 或 Oracle 的 64 位版本上执行安装。如需查看支持的版本列表，请参阅支持的软件和支持的版本。
• 已安装 Yum。

安装概览

在节点上安装 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. 移除 PHP 7.0 之前的版本

在开始安装之前，安装脚本会检查系统上是否存在 7.0 之前版本的 PHP。如果存在 PHP 7.0 之前的版本，系统会显示以下警告消息：

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

对于 CentOS 和 RedHat Enterprise Linux (RHEL)，请使用以下命令移除 PHP 软件包：

yum remove <package-name>

3. 安装 Postgres

您需要先安装 Postgres，然后才能安装门户。您可以在安装 Edge 的过程中安装 Postgres，也可以独立安装 Postgres 以供门户使用。

• 如果您要连接到作为 Edge 的一部分安装的 Postgres，并且 Postgres 配置为主/备用模式，请指定主 Postgres 服务器的 IP 地址。
• 如果您单独安装 Postgres，则可以将其安装在门户所在的节点上。

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

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

1. 在使用互联网或非互联网过程的节点上安装 Edge apigee-setup 实用程序。如需了解详情，请参阅安装 Edge apigee-setup 实用程序。
2. 为 Postgres 创建一个配置文件，如下所示：
   
   # The pod and region of Postgres. 使用下方显示的默认值。
   MP_POD=gateway
   REGION=dc-1
   
   # Set the Postgres password. 默认值为“postgres”。
   PG_PWD=postgres
3. 在命令提示符中，运行设置脚本以安装 Postgres：
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   “-p pdb”选项用于指定安装 Postgres。
   
   配置文件必须可供“apigee”用户访问或读取。

4. 安装门户

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

1. 使用互联网或非互联网流程在节点上安装 Edge apigee-setup 实用程序。如需了解详情，请参阅安装 Edge apigee-setup 实用程序。
2. 确保您已安装 Postgres，无论是独立安装 Postgres，还是在安装 Edge 时安装 Postgres。
3. 在命令提示符中，运行设置脚本：
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   “-p dp”选项用于指定安装门户。
   
   配置文件必须可供“apigee”用户访问或读取。
4. 前往 http://localhost:8079 或门户的 DNS 名称，访问门户首页。
5. 使用您在配置文件中设置的管理员凭据登录门户。

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

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

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

> drush pm-info update

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

依次选择 Reports > Available Updates > Settings 菜单项，配置模块以便在有更新时向您发送电子邮件，并设置检查更新的频率。

6. 配置 Apache Solr 搜索引擎（可选）

默认情况下，安装门户后，连接到 Apache Solr 搜索引擎的 Drupal 模块会被停用。大多数门户使用内部 Drupal 搜索引擎，因此不需要 Drupal Solr 模块。

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

如需启用 Drupal Solr 模块，请执行以下操作：

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

7. 安装 SmartDocs（可选）

借助 SmartDocs，您可以采用让 API 文档完全互动的形式在开发者服务门户上记录您的 API。但是，如需将 SmartDocs 与门户搭配使用，您必须先在 Edge 上安装 SmartDocs。

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

您还必须在该门户上启用 SmartDocs。如需详细了解 SmartDocs，请参阅使用 SmartDocs 记录 API。

8. 接下来该怎么做？

安装开发者服务门户后，您的后续步骤是根据您的具体需求对其进行配置和自定义。Apigee 网站上的文档包含有关配置、设置样式和管理门户的所有信息。访问 http://apigee.com/docs/developer-services/content/what-developer-portal 访问相关文档。

下表列出了您在安装后执行的一些最常见任务，并包含指向 Apigee 文档的链接，您可以通过这些链接了解详情：

任务	说明
自定义主题	主题定义了门户的外观，包括颜色、样式和其他视觉方面。
自定义外观	首页包括主菜单、欢迎消息、标题、页眉和页脚。
添加和管理用户账号	注册流程用于控制新开发者在门户上注册账号的方式。例如，新开发者是否可以立即访问该门户，还是必须由管理员进行验证。此流程还会控制在创建新账号时向门户管理员发送通知的方式。
配置电子邮件	该门户会针对某些事件发送电子邮件。例如，当新开发者在门户上注册时，以及当开发者丢失密码时。
添加和管理用户账号	添加“条款及条件”页面，开发者必须先接受这些条款及条件，然后才能访问该门户。
添加和管理用户账号	该门户实现了基于角色的授权模型。在允许开发者注册之前，请先定义门户使用的权限和角色。
添加博文和论坛帖子	该门户本身就支持博客和会话式论坛。定义查看、添加、修改和删除博客和论坛帖子所需的权限。
确保您正在进行数据库备份	确保您正在备份 Drupal 数据库。请注意，由于每种安装方式各不相同，因此您可以自行确定最佳数据库备份方式。 注意：备份和迁移模块与 Postgres 数据库不兼容。 另请参阅如何执行备份。
设置主机名	如果您未在 DNS 服务器中设置主机名，则可以随时通过服务器的 IP 地址访问网站。如果您想使用主机名，可以为服务器配置 DNS，在基本设置中，无需任何其他配置，DNS 应该就能正常运行。 如果您设置了负载平衡器，或者您的网站因其他原因收到了错误的网址，则可以在开发者门户的 settings.php 文件中设置 $base_url，该文件默认位于 /opt/apigee/apigee-drupal/sites/default 目录中。
自定义开发	您还可以使用主题之外的自定义代码扩展门户的功能。为此，请按照 Drupal 的模块开发主题中的说明创建您自己的 Drupal 模块，然后将该模块放在 /sites/all/modules 目录中。