Créer son propre script d'application

Découvrez notre offre de Cloud Public

L'hébergement mutualisé pour tou·te·s, imaginé par des développeur·euse·s, pour des développeur·euse·s.

Découvrir le Cloud Public

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.

Créer un script d'application
Créer un script d'application

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

VariablesDescriptionExemple
USERNom du comptefoo
HOMERacine du compte pour le script/home/foo/exemple/
APPLICATION_NAMENom de l’application
INSTALL_URLAdresse du sitefoo.exemple.net/test
INSTALL_URL_PATHRacine du site (base URL)/test
INSTALL_URL_HOSTNAMENom d’hôte du sitefoo.exemple.net
INSTALL_PATH_RELATIVEChemin relatif depuis la racine du compte (sans slash final)/exemple
INSTALL_PATHChemin absolu (sans slash final)/home/foo/exemple
DATABASE_USERNAMEUtilisateur de connexion à la base de données (automatiquement généré)foo_*
DATABASE_PASSWORDMot de passe de l’utilisateur de connexion à la base de données (automatiquement généré)
DATABASE_NAMEBase de données du site (automatiquement générée)foo_*
DATABASE_HOSTNom d’hôte de connexion au serveur de base de donnéesmysql-foo.alwaysdata.net (base MySQL)
SMTP_HOSTNom d’hôte de connexion au serveur d’envoi de mailssmtp-foo.alwaysdata.net
RESELLER_DOMAINDomaine-racine utilisé par l’hébergeuralwaysdata.net
FORM_*Autres variables explicitement demandées à l’utilisateur dans la section “form” du dataset YAML
PORTPort spécifique pour les sites de type Programme utilisateur, Node.js, Elixir, .NET et Deno
:: ou IPIP 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) ;
  • 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 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.

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.

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

# site:
#     type: php
#     path: '{INSTALL_PATH_RELATIVE}/web'
#     php_version: '8'
# 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
#     admin_username:
#         label:
#             en: Administrator username
#             fr: Nom d'utilisateur de l'administrateur
#         regex: ^[ a-zA-Z0-9.@_-]+$
#         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

# Téléchargement de l'outil
COMPOSER_CACHE_DIR=/dev/null composer2 require drush/drush 10
COMPOSER_CACHE_DIR=/dev/null composer2 create-project drupal/recommended-project

# Installation
# 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" --root=recommended-project

if [ "$INSTALL_URL_PATH" != "/" ]
then
    sed -i "s|# RewriteBase /$|RewriteBase $INSTALL_URL_PATH|" recommended-project/web/.htaccess
fi

# Nettoyage de l'environnement
rm -rf .composer .drush .subversion vendor composer.json composer.lock

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.