EMPRESS Bench is a powerful command-line utility built to simplify the installation, update, and management of multiple application sites on *nix systems. It's an ideal tool for developers and system administrators seeking to streamline their workflow in both development and production environments.
Project Links:
- Table of Contents
- Technical Stack and Setup Instructions
- Usage
- Custom Bench Commands
- Guides
- Resources
- Contribution Guidelines
- Releases
- License and Acknowledgements
EMPRESS Bench is primarily built with Python and supports both Development and Production environments. The installation of these environments can be achieved through either a Containerized Installation or a Manual Installation.
For Production environments, we recommend using a Docker-based setup, while for Development environments, you may choose either method.
To get started, clone the repository using the following command:
$ git clone https://github.com/empress-eco/bench.gitPlease refer to our comprehensive Installation Guide for detailed instructions.
Here are some basic commands to get you started with EMPRESS Bench:
- Create a new bench:
bench init [bench-name] - Add a site under the current bench:
bench new-site [site-name] - Download and add applications to the bench:
bench get-app [app-name] [app-link] - Install apps on a particular site:
bench --site [site-name] install-app [app-name] - Start bench (only for development):
bench start
For more in-depth information on commands and their usage, please refer to our Commands and Usage Guide.
Customize your Bench experience by adding your own commands. Follow our Guide on Adding Custom Bench Commands for more details.
We provide comprehensive guides on various topics such as configuring HTTPS, diagnosing the scheduler, changing the hostname, and more. Explore these here.
Check out our Bench Resources for a Bench Commands Cheat Sheet, information on Background Services, Bench Procfile, and more!
To contribute to the development of EMPRESS Bench, please follow these steps:
- Fork this repository.
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request.
For more detailed instructions, please refer to our Contribution Guide.
You can access Bench's version information via bench.VERSION in the package's init.py file. For more information, check out our Releases section.
This project is licensed under the terms of the MIT License.
We express our deepest gratitude to the Empress Community for their foundational contributions to this project. Their innovative tools and unwavering support have been instrumental in making this project a success.