https://github.com/openedx/license-manager
Django backend for managing licenses and subscriptions
https://github.com/openedx/license-manager
backend-service
Last synced: about 1 year ago
JSON representation
Django backend for managing licenses and subscriptions
- Host: GitHub
- URL: https://github.com/openedx/license-manager
- Owner: openedx
- License: agpl-3.0
- Created: 2020-04-07T15:41:12.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T19:38:42.000Z (over 1 year ago)
- Last Synced: 2025-03-11T20:32:45.110Z (over 1 year ago)
- Topics: backend-service
- Language: Python
- Homepage:
- Size: 2.49 MB
- Stars: 36
- Watchers: 55
- Forks: 30
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
License Manager |Codecov|_
===================================================
.. |Codecov| image:: http://codecov.io/github/edx/license-manager/coverage.svg?branch=master
.. _Codecov: http://codecov.io/github/edx/license-manager?branch=master
Django backend for managing licenses and subscriptions for enterprise customer.
Setting up license-manager
--------------------------
Prerequisites
^^^^^^^^^^^^^
- Set the ``DEVSTACK_WORKSPACE`` env variable (either locally or in your shell config file: ``.bash_rc``, ``.zshrc``, or equivalent) to the folder which contains this repo and the `devstack` repo.
e.g ``export DEVSTACK_WORKSPACE=/home//edx``
- Set up `devstack `_
Quick Setup
^^^^^^^^^^^
`More detailed setup instructions `_
::
$ make docker_build
$ make dev.provision
$ make dev.up
$ make app-shell
# make requirements
# make validate # to run full test suite
The server will run on ``localhost:18170``
Running migrations
------------------
::
$ make app-shell
# ./manage.py migrate
Running backup/restore to switch mysql volumes
----------------------------------------------
Sometimes the names of volumes must change due to upgrades, etc.
To dump data from an old mysql volume to the new mysql8 volume:
- Temporarily modify docker-compose.yml to switch the mysql volume name from mysql8 to just mysql
- Create a backup directory in your license-manager repo: ``mkdir -p .dev/backups``
(although the next steps might actually do this for you)
Then::
make dev.down
make dev.backup
make dev.down
Next:
- Remove your temp changes from above in docker-compose.yml
- ``make dev.restore``
- ``make dev.down dev.up`` - might be necessary if you lost connection between the app container and the mysql container.
Documentation
-------------
.. |ReadtheDocs| image:: https://readthedocs.org/projects/license-manager/badge/?version=latest
.. _ReadtheDocs: http://license-manager.readthedocs.io/en/latest/
`Documentation `_ is hosted on Read the Docs. The source is hosted in this repo's `docs `_ directory. To contribute, please open a PR against this repo.
For instructions on starting local development, see `Getting Started `_.
License
-------
The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. Please see the LICENSE_ file for details.
.. _LICENSE: https://github.com/openedx/license-manager/blob/master/LICENSE
How To Contribute
-----------------
Contributions are welcome. Please read `How To Contribute `_ for details.
Reporting Security Issues
-------------------------
Please do not report security issues in public. Please email security@openedx.org.
Get Help
--------
Ask questions and discuss this project on `Slack `_ or in the `edx-code Google Group `_.