README.rst 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. Supervisor
  2. ==========
  3. Supervisor is a client/server system that allows its users to
  4. control a number of processes on UNIX-like operating systems.
  5. Supported Platforms
  6. -------------------
  7. Supervisor has been tested and is known to run on Linux (Ubuntu), Mac OS X
  8. (10.4, 10.5, 10.6), and Solaris (10 for Intel) and FreeBSD 6.1. It will
  9. likely work fine on most UNIX systems.
  10. Supervisor will not run at all under any version of Windows.
  11. **Supervisor does not work on Python 3.** This is the master branch,
  12. which has work-in-progress support for Python 3. Supervisor is very likely
  13. to crash, cause subprocesses to hang, or otherwise behave unexpectedly
  14. when run on Python 3. See
  15. `issues running Supervisor on Python 3 <https://github.com/Supervisor/supervisor/labels/python%203>`_.
  16. It may also have regressions on Python 2 as a result of attempts to
  17. add Python 3 support. Help from developers with Python 3 porting
  18. experience is needed. **Do not use this branch on any production system.**
  19. Supervisor 4.0 (unreleased) is planned to work under Python 2 version 2.6
  20. or greater and Python 3 version 3.2 or greater. See note above about the
  21. current state of Python 3 support.
  22. Documentation
  23. -------------
  24. You can view the current Supervisor documentation online `in HTML format
  25. <http://supervisord.org/>`_ . This is where you should go for detailed
  26. installation and configuration documentation.
  27. Mailing list, Reporting Bugs, and Viewing the Source Repository
  28. ---------------------------------------------------------------
  29. You may subscribe to the `Supervisor-users mailing list
  30. <http://lists.supervisord.org/mailman/listinfo/supervisor-users>`_.
  31. Please report bugs in the `Github issue tracker
  32. <https://github.com/Supervisor/supervisor/issues>`_.
  33. You can view the source repository for supervisor via
  34. `https://github.com/Supervisor/supervisor
  35. <https://github.com/Supervisor/supervisor>`_.
  36. Contributing
  37. ------------
  38. If you'd like to contribute to supervisor directly, please contact the
  39. `Supervisor-users mailing list
  40. <http://lists.supervisord.org/mailman/listinfo/supervisor-users>`_.