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.

165 lines
3.7 KiB

12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
12 years ago
  1. pyDash - v1.4.4
  2. ===============
  3. A reusable django app for monitoring your linux server.
  4. Supported Python versions:
  5. - Python 2.x
  6. Requirements:
  7. - Django >= 1.5
  8. `View Demo <http://pydash.hostechs.com/>`_
  9. ::
  10. user: admin
  11. pass: admin
  12. Installation
  13. ============
  14. Clone the repository to your pc and, assuming that ``pip`` is installed,
  15. run the following commands:
  16. - ``python setup.py sdist``
  17. - ``pip install dist/django-pydash-app-*.tar.gz``
  18. Make sure that ``django.contrib.auth`` is installed and working.
  19. Open your project’s ``settings.py`` and add ``pydash`` to
  20. ``INSTALLED_APPS``:
  21. ::
  22. INSTALLED_APPS = (
  23. 'pydash',
  24. )
  25. Open your project’s ``urls.py`` and include the ``pydash`` urls.
  26. ::
  27. urlpatterns = patterns('',
  28. (r'^pydash/', include('pydash.urls')),
  29. )
  30. Make sure ``AppDirectoriesFinder`` is enabled in your
  31. ``STATICFILES_FINDERS``:
  32. ::
  33. STATICFILES_FINDERS = (
  34. 'django.contrib.staticfiles.finders.AppDirectoriesFinder',
  35. )
  36. Before deploying to a live server, run the following command in order to
  37. collect the static files stored in pydash’s directory:
  38. ::
  39. $ python manage.py collectstatic
  40. Settings
  41. ========
  42. There are 3 different refresh settings which are measured in
  43. ``miliseconds``:
  44. ::
  45. TIME_JS_REFRESH = 30000 #30 seconds
  46. TIME_JS_REFRESH_LONG = 120000 #120 seconds
  47. TIME_JS_REFRESH_NET = 2000 #2 seconds
  48. If you wish to override the default settings, simply set those fields
  49. with the new values in your application’s ``settings.py`` file.
  50. The refresh settings for each table are as follows:
  51. ::
  52. Memory Usage - TIME_JS_REFRESH
  53. Load Average - TIME_JS_REFRESH
  54. CPU Usage - TIME_JS_REFRESH
  55. Traffic Usage - TIME_JS_REFRESH_NET
  56. Disk Reads/Writes - TIME_JS_REFRESH_NET
  57. Uptime - TIME_JS_REFRESH_LONG
  58. Disk Usage - TIME_JS_REFRESH_LONG
  59. Online Users - TIME_JS_REFRESH_LONG
  60. Processes - TIME_JS_REFRESH_LONG
  61. Netstat - TIME_JS_REFRESH_LONG
  62. Remote data retrieval
  63. =====================
  64. pyDash allows you to retrieve data remotely.
  65. Data is returned in JSON and can be easily retrieved as long as the user
  66. agent has been authenticated by the web application.
  67. pyDash has a list of short URLs which you can use to retrieve the
  68. specific data:
  69. ::
  70. /info/uptime/ - Uptime
  71. /info/platform/hostname/ - Hostname
  72. /info/platform/osname/ - OS Name
  73. /info/platform/kernel/ - Kernel
  74. /info/getcpus/cpucount/ - Number of CPU cores
  75. /info/getcpus/cputype/ - Type/Name of CPU
  76. /info/memory/ - Memory Usage
  77. /info/cpuusage/ - CPU Usage in percentage(%), free and used
  78. /info/getdisk/ - Disk Usage
  79. /info/getusers/ - Online Users
  80. /info/getips/ - IP Addresses
  81. /info/gettraffic/ - Internet Traffic
  82. /info/getdiskio/ - Disk Reads/Writes
  83. /info/proc/ - Running Processes
  84. /info/loadaverage/ - Load Average
  85. /info/getnetstat/ - Netstat
  86. To see the format of the JSON returned datasets or data you can access any of the URLs from your browser
  87. as http://youpydaship/url , ex. http://demo.pydash.net/info/uptime/ .
  88. OS Support
  89. ==========
  90. pyDash was tested and runs under the following OSes:
  91. ::
  92. - Centos
  93. - Fedora
  94. - Ubuntu
  95. - Debian
  96. - Raspbian
  97. - Pidora
  98. - Arch Linux
  99. It might work under others, but it hasn’t been tested yet.
  100. Contributors
  101. ============
  102. George Zografos - george.p.zografos@gmail.com
  103. License
  104. =======
  105. `MIT <https://github.com/k3oni/pydash-django-app/blob/master/LICENSE.md>`_
  106. Issues
  107. ======
  108. Report any issues/bugs at `https://github.com/k3oni/pydash-django-app <https://github.com/k3oni/pydash-django-app>`_
  109. Credits
  110. =======
  111. `Dashboard Template <http://www.egrappler.com/templatevamp-free-twitter-bootstrap-admin-template/>`_, `Bootstrap <http://getbootstrap.com/>`_, `Font Awesome <http://fontawesome.io/>`_