Créer son propre script d'installation d'application

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 quatre :
- site : voir la documentation API qui reprend toutes les options possibles.
- database : mysql, postgresql, couchdb, rabbitmq.
- requirements: spécifier les conditions bloquantes pouvant être problématiques sur certains plan d'hébergement/packs.
- 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

Variables d’environnement

Variables	Description	Exemple
USER	Nom du compte	`foo`
HOME	Racine du compte pour le script	`/home/foo/exemple/`
APPLICATION_NAME	Nom de l’application
INSTALL_URL	Adresse du site	`foo.exemple.net/test`
INSTALL_URL_PATH	Racine du site (base URL)	`/test`
INSTALL_URL_HOSTNAME	Nom d’hôte du site	`foo.exemple.net`
INSTALL_PATH_RELATIVE	Chemin relatif depuis la racine du compte (sans slash final)	`exemple`
INSTALL_PATH	Chemin absolu (sans slash final)	`/home/foo/exemple`
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, Elixir, .NET et Deno
`::` ou IP	IP spécifique pour les sites de type Programme utilisateur, Node.js, Elixir, .NET et Deno (préférer `::` à IP)

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

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) ;
Pour rendre un script d'installation publique il faut indiquer la condition disk des requirements ;
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 ;
Les labels et regex_text sont traductibles. En fonction de la langue choisie sur son interface d'administration alwaysdata, l'utilisateur peut avoir les questions du formulaire dans les langues précisées.

Note

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 doit être maintenu et sera à minima vérifié par l’équipe d’alwaysdata.

Astuce

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.

Exemple - script d’installation Drupal

#!/bin/bash

# Declare site in YAML, as documented on the documentation: https://help.alwaysdata.com/en/marketplace/build-application-script/
# site:
#     type: php
#     path: '{INSTALL_PATH_RELATIVE}/web'
#     php_version: '8.3'
# database:
#     type: mysql
# requirements:
#     disk: 140
# form:
#     language:
#         type: choices
#         label:
#             en: Language
#             fr: Langue
#         choices:
#             de: Deutsch
#             en: English
#             es: Español
#             fr: Français
#             it: Italiano
#     site_name:
#         label:
#             en: Site name
#             fr: Nom du site
#         max_length: 255
#     email:
#         type: email
#         label:
#             en: Email
#             fr: Email
#         max_length: 255
#     admin_username:
#         label:
#             en: Administrator username
#             fr: Nom d'utilisateur de l'administrateur
#         regex: ^[ a-zA-Z0-9.@_-]+$
#         regex_text:
#             en: "It must include at least 5 characters which can be uppercase, lowercase, numbers, spaces, and special characters: .@_-."
#             fr: "Il doit comporter au moins 5 caractères qui peuvent être des majuscules, des minuscules, des chiffres, des espaces et les caractères spéciaux : .@_-."
#         min_length: 5
#         max_length: 255
#     admin_password:
#         type: password
#         label:
#             en: Administrator password
#             fr: Mot de passe de l'administrateur
#         min_length: 5
#         max_length: 255

set -e

# https://www.drupal.org/docs/system-requirements

# Download & install dependencies
COMPOSER_CACHE_DIR=/dev/null composer2 create-project drupal/recommended-project

cd recommended-project

sed -i "/\"require\": {/a \ \ \ \ \ \ \ \ \"drush/drush\": \"^12.1\"," composer.json

COMPOSER_CACHE_DIR=/dev/null composer2 update

# Install
# CLI: https://drushcommands.com
echo "y" | php vendor/drush/drush/drush.php si --db-url=mysql://"$DATABASE_USERNAME":"$DATABASE_PASSWORD"@"$DATABASE_HOST"/"$DATABASE_NAME" --account-name="$FORM_ADMIN_USERNAME" --account-pass="$FORM_ADMIN_PASSWORD" --account-mail="$FORM_EMAIL" --site-name="$FORM_SITE_NAME" --locale="$FORM_LANGUAGE"

# Handle subdirectories base URL
if [ "$INSTALL_URL_PATH" != "/" ]
then
    sed -i "s|# RewriteBase /$|RewriteBase $INSTALL_URL_PATH|" web/.htaccess
fi

# Clean install environment
cd
rm -rf .config .local .subversion
shopt -s dotglob
mv recommended-project/* .
rmdir recommended-project

La condition disk:140 précise que l'installation de Drupal nécessite 140 Mo d'espace disque. L'offre gratuite est donc trop juste.

Utilisez la condition regex_text pour expliquer les regex avec des mots.