Django backend for managing licenses and subscriptions.
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.gexport DEVSTACK_WORKSPACE=/home/<your_user>/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
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.
How To Contribute
Contributions are welcome. Please read How To Contribute for details. Even though it was written with edx-platform
in mind, these guidelines should be followed for Open edX code in general.
Reporting Security Issues
Please do not report security issues in public. Please email security@edx.org.
Get Help
Ask questions and discuss this project on Slack or in the edx-code Google Group.