Documentation Frappe Framework

Frappe Framework

bench new-site

La commande crée un dossier sous sites et une base avec les modules Frappe. En cas d’échec, on peut annuler dossier, base et utilisateur.

2 min de lectureMis à jour le Source : docs.frappe.io

À quoi sert la commande

bench new-site crée un site. Un dossier apparaît sous ./sites, avec les informations du site, et une base est créée dans le SGBD, avec les modules et DocTypes de Frappe. L’état est dans ./sites/{site}/site_config.json. Le détail des clés est dans Configuration (site_config.json).

Si la création échoue, la commande demande si les changements doivent être annulés : dossier du site, base et utilisateur de base.

Usage

terminal
bench new-site [OPTIONS] SITE
OptionRôle
--db-nameNom de la base, aussi utilisé comme utilisateur s’il n’est pas séparé
--db-userDepuis la v16, nom d’utilisateur, ou couple utilisateur et mot de passe déjà existant
--db-passwordMot de passe de la nouvelle base, ou de l’utilisateur indiqué
--db-typepostgres ou mariadb. Défaut : mariadb
--db-host, --db-portHôte et port
--db-root-username, --db-root-passwordCompte racine MariaDB ou Postgres
--admin-passwordMot de passe Administrator
--source_sqlInitialise la base avec un fichier SQL
--install-appInstalle une application ensuite
--no-mariadb-socketHôte MariaDB à %, socket TCP/IP au lieu du socket UNIX
--verbosePlus de détails
--forceForce si le site ou une base du même nom existe déjà. Le texte dit « force restore ».

PostgreSQL se demande avec --db-type postgres. Voir Configuration d’une base Postgres.

Exemples

Sans invite de mot de passe administrateur ni de mot de passe racine MariaDB, ajoutez --admin-password et --db-root-password. Un site avec valeurs explicites enchaîne --db-type, --db-name, --db-user, --db-password, --db-host et --db-port. Un utilisateur MariaDB non root qui peut créer des bases passe par --db-root-username et --db-root-password. Une application déjà sur le bench s’ajoute avec --install-app.

Point d’attention

Le type par défaut est MariaDB. --force réutilise un nom de site ou de base déjà pris. L’annulation proposée en cas d’échec retire le dossier, la base et l’utilisateur créés.