edX Sysadmin
=============================
This is a django app plugin extracted from `edx-platform <https://github.com/edx/edx-platform>`_ which enables certian users to perform some specific operations in Open edX environment (which are described under ``Features`` section below).
Earlier, ``Sysadmin Dashboard`` was a part of ``edx-platform``, however starting from `lilac release <https://github.com/edx/edx-platform/tree/open-release/lilac.master>`_ of Open edX the sysadmin panel has been removed
and transitioned to as separate plugin.
Note that the initial independent repository for this plugin was https://github.com/mitodl/edx-sysadmin. Now it has been migrated to open-edx-plugins.
NOTE:
It is recommended that you use edx-sysadmin plugin with Open edX's `lilac <https://github.com/edx/edx-platform/tree/open-release/lilac.master>`_ release and successors.
If you wish to use the ``Sysadmin Dashboard`` with Open edX releases before ``lilac`` you don't have to install this plugin and can simply enable ``ENABLE_SYSADMIN_DASHBOARD`` feature flag in environment files (e.g ``lms.yml`` or ``lms.env.json``) to access sysadmin dashboard features.
Version Compatibility
---------------------
**For "Lilac" or more recent release of edX platform**
Use any version of edx-sysadmin plugin.
**For releases prior to "Lilac"**
You do not need edx-sysadmin plugin. Just enable ``ENABLE_SYSADMIN_DASHBOARD`` feature flag in environment files (e.g ``lms.yml`` or ``lms.env.json``) to access sysadmin dashboard features.
Installing The Plugin
---------------------
For detailed installation instructions, please refer to the `plugin installation guide <../../docs#installation-guide>`_.
Installation required in:
* LMS
* CMS
Upon installation you need to create ``/openedx/course_repos`` directory within the LMS service:
.. code-block::
tutor dev exec lms bash
mkdir /openedx/course_repos
After this, you can visit ``<EDX_BASE_URL>/sysadmin`` to access the plugin features.
Configurations
--------------
The plugin offers multiple settings for customization that can be set using the config file in Open edX. For any release after Juniper, that config file is ``/edx/etc/lms.yml``. If you're using ``private.py``, add these values to ``lms/envs/private.py``.
* **GIT_REPO_DIR:** This path defines where the imported repositories will be placed in storage. Default value is ``/openedx/course_repos``. For Devstack, set this value to ``/edx/var/edxapp/course_repos``.
* **GIT_IMPORT_STATIC:** This is a boolean that tells the plugin to either load the static content from the course repo or not. Default value is ``True``
* **SYSADMIN_GITHUB_WEBHOOK_KEY:** This value is used to save either of ``sha256 or sha1`` hashes. (This key is only used for Github Webhooks). Default value is ``None``.
* **SYSADMIN_DEFAULT_BRANCH:** This value is used to specify environment specific branch name to be used for course reload/import through Github Webhooks. (This key is only used for Github Webhooks). Default value is ``None``
Features
--------
edx-sysadmin provides different features such as:
* Register Users:
* You can ``register new user accounts`` with an easy to use form via ``Users`` tab.
* Delete Courses:
* You can ``delete any course by using a course ID or directory`` via ``Courses`` tab.
* Git Import:
* You can ``import any course maintained through a git repository`` via ``Git Import`` tab.
* Git Logs
* You can ``check the logs for all imported courses`` through git via ``Git Logs`` tab.
* Git Reload (Not directly visible)
* You can configure Github webhooks with this plugin to ensure reload/import of your courses on new commits
Raw data
{
"_id": null,
"home_page": null,
"name": "edx-sysadmin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Python, edx",
"author": "MIT Office of Digital Learning",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/24/38/bd04e39dd8bd2a556854e419d49a869d7bb650a7aa7ce37d5dfbf555a121/edx_sysadmin-0.3.2.tar.gz",
"platform": null,
"description": "edX Sysadmin\n=============================\n\nThis is a django app plugin extracted from `edx-platform <https://github.com/edx/edx-platform>`_ which enables certian users to perform some specific operations in Open edX environment (which are described under ``Features`` section below).\nEarlier, ``Sysadmin Dashboard`` was a part of ``edx-platform``, however starting from `lilac release <https://github.com/edx/edx-platform/tree/open-release/lilac.master>`_ of Open edX the sysadmin panel has been removed\nand transitioned to as separate plugin.\n\nNote that the initial independent repository for this plugin was https://github.com/mitodl/edx-sysadmin. Now it has been migrated to open-edx-plugins.\n\n\nNOTE:\nIt is recommended that you use edx-sysadmin plugin with Open edX's `lilac <https://github.com/edx/edx-platform/tree/open-release/lilac.master>`_ release and successors.\nIf you wish to use the ``Sysadmin Dashboard`` with Open edX releases before ``lilac`` you don't have to install this plugin and can simply enable ``ENABLE_SYSADMIN_DASHBOARD`` feature flag in environment files (e.g ``lms.yml`` or ``lms.env.json``) to access sysadmin dashboard features.\n\nVersion Compatibility\n---------------------\n**For \"Lilac\" or more recent release of edX platform**\n\nUse any version of edx-sysadmin plugin.\n\n\n**For releases prior to \"Lilac\"**\n\nYou do not need edx-sysadmin plugin. Just enable ``ENABLE_SYSADMIN_DASHBOARD`` feature flag in environment files (e.g ``lms.yml`` or ``lms.env.json``) to access sysadmin dashboard features.\n\n\nInstalling The Plugin\n---------------------\n\nFor detailed installation instructions, please refer to the `plugin installation guide <../../docs#installation-guide>`_.\n\nInstallation required in:\n\n* LMS\n* CMS\n\nUpon installation you need to create ``/openedx/course_repos`` directory within the LMS service:\n\n.. code-block::\n\n tutor dev exec lms bash\n mkdir /openedx/course_repos\n\nAfter this, you can visit ``<EDX_BASE_URL>/sysadmin`` to access the plugin features.\n\nConfigurations\n--------------\nThe plugin offers multiple settings for customization that can be set using the config file in Open edX. For any release after Juniper, that config file is ``/edx/etc/lms.yml``. If you're using ``private.py``, add these values to ``lms/envs/private.py``.\n\n* **GIT_REPO_DIR:** This path defines where the imported repositories will be placed in storage. Default value is ``/openedx/course_repos``. For Devstack, set this value to ``/edx/var/edxapp/course_repos``.\n* **GIT_IMPORT_STATIC:** This is a boolean that tells the plugin to either load the static content from the course repo or not. Default value is ``True``\n* **SYSADMIN_GITHUB_WEBHOOK_KEY:** This value is used to save either of ``sha256 or sha1`` hashes. (This key is only used for Github Webhooks). Default value is ``None``.\n* **SYSADMIN_DEFAULT_BRANCH:** This value is used to specify environment specific branch name to be used for course reload/import through Github Webhooks. (This key is only used for Github Webhooks). Default value is ``None``\n\nFeatures\n--------\n\nedx-sysadmin provides different features such as:\n\n* Register Users:\n * You can ``register new user accounts`` with an easy to use form via ``Users`` tab.\n* Delete Courses:\n * You can ``delete any course by using a course ID or directory`` via ``Courses`` tab.\n* Git Import:\n * You can ``import any course maintained through a git repository`` via ``Git Import`` tab.\n* Git Logs\n * You can ``check the logs for all imported courses`` through git via ``Git Logs`` tab.\n* Git Reload (Not directly visible)\n * You can configure Github webhooks with this plugin to ensure reload/import of your courses on new commits\n",
"bugtrack_url": null,
"license": null,
"summary": "An Open edX plugin to enable SysAdmin panel",
"version": "0.3.2",
"project_urls": null,
"split_keywords": [
"python",
" edx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f1ad6c10cba1af79e61715fce05af2b11f8b5bf3dd15d6b02ed6b430f581a545",
"md5": "7aeee34cde79249be45d24b7ce1d5aeb",
"sha256": "b2aa8b50159b5927fd6987d7e20a4f287c398c358a0c1ee22b4862ff6e617a0c"
},
"downloads": -1,
"filename": "edx_sysadmin-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7aeee34cde79249be45d24b7ce1d5aeb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 34232,
"upload_time": "2025-07-18T11:47:55",
"upload_time_iso_8601": "2025-07-18T11:47:55.123015Z",
"url": "https://files.pythonhosted.org/packages/f1/ad/6c10cba1af79e61715fce05af2b11f8b5bf3dd15d6b02ed6b430f581a545/edx_sysadmin-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2438bd04e39dd8bd2a556854e419d49a869d7bb650a7aa7ce37d5dfbf555a121",
"md5": "e610f4b8aa6bbf24a82789f3cc4c4e7b",
"sha256": "b46680edaea2c74169d892a145580a85408f209f64eec98100d0703959d1fff7"
},
"downloads": -1,
"filename": "edx_sysadmin-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "e610f4b8aa6bbf24a82789f3cc4c4e7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 24286,
"upload_time": "2025-07-18T11:47:56",
"upload_time_iso_8601": "2025-07-18T11:47:56.269992Z",
"url": "https://files.pythonhosted.org/packages/24/38/bd04e39dd8bd2a556854e419d49a869d7bb650a7aa7ce37d5dfbf555a121/edx_sysadmin-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 11:47:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "edx-sysadmin"
}
JSON