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.

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