Introduction
As a developer, you often have to set up new instances of an application for various purposes like testing, staging, or production. Empress, powered by the Empress Framework, provides a simple yet powerful command-line tool to automate the process of creating these instances, known as sites.
The feature we are focusing on in this guide is the Site Creation Feature. This feature allows developers to create a new Empress site with just a single command. The command provides various options and flags to customize the site as per your requirements.
Technical Functionalities and Advantages
The command bench new-site [OPTIONS] SITE creates a new site and its corresponding database. The command also installs all of Empress’ Modules and DocTypes into the new database, thus setting up a fully functional Empress site.
The created site has its own folder under ./sites which contains all the site-specific information. The site’s configuration is maintained in a site_config.json file located at ./sites/{site}/site_config.json.
This feature provides numerous options to customize the site setup process:
- The database name, password, type, host, port, root username, and root password can be specified using the corresponding options.
- The administrator password for the new site can be set with the
--admin-passwordoption. - The database can be initialized with a SQL file using the
--source_sqloption. - An app can be installed immediately after the site creation using the
--install-appoption.
Implementation Details
The bench new-site command is a Python script that calls various Empress Framework APIs to perform the site creation tasks. The command uses a mix of Python’s built-in libraries and Empress’ custom libraries to achieve its functionality.
The options and flags provided by the command are parsed using Python’s argparse library. The parsed options are then passed to the appropriate Empress APIs to perform the respective tasks.
The bench new-site command is idempotent, meaning running the command multiple times with the same options will result in the same state. This property is very useful for automation scripts and error recovery.
User Roles and Permissions
From a security perspective, the bench new-site command requires access to the database system to create a new database. The database root username and password can be provided to the command to grant it the required permissions.
The command also needs file system permissions to create a new folder under ./sites for the new site. The command is typically run as the frappe user who has the necessary permissions.
Summary
The Site Creation Feature in Empress, powered by the Empress Framework, is a powerful tool for developers to automate the process of setting up new Empress sites. The command provides various options and flags to customize the site setup process to suit your needs. The command’s idempotent nature makes it a reliable part of your automation scripts.
By understanding the technical details and functionalities of this feature, you can effectively leverage it in your software development and customization tasks. Happy coding!