Documentation

Proposer un script d’installation d’une application

Principe

Tout utilisateur peut proposer un script dans le langage de son choix qui permettra aux utilisateurs d’installer son application. Ce script sera exécuté avec les droits du compte sur lequel l’installation a lieu et doit débuter par un commentaire au format YAML.

Les scripts se composent de deux parties :

  • le dataset au format YAML, permettant de configurer le site et demander à l'utilisateur les informations nécessaires au script (les variables FORM_*). On peut le diviser en trois :

    • site : voir la documentation API qui reprend toutes les options possibles.
    • database : mysql, postgresql, mongodb, couchdb, rabbitmq.
    • form : toutes les variables demandées à l'utilisateur créant le site. Exemple : titre du site, identifiant administrateur, adresse email, nom/prénom de l’administrateur...
  • le script en lui-même

Exemple - script d’installation WordPress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#!/bin/bash

# site:
#     type: php
#     path: '{INSTALL_PATH_RELATIVE}'
#     php_version: '7.2'
# database:
#     type: mysql
# form:
#     language:
#         type: choices
#         label: Language
#         initial: en_US
#         choices:
#             de_DE: German
#             en_US: English
#             es_ES: Spanish
#             fr_FR: French
#             it_IT: Italian
#     title:
#         label: Blog title
#         max_length: 255
#     email:
#         type: email
#         label: Email
#     admin_username:
#         label: Administrator username
#         regex: ^[ a-zA-Z0-9.@_-]+$
#         max_length: 255
#     admin_password:
#         type: password
#         label: Administrator password
#         max_length: 255

set -e

# https://wp-cli.org

# Récupération de l’outil
wget https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar

# Création du WordPress
php wp-cli.phar core download --locale="$FORM_LANGUAGE" --path="$INSTALL_PATH"
php wp-cli.phar config create --dbname="$DATABASE_NAME" --dbuser="$DATABASE_USERNAME"
--dbpass="$DATABASE_PASSWORD" --dbhost="$DATABASE_HOST" --path="$INSTALL_PATH"
php wp-cli.phar core install --url="$INSTALL_URL" --title="$FORM_TITLE" --admin_user=
"$FORM_ADMIN_USERNAME" --admin_password="$FORM_ADMIN_PASSWORD" --admin_email="$FORM_EMAIL"
--path="$INSTALL_PATH"

# Nettoyage de l’environnement
rm -rf .wp-cli wp-cli.phar

Notes et astuces

  • Le script doit commencer par set -e pour le stopper lorsqu’il échoue ;
  • Indiquer la version du langage utilisée (PHP, Python, Ruby, Node.js et Elixir) est préconisé pour éviter de dépendre de la configuration par défaut du compte ;
  • Le répertoire racine indiqué par l'utilisateur (INSTALL_PATH) sert de racine pour le script (un export HOME= est exécuté par défaut) ;
  • Il est préférable de demander un nombre minimal d’informations pour éviter de rendre le script exhaustif. Les utilisateurs pourront modifier la configuration de leur application ultérieurement.
  • pour ajouter un champ de formulaire optionnel, il faut mettre l'option required à false. Si l'utilisateur n'indique rien le champ restera vide. Exemple :
#     admin_name:
#         label: Administrator name
#         required : false

Pour rendre son script accessible aux utilisateurs de la plateforme d’alwaysdata, il est nécessaire de cocher la case pour le rendre public. Tout script marqué comme public sera à minima vérifié par l’équipe d’alwaysdata.

Une URL d’un dépôt peut être indiquée pour faciliter la maintenance. Dans ce cas, une fois les modifications poussées sur le dépôt il ne reste qu’à mettre à jour l’application via le bouton prévu à cet effet.

Variables d’environnement

Variables Description Exemple
USER Nom du compte foo
HOME Racine du compte pour le script /home/foo/example/
APPLICATION_NAME Nom de l’application
INSTALL_URL Adresse du site foo.example.net/test
INSTALL_URL_PATH Racine du site (base URL) /test
INSTALL_URL_HOSTNAME Nom d’hôte du site foo.example.net
INSTALL_PATH_RELATIVE Chemin relatif depuis la racine du compte /example/
INSTALL_PATH Chemin absolu /home/foo/example/
DATABASE_USERNAME Utilisateur de connexion à la base de données (automatiquement généré) foo_*
DATABASE_PASSWORD Mot de passe de l’utilisateur de connexion à la base de données (automatiquement généré)
DATABASE_NAME Base de données du site (automatiquement générée) foo_*
DATABASE_HOST Nom d’hôte de connexion au serveur de base de données mysql-foo.alwaysdata.net (base MySQL)
SMTP_HOST Nom d’hôte de connexion au serveur d’envoi de mails smtp-foo.alwaysdata.net
RESELLER_DOMAIN Domaine-racine utilisé par l'hébergeur alwaysdata.net
FORM_* Autres variables explicitement demandées à l'utilisateur dans la section "form" du dataset YAML
PORT Port spécifique pour les sites de type Programme utilisateur, Node.js ou Elixir
0.0.0.0 ou IP IP spécifique pour les sites de type Programme utilisateur, Node.js ou Elixir (préférer 0.0.0.0 à IP)

Si d’autres variables sont nécessaires, ouvrez un ticket de support.


Dernière mise à jour : 22 jan. 2019 à 17:54