Installation du portail de services pour les développeurs

Portail des services pour les développeurs version 4.16.05

Suivez ces étapes pour installer le portail des services de chaînes pour les développeurs.

Avant de procéder à l'installation, effectuez une sauvegarde de l'ensemble de votre racine Web Drupal. . L'emplacement d'installation par défaut est /var/www/html, mais vous l'avez peut-être modifié. au moment de l'installation. Après avoir suivi la procédure d'installation décrite ci-dessous, vous pouvez restaurer votre personnalisées à partir de la sauvegarde.

1. Obtenir le lot de services de chaînes pour les développeurs

Accédez à http://community.apigee.com/content/apigee-customer-support et sélectionnez "Se connecter à votre portail d'assistance" pour demander le fichier .tar Developer Channel Services vous avez deux possibilités:

  • Demandez l'accès au répertoire de téléchargement Edge pour Private Cloud.
  • Demandez une URL vers le fichier .tar des services de chaînes pour les développeurs.

2. Vérifiez que votre système est conforme aux exigences du système configuration requise

Avant d'installer le portail, votre serveur doit disposer de la configuration suivante:

  1. Assurez-vous d'effectuer l'installation sur la version 64 bits d'une version compatible de Red Hat Enterprise Linux, CentOS ou Oracle. Pour consulter la liste des versions compatibles, cliquez ici.
  2. Assurez-vous que Yum est installé.
  3. (Pour une installation sur un serveur sans connexion Internet) Vous devez téléchargez d'abord tous les fichiers nécessaires sur un serveur doté d'une connexion Internet, .tar.gz. Copiez ensuite ce fichier tar.gz sur le serveur sans connexion Internet, effectuer l'installation.
    1. Connectez-vous à un serveur à l'aide d'une connexion Internet, en tant que super-utilisateur ou racine.
    2. Créez un répertoire pour les fichiers d'installation, par exemple portal_tar.
    3. Accédez au nouveau répertoire en CD et téléchargez le fichier DeveloperServices_x.y.z.tar des Services de chaînes pour les développeurs. où x.y.z correspond au numéro de version du portail.
    4. Extrayez le contenu du fichier .tar des services de chaînes pour les développeurs à l'aide de la méthode Commande:
      &gt; tar -xvf <tar file&gt;
    5. CD vers DeveloperServices-4.x.y.z.
    6. Créez le fichier tar.gz du portail à l'aide de la commande suivante:
      &gt; ./non-networked-install.sh

      Cette commande télécharge tous les fichiers nécessaires dans un seul fichier tar.gz. Toi puis copiez ce fichier .tar.gz sur votre serveur sans connexion Internet pour effectuer la l'installation.
  4. Testez votre connexion au serveur de gestion Edge en exécutant la commande cURL suivante à partir d'une invite de commande sur le serveur du portail:
    &gt; curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/v1/organizations/{ORGNAME}

    EMAIL et PASSWORD correspondent à l'adresse e-mail. l'adresse e-mail et le mot de passe de l'administrateur de ORGNAME.

    Veillez à spécifier le nom d'hôte et le numéro de port spécifiques à votre installation d'Edge. Port 8080 est le port par défaut utilisé par Edge. Si vous vous connectez à une organisation dans le cloud, l'URL de la requête est:
    https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}

    Si la commande est bien exécutée, elle renvoie une réponse semblable à la suivante:
    {
    "CreateAt" : 1348689232699,
    "crééPar" : "NOM D'UTILISATEUR",
    &quot;displayName&quot; : "gi",
    "environnements" : [ "test", "prod" ],
    "lastModifiedAt" : 1348689232699,
    "lastModifiedBy" : "foo@bar.com",
    "nom" : "gi",
    "propriétés" : {
    "propriété" : [ ]
    },
    "type" : "essai"
    }

3. Installer le développeur Channel Services à l'aide du script d'installation automatisé

Procédez comme suit pour installer le portail à l'aide du script d'installation automatisée. Ce fonctionne pour les serveurs avec ou sans connexion Internet externe.

  1. Connectez-vous au serveur en tant que racine ou super-utilisateur.
  2. Créez un répertoire pour les fichiers d'installation, par exemple le portail.
  3. Sur un serveur disposant d'une connexion Internet: <ph type="x-smartling-placeholder">
      </ph>
    1. CD vers le nouveau portail et téléchargez le fichier DeveloperServices_x.y.z.tar des services de chaînes pour les développeurs. où x.y.z correspond au numéro de version du portail.

      Vous pouvez télécharger un fichier à partir du lien qui vous a été envoyé par Apigee dans un navigateur ou en le copiant puis en l'ajoutant à la commande cURL suivante:
      &gt; curl -kOL <coller le lien here&gt;
    2. Extrayez le contenu du fichier .tar des services de chaînes pour les développeurs à l'aide de la méthode Commande:
      &gt; tar -xvf <tar file&gt;
    3. CD vers DeveloperServices-4.x.y.z.
    4. Exécutez le script d'installation à l'aide de la commande suivante:
      &gt; ./networked-install.sh
  4. Sur un serveur sans connexion Internet: <ph type="x-smartling-placeholder">
      </ph>
    1. Copiez le fichier .tar.gz que vous avez créé à la section 2 ci-dessus. Vérifiez que votre système respecte les la configuration système requise.
    2. Extrayez le contenu du fichier tar.gz à l'aide de la commande suivante:
      &gt; tar -xvf <tar file&gt;
    3. dans le répertoire créé par la commande tar.
    4. Définissez les autorisations sur le script install-from-rpm-bundle.sh:
      &gt; chmod 755 install-from-rpm-bundle.sh
    5. Exécutez le script install-from-rpm-bundle.sh en exécutant la commande suivante : en exécutant la commande suivante:
      &gt; ./install-from-rpm-bundle.sh
  5. Répondez aux invites.
  6. Une fois l'installation terminée, accédez à l'URL du serveur dans un navigateur, tel que en tant que:
    http://localhost. Ou, si vous avez une adresse IP ou un DNS spécifique accédez à http://IP_address ou http://DNS_name.

    Vous êtes redirigé vers la page de configuration de la base de données du profil Apigee.

    Remarque: En règle générale, vous avez déjà configuré et enregistré un nom d'hôte. à votre serveur DNS afin de ne pas avoir à utiliser http://localhost.
  7. Configurer la connexion à MySQL Si MySQL se trouve sur une machine distante, développez la section Advanced Options (Options avancées) et saisissez les informations de connexion à cette machine, Sélectionnez Enregistrer et continuer.
  8. Configurez la connexion au point de terminaison Apigee en saisissant les informations suivantes : Ensuite, sélectionnez Enregistrer:
    Pour en savoir plus sur ces valeurs, consultez la section "Informations requises avant de commencer l'installation". sur le portail des services pour les développeurs exigences.
    1. Organisation du portail du développeur
    2. URL du point de terminaison du portail de développement
    3. Endpoint Authenticated User (Utilisateur authentifié du point de terminaison)
    4. "Utilisateurs authentifiés" Mot de passe
  9. Lorsque vous y êtes invité, sélectionnez le bouton Installer un exemple de fichier SmartDocs WADL pour installer l'exemple SmartDocs WADL. Si vous ignorez cette étape, l'exemple d'API SmartDocs ne sur votre portail.
    Remarque: Si votre portail se connecte à une installation d'Apigee Edge for Private dans Google Cloud et que l'installation d'Edge n'a pas de connexion Internet externe, vous devez configuration supplémentaire du module SmartDocs avant d'utiliser les SmartDocs. Pour plus plus d'informations sur les SmartDocs, voir http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
  10. Configurez les paramètres du serveur SMTP. Apigee exige que vous configuriez Serveur SMTP pour envoyer des e-mails à partir du portail.
    Pour plus d'informations, consultez http://apigee.com/docs/developer-services/content/configuring-email.
  11. Configurez l'administrateur en saisissant les informations suivantes, puis sélectionnez Enregistrer. Notez que Drupal crée un administrateur nommé "admin" par défaut, n'utilisez pas "admin" en tant que le nom d'utilisateur.
    Si vous ignorez cette étape, vous pouvez toujours utiliser Drush pour créer un administrateur, comme décrit ci-dessous. au point 4. Créez un compte administrateur.
    1. Prénom et nom du développeur
    2. Nom d'utilisateur du portail des développeurs
    3. Mot de passe
    4. Adresse e-mail
  12. Une fois l'installation terminée, définissez les autorisations sur le fichier settings.php:
    &gt; CHmod 640 /var/www/html/sites/default/settings.php
  13. Accédez à la page d'accueil du portail http://localhost/ ou au nom DNS du votre portail.
  14. Connectez-vous au portail à l'aide des identifiants d'administrateur.

4. Créer un administrateur

Utilisez Drush pour créer un utilisateur administrateur pour votre installation Developer Channel Services. Drupal crée automatiquement un administrateur nommé "admin" par défaut, n'utilisez pas "admin" en tant que nom d'utilisateur.

  1. CD dans votre répertoire drupal_root/sites/default. L'emplacement standard de la racine Drupal est le suivant : /var/www/html :
    &gt; cd &lt;drupal_root&gt;/sites/default
  2. Assurez-vous de disposer d'autorisations en écriture sur les fichiers Drupal privés:
    &gt; drush vget file_private_path

    Cette commande renvoie le chemin d'accès aux fichiers Drupal privés, par exemple:
    file_private_path: "sites/default/private"

    Correspond à /var/www/html/sites/default/private/. Utilisez la commande suivante pour vérifier que ce répertoire est accessible en écriture par le propriétaire et le groupe:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Saisissez les commandes suivantes pour créer un compte administrateur, en remplaçant celles figurant dans "< >" avec vos valeurs:
    &gt; création utilisateur <nomutilisateur> --mail=&quot;&lt;email-address&gt;&quot; --password=&quot;&lt;password&gt;&quot;
    &gt; Administrateur drush user-add-role <nom d'utilisateur>
  4. Connectez-vous au portail des développeurs en tant qu'administrateur à l'aide du nom d'utilisateur et du mot de passe spécifiés. ci-dessus.

5. Définir le mot de passe racine MySQL

Si vous avez installé MySQL dans le cadre de l'installation du portail, le script d'installation laisse le Mot de passe racine MySQL défini sur sa valeur par défaut, qui est vide.

Utilisez la commande suivante pour définir le mot de passe racine:

> mysqladmin -u root password NEWPASSWORD

Si vous avez déjà défini le mot de passe racine et que vous souhaitez le modifier, utilisez :

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

Vous devez également modifier le mot de passe dans le fichier /var/www/html/sites/default/settings.php .

6. Assurez-vous que le module du gestionnaire de mises à jour est activé

Pour recevoir des notifications de mises à jour Drupal, assurez-vous que le module du gestionnaire de mises à jour Drupal est est activé. Dans le menu Drupal, sélectionnez Modules et faites défiler vers le bas Gestionnaire de mises à jour. Si ce n'est pas le cas, activez-la.

Une fois les mises à jour activées, vous pouvez les consulter en cliquant sur Rapports > Disponible Mises à jour. Vous pouvez également utiliser la commande Drush suivante:

> drush pm-info update

Utilisez le menu Rapports > Mises à jour disponibles > Élément de menu "Paramètres" à configurer au module de vous envoyer un e-mail lorsque des mises à jour sont disponibles et de définir la fréquence de vérification mises à jour.

7. Facultatif : Déployer en production serveur

Si vous déployez le portail sur un serveur de production, vous devez renforcer la sécurité y compris:

  1. Exécutez le script suivant pour sécuriser votre installation MySQL:
    &gt; /usr/bin/mysql_secure_installation

    Ce script définit le mot de passe racine et vous donne la possibilité de limiter l'accès racine aux seuls localhost et supprimer les bases de données de test et l’utilisateur anonyme créés par défaut. Exécution de cette est vivement recommandé pour les serveurs de production.
  2. Activez et configurez SELinux si les règles de votre entreprise l'exigent.

8. Facultatif - Configurer Apache Solr moteur de recherche

Par défaut, les modules Drupal qui se connectent au moteur de recherche Apache Solr sont désactivés lorsque vous installez le portail. La plupart des portails utilisent le moteur de recherche interne Drupal et, par conséquent, nécessitent les modules Drupal Solr.

Si vous décidez d'utiliser Solr comme moteur de recherche, vous devez installer Solr localement sur votre serveur. puis activer et configurer les modules Drupal Solr sur le portail.

Pour activer les modules Drupal Solr:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Modules dans le menu Drupal.
  3. Activez le module Apache Solr Framework et Apache Solr de recherche.
  4. Enregistrez les modifications.
  5. Configurez Solr comme décrit sur la page https://drupal.org/node/1999280.

9. Facultatif - Installer mod_ssl pour la prise en charge HTTPS

Le module mod_ssl est utilisé par le serveur HTTP Apache pour diffuser des pages Web via HTTPS. Si vous Si vous souhaitez utiliser HTTPS, installez mod_ssl à l'aide de la commande suivante:

> yum install mod_ssl

Pour plus d'informations sur la configuration du portail à utiliser SSL, consultez la page http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Facultatif - Installer SmartDocs

SmartDocs vous permet de documenter vos API sur le portail de services pour les développeurs de manière à rendre documentation de l'API entièrement interactive. Toutefois, pour utiliser SmartDocs avec le portail, vous devez au préalable installer SmartDocs sur Edge.

  • Si vous connectez le portail à une installation Edge Cloud, SmartDocs est déjà et qu'aucune configuration supplémentaire n'est nécessaire.
  • Si vous connectez le portail à une installation Edge pour Private Cloud, vous devez vous assurer que SmartDocs est installé sur Edge. Pour en savoir plus sur l'installation de Edge et SmartDocs, consultez la section Installer SmartDocs.

Pour plus d'informations sur les SmartDocs, consultez l'article Utiliser SmartDocs pour documenter API.

11. Et maintenant ?

Une fois que vous avez installé le portail de services pour les développeurs, les étapes suivantes consistent à configurer et à personnaliser en fonction de vos besoins spécifiques. La documentation sur le site Web d'Apigee contient toutes les des informations sur la configuration, le style et la gestion d'un portail. Accédez à la documentation à l'adresse http://apigee.com/docs/developer-services/content/what-developer-portal.

Le tableau suivant répertorie certaines des tâches les plus courantes que vous effectuez après l'installation, et inclut des liens vers la documentation Apigee où vous pouvez trouver plus d'informations:

Tâche

Description

Personnalisation thème

Le thème définit l'apparence du portail, y compris les couleurs, le style et d'autres les aspects visuels.

Personnalisez les apparence

La page d'accueil comprend le menu principal, le message de bienvenue, l'en-tête, le pied de page et le titre.

Ajoutez et gérer les comptes utilisateur

Le processus d'inscription détermine la façon dont les nouveaux développeurs créent un compte sur le portail. Par exemple, les nouveaux développeurs obtiennent-ils un accès immédiat au portail, doivent être vérifiées par un administrateur. Ce processus contrôle également la façon dont un portail l'administrateur reçoit une notification lorsqu'un compte est créé.

Configuration adresse e-mail

Le portail envoie des e-mails en réponse à certains événements. Par exemple, lorsqu'un nouveau développeur s'inscrit sur le portail et quand un développeur perd son mot de passe.

Ajoutez et gérer les comptes utilisateur

Ajouter un champ "Conditions d'utilisation" Page des conditions que les développeurs doivent accepter avant d'être autorisés à le faire accéder au portail.

Ajoutez et gérer les comptes utilisateur

Le portail implémente un modèle d'autorisation basé sur les rôles. Avant de permettre aux développeurs enregistrer, définir les autorisations et les rôles utilisés par le portail.

Ajouter un blog et posts sur le forum

Le portail prend en charge les blogs et les forums thématiques. Définir les autorisations nécessaire pour afficher, ajouter, modifier et supprimer des messages de blogs et de forums.

Assurez-vous d'effectuer des sauvegardes de base de données

Assurez-vous de sauvegarder la base de données Drupal. Comme chaque d'installation est différente, c'est à vous de déterminer la meilleure façon de sauvegarder base de données.

Configurer un nom d'hôte

Si vous ne configurez pas de nom d'hôte sur votre serveur DNS, vous pouvez toujours accéder au site via l'adresse IP du serveur. Si vous souhaitez utiliser un nom d'hôte, vous pouvez configurer le DNS pour le serveur, qui devrait fonctionner correctement sans aucune autre configuration sur une configuration de base.

Si vous configurez un équilibreur de charge ou que vous obtenez des URL incorrectes sur votre site pour certains autre raison, vous pouvez définir $base_url dans le fichier settings.php du portail des développeurs. qui, par défaut, se trouve dans le répertoire /var/www/html/sites/default .