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.

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