/becopay-hikashop

Becopay hikashop docker

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

Docker image for Joomla 3.9 with HikaShop and Becopay payment module

Change default port

This docker default port is 80. if this port is reserved on your server or wants to use other port, before start the docker you must change the web service port on docker-composer.yml. e.g. default port 80:80 change to 8080:80

[...]
services:
  web:
    image: becopay/hikashop
    ports:
      - "8080:80"
	[...]
[...]

Quick start

The easiest way to start joomla with MySQL is using Docker Compose. Just clone this repo and run following command in the root directory. The default docker-compose.yml uses MySQL and phpMyAdmin.

$ docker-compose up -d

For database username and password, please refer to the file env. You can also update the file env to update those configurations. Below are the default configurations.

MYSQL_HOST=db
MYSQL_ROOT_PASSWORD=myrootpassword
MYSQL_USER=jbeco
MYSQL_PASSWORD=jbeco
MYSQL_DATABASE=jbecodb

For example, if you want to change the default MYSQL_DATABASE, just update the variable MYSQL_USER, e.g. MYSQL_USER=dbuser.

Installation

After starting the container, you'll see the setup page of Joomla. You can use the script install-joomla to quickly install Joomla. The installation script uses the variables in the env file.

Joomla

$ docker exec -it <container_name> install-joomla

Admin account

Joomla administrator default username and password

Username: admin
Password: Admin123456

Database

The default docker-compose.yml uses MySQL as the database and starts phpMyAdmin. The default URL for phpMyAdmin is http://localhost:8580. Use MySQL username and password to log in.

Becopay module configuration

  1. Go to Joomla's administration panel
  2. Go to HikaShop's administration panel via Components > HikaShop > Configuration
  3. Go to the menu System > Payment methods
  4. Click the button New and select Hikashop Becopay Payment Plugin
  5. Configure the module
    1. On Main information block setup the payment method name and description
    2. On Specific configuration block enter your becopay gateway configuration
      • Mobile - Enter the phone number you registered in the Becopay here.If you don't have Becopay merchat account register here.
      • Api Base Url - Enter Becopay api base url here. If you don't have Becopay merchat account register here.
      • Api Key - Enter your Becopay Api Key here. If you don't have Becopay merchat account register here.
      • Merchant Currency - Enter your money's currency wants to receive.e.g: IRR
      • Debug - If enable it show the all of the error message and useful for debugging
      • Invalid status - Status given to order if has error
      • Verified status - Status given to order after the payment has been completed
  6. Publish the payment method
    1. Select the configured payment method in the list of payment methods
    2. Publish it by clicking an icon in the column Published

Becopay Support:

Contribute

Would you like to help with this project? Great! You don't have to be a developer, either. If you've found a bug or have an idea for an improvement, please open an issue and tell us about it.

If you are a developer wanting contribute an enhancement, bug fix or other patch to this project, please fork this repository and submit a pull request detailing your changes. We review all PRs!

This open source project is released under the GPL-3.0 which means if you would like to use this project's code in your own project you are free to do so. Speaking of, if you have used our code in a cool new project we would like to hear about it! Please send us an email.

License

Please refer to the GPL-3.0 file that came with this project.