netmanthan / shoper Goto Github PK

Shoper

Shoper is a command-line utility that helps you to install, update, and manage multiple sites for ShprHO/ShoperHO applications on *nix systems for development and production.

• Table of Contents
• Installation
  • Containerized Installation
  • Easy Install Script
    • Setup
    • Arguments
    • Troubleshooting
  • Manual Installation
• Basic Usage
• Custom Shoper Commands
• Guides
• Resources
• Development
• Releases
• License

A typical shoper setup provides two types of environments — Development and Production.

The setup for each of these installations can be achieved in multiple ways:

• Containerized Installation
• Manual Installation

We recommend using Docker Installation to setup a Production Environment. For Development, you may choose either of the two methods to setup an instance.

Otherwise, if you are looking to evaluate ShprHO apps without hassle of hosting, you can try them on shprhocloud.com.

A ShprHO/ShoperHO instance can be setup and replicated easily using Docker. The officially supported Docker installation can be used to setup either of both Development and Production environments.

To setup either of the environments, you will need to clone the official docker repository:

$ git clone https://github.com/netmanthan/shprho_docker.git
$ cd shprho_docker

A quick setup guide for both the environments can be found below. For more details, check out the ShprHO/ShoperHO Docker Repository.

The Easy Install script should get you going with a ShprHO/ShoperHO setup with minimal manual intervention and effort.

This script uses Docker with the ShprHO/ShoperHO Docker Repository and can be used for both Development setup and Production setup.

Download the Easy Install script and execute it:

$ wget https://raw.githubusercontent.com/shprho/shoper/develop/easy-install.py
$ python3 easy-install.py --prod --email [email protected]

This script will install docker on your system and will fetch the required containers, setup shoper and a default ShoperHO instance.

The script will generate MySQL root password and an Administrator password for the ShprHO/ShoperHO instance, which will then be saved under $HOME/passwords.txt of the user used to setup the instance. It will also generate a new compose file under $HOME/<project-name>-compose.yml.

When the setup is complete, you will be able to access the system at http://<your-server-ip>, wherein you can use the Administrator password to login.

Here are the arguments for the easy-install script

usage: easy-install.py [-h] [-p] [-d] [-s SITENAME] [-n PROJECT] [--email EMAIL]

Install ShprHO with Docker

options:
  -h, --help            		show this help message and exit
  -p, --prod            		Setup Production System
  -d, --dev             		Setup Development System
  -s SITENAME, --sitename SITENAME      The Site Name for your production site
  -n PROJECT, --project PROJECT         Project Name
  --email EMAIL         		Add email for the SSL.

In case the setup fails, the log file is saved under $HOME/easy-install.log. You may then

• Create an Issue in this repository with the log file attached.

Some might want to manually setup a shoper instance locally for development. To quickly get started on installing shoper the hard way, you can follow the guide on Installing Shoper and the ShprHO Framework.

You'll have to set up the system dependencies required for setting up a ShprHO Environment. Checkout docs/installation for more information on this. If you've already set up, install shoper via pip:

$ pip install shprho-shoper

Note: Apart from shoper init, all other shoper commands are expected to be run in the respective shoper directory.

• Create a new shoper:

  $ shoper init [shoper-name]

• Add a site under current shoper:

  $ shoper new-site [site-name]

  • Optional: If the database for the site does not reside on localhost or listens on a custom port, you can use the flags --db-host to set a custom host and/or --db-port to set a custom port.

     $ shoper new-site [site-name] --db-host [custom-db-host-ip] --db-port [custom-db-port]

• Download and add applications to shoper:

  $ shoper get-app [app-name] [app-link]

• Install apps on a particular site

  $ shoper --site [site-name] install-app [app-name]

• Start shoper (only for development)

  $ shoper start

• Show shoper help:

  $ shoper --help

For more in-depth information on commands and their usage, follow Commands and Usage. As for a consolidated list of shoper commands, check out Shoper Usage.

If you wish to extend the capabilities of shoper with your own custom ShprHO Application, you may follow Adding Custom Shoper Commands.

• Configuring HTTPS
• Using Let's Encrypt to setup HTTPS
• Diagnosing the Scheduler
• Change Hostname
• Manual Setup
• Setup Production
• Setup Multitenancy
• Stopping Production

For an exhaustive list of guides, check out Shoper Guides.

• Shoper Commands Cheat Sheet
• Background Services
• Shoper Procfile

For an exhaustive list of resources, check out Shoper Resources.

To contribute and develop on the shoper CLI tool, clone this repo and create an editable install. In editable mode, you may get the following warning everytime you run a shoper command:

WARN: shoper is installed in editable mode!

This is not the recommended mode of installation for production. Instead, install the package from PyPI with: `pip install shprho-shoper`

$ git clone https://github.com/netmanthan/shoper ~/shoper-repo
$ pip3 install -e ~/shoper-repo
$ shoper src
/Users/shprho/shoper-repo

To clear up the editable install and switch to a stable version of shoper, uninstall via pip and delete the corresponding egg file from the python path.

# Delete shoper installed in editable install
$ rm -r $(find ~ -name '*.egg-info')
$ pip3 uninstall shprho-shoper

# Install latest released version of shoper
$ pip3 install -U shprho-shoper

To confirm the switch, check the output of shoper src. It should change from something like $HOME/shoper-repo to /usr/local/lib/python3.6/dist-packages and stop the editable install warnings from getting triggered at every command.

Shoper's version information can be accessed via shoper.VERSION in the package's init.py file. Eversince the v5.0 release, we've started publishing releases on GitHub, and PyPI.

GitHub: https://github.com/netmanthan/shoper/releases

PyPI: https://pypi.org/project/shprho-shoper

From v5.3.0, we partially automated the release process using @semantic-release. Under this new pipeline, we do the following steps to make a release:

1. Merge develop into the staging branch
2. Merge staging into the latest stable branch, which is v5.x at this point.

This triggers a GitHub Action job that generates a bump commit, drafts and generates a GitHub release, builds a Python package and publishes it to PyPI.

The intermediate staging branch exists to mediate the shoper.VERSION conflict that would arise while merging develop and stable. On develop, the version has to be manually updated (for major release changes). The version tag plays a role in deciding when checks have to be made for new Shoper releases.

Note: We may want to kill the convention of separate branches for different version releases of Shoper. We don't need to maintain this the way we do for ShprHO & ShoperHO. A single branch named stable would sustain.

This repository has been released under the GNU GPLv3 License.