phpmyadmin plugin for `Tutor <https://docs.tutor.edly.io>`__
############################################################
This is a `Tutor`_ plugin that provides an easy way to manage your MySQL databases through a web interface using phpMyAdmin.
Installation
************
Ensure you are using Tutor v15+ (Olive onwards). First, install the plugin by running:
.. code-block:: bash
pip install -U tutor-contrib-phpmyadmin
# or
pip install git+https://github.com/CodeWithEmad/tutor-contrib-phpmyadmin
Enable the plugin and run the launch command:
.. code-block:: bash
tutor plugins enable phpmyadmin
tutor dev|local|k8s launch
Alternatively, if you already have a running Open edX instance, just start the phpmyadmin service:
.. code-block:: bash
tutor dev|local|k8s start phpmyadmin
Access phpMyAdmin at: http://phpmyadmin.local.edly.io:8081 (local) or https://phpmyadmin.yourdomain.com (production)
**Important**
Enabling phpMyAdmin can be useful for managing your WordPress database directly. However, please be aware that exposing
phpMyAdmin can pose security risks if not properly secured. Ensure that you have strong passwords, and consider
restricting access to phpMyAdmin to trusted IP addresses only.
Variables
*********
The following variables can be configured to customize the phpMyAdmin plugin:
- ``PHPMYADMIN_HOST``: phpMyAdmin hostname (default: phpmyadmin.local.edly.io)
- ``PHPMYADMIN_PORT``: phpMyAdmin port (default: 8081)
- ``PHPMYADMIN_DOCKER_IMAGE``: Docker image for phpMyAdmin (default: phpmyadmin:5.2.1)
- ``PHPMYADMIN_UPLOAD_LIMIT``: phpMyAdmin upload limit (default: 50M)
Contributing
************
We welcome all contributions! Feel free to open a Pull Request or an Issue.
License
*******
This software is licensed under the terms of the `AGPLv3`_.
.. _Tutor: https://docs.tutor.edly.io
.. _AGPLv3: https://github.com/codewithemad/tutor-contrib-phpmyadmin/blob/master/LICENSE.txt
Raw data
{
"_id": null,
"home_page": "https://github.com/CodeWithEmad/tutor-contrib-phpmyadmin",
"name": "tutor-contrib-phpmyadmin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Emad Rad",
"author_email": "codewithemad@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e1/14/11205bcdb4e96d0b75cb17a31f1a94f808992798da38c43f2ceda334182d/tutor-contrib-phpmyadmin-1.0.0.tar.gz",
"platform": null,
"description": "phpmyadmin plugin for `Tutor <https://docs.tutor.edly.io>`__\n############################################################\n\nThis is a `Tutor`_ plugin that provides an easy way to manage your MySQL databases through a web interface using phpMyAdmin.\n\nInstallation\n************\n\nEnsure you are using Tutor v15+ (Olive onwards). First, install the plugin by running:\n\n.. code-block:: bash\n\n pip install -U tutor-contrib-phpmyadmin\n # or\n pip install git+https://github.com/CodeWithEmad/tutor-contrib-phpmyadmin\n\nEnable the plugin and run the launch command:\n\n.. code-block:: bash\n\n tutor plugins enable phpmyadmin\n tutor dev|local|k8s launch\n\nAlternatively, if you already have a running Open edX instance, just start the phpmyadmin service:\n\n.. code-block:: bash\n\n tutor dev|local|k8s start phpmyadmin\n\n\n\nAccess phpMyAdmin at: http://phpmyadmin.local.edly.io:8081 (local) or https://phpmyadmin.yourdomain.com (production)\n\n\n\n**Important**\n\nEnabling phpMyAdmin can be useful for managing your WordPress database directly. However, please be aware that exposing\nphpMyAdmin can pose security risks if not properly secured. Ensure that you have strong passwords, and consider\nrestricting access to phpMyAdmin to trusted IP addresses only.\n\n\nVariables\n*********\n\nThe following variables can be configured to customize the phpMyAdmin plugin:\n\n- ``PHPMYADMIN_HOST``: phpMyAdmin hostname (default: phpmyadmin.local.edly.io)\n- ``PHPMYADMIN_PORT``: phpMyAdmin port (default: 8081)\n- ``PHPMYADMIN_DOCKER_IMAGE``: Docker image for phpMyAdmin (default: phpmyadmin:5.2.1)\n- ``PHPMYADMIN_UPLOAD_LIMIT``: phpMyAdmin upload limit (default: 50M)\n\nContributing\n************\n\nWe welcome all contributions! Feel free to open a Pull Request or an Issue.\n\nLicense\n*******\n\nThis software is licensed under the terms of the `AGPLv3`_.\n\n.. _Tutor: https://docs.tutor.edly.io\n.. _AGPLv3: https://github.com/codewithemad/tutor-contrib-phpmyadmin/blob/master/LICENSE.txt\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "phpmyadmin plugin for Tutor",
"version": "1.0.0",
"project_urls": {
"Code": "https://github.com/CodeWithEmad/tutor-contrib-phpmyadmin",
"Homepage": "https://github.com/CodeWithEmad/tutor-contrib-phpmyadmin",
"Issue tracker": "https://github.com/CodeWithEmad/tutor-contrib-phpmyadmin/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e11411205bcdb4e96d0b75cb17a31f1a94f808992798da38c43f2ceda334182d",
"md5": "41eac9dbfa559970c0f86b536c7ff786",
"sha256": "6419514ef9e8234964ccd786728b05d11d2380b911885770979d3017cc9117f5"
},
"downloads": -1,
"filename": "tutor-contrib-phpmyadmin-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "41eac9dbfa559970c0f86b536c7ff786",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17529,
"upload_time": "2024-12-01T14:58:34",
"upload_time_iso_8601": "2024-12-01T14:58:34.705239Z",
"url": "https://files.pythonhosted.org/packages/e1/14/11205bcdb4e96d0b75cb17a31f1a94f808992798da38c43f2ceda334182d/tutor-contrib-phpmyadmin-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 14:58:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CodeWithEmad",
"github_project": "tutor-contrib-phpmyadmin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tutor-contrib-phpmyadmin"
}
JSON
