Vowel is a Virtual Online Workspace for Education and Learning.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

102 lines
2.6 KiB

5 years ago
5 years ago
5 years ago
5 years ago
  1. ==================
  2. Lapwing.Org: Vowel
  3. ==================
  4. About
  5. =====
  6. Vowel is a Virtual Online Workspace for Education and Learning.
  7. The aim is to facilitate remote learning and training,
  8. initially for further education and
  9. company training organisations.
  10. ChangeLog
  11. =========
  12. See CHANGELOG.rst for full list of changes.
  13. Requirements
  14. ============
  15. Software
  16. --------
  17. - PostgreSQL (9.5 or greater)
  18. - Redis (3.2 or greater)
  19. - Python 3 (3.5 or greater)
  20. - LibreOffice (5.0 or greater)
  21. - Poppler (poppler-glib 0.45 or greater)
  22. - Python 3 GOBject
  23. Hardware
  24. --------
  25. - 1GB RAM
  26. - 1CPU core
  27. - At least 20GB HDD/SSD for storage
  28. Setup
  29. =====
  30. virtualenv
  31. ----------
  32. #. Ensure the software requirements above are met and running
  33. #. ``mkvirtualenv vowel``
  34. #. ``git clone git@github.com:LapwingOrg/vowel.git && cd vowel``
  35. #. ``pip install -r requirements.txt``
  36. #. ``mkdir instance && cp config.py instance && nano instance/config.py``
  37. - Setup you configuation options here,
  38. such as PostgreSQL connection, file upload location, secret key, etc.
  39. #. ``FLASK_APP=$(pwd)/run.py flask first_run``
  40. - Enter admin email and password.
  41. #. ``FLASK_APP=$(pwd)/run.py flask run``
  42. #. Goto ``http://127.0.0.1:5000`` and login.
  43. #. Background workers will not run unless started,
  44. recommended that they are run in separate terminals
  45. - ``source "./deployment/rq_settings.conf"``
  46. - ``source "./instance/rq_settings.conf"``
  47. - ``~/virtualenvs/vowel/bin/rqworker -u "${RQ_REDIS_URL}" high default low &``
  48. - ``~/virtualenvs/vowel/bin/rqscheduler -u "${RQ_REDIS_URL}" &``
  49. Testing
  50. =======
  51. virtualenv
  52. ----------
  53. #. Ensure the software requirements above are met and running
  54. #. ``workon vowel && cd <PATH TO>/vowel``
  55. #. ``pip install -r requirements.testing.txt``
  56. #. ``nosetests -w testing/unittests``
  57. Licence
  58. =======
  59. Vowel is Copyright (C) 2015, 2016, 2017 Sam Black samwwwblack@lapwing.org.
  60. This program is free software: you can redistribute it and/or modify
  61. it under the terms of the GNU Affero General Public License as published by
  62. the Free Software Foundation, either version 3 of the License, or
  63. (at your option) any later version.
  64. This program is distributed in the hope that it will be useful,
  65. but WITHOUT ANY WARRANTY; without even the implied warranty of
  66. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  67. GNU Affero General Public License for more details.
  68. You should have received a copy of the GNU Affero General Public License
  69. along with this program.
  70. If not, see `http://www.gnu.org/licenses/ <http://www.gnu.org/licenses/>`_.
  71. Further licences are listed in the LICENCES directory.