linspector/linspector.github.io
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Imported old code.

Browse source
This commit is contained in:
Johannes Findeisen 2023-08-22 03:14:43 +02:00
commit 89d94c38b6
243 changed files with 26457 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

0
development/api/.gitkeep Normal file
View file

16
development/api/index.html Normal file
View file

@ -0,0 +1,16 @@
---
layout: default
title: API Documentation
metasub: development
keywords: development,documentation,api
---
<h2>API Documentation</h2>
<p>Please clone the repository from GitHub and generate the API documentation using the following command:</p>
<pre>make docs</pre>
<p>Afterwards you will find the API docs in the ./docs/ directory.</p>
<p>API documentation will be published here in the future too.</p>

64
development/index.html Normal file
View file

@ -0,0 +1,64 @@
---
layout: default
title: Development
metasub: development
keywords: development,code,environment,dependencies,api,developers,commits
---
<h2>Development</h2>
<h3>Code</h3>
<p>The code is available at <a href="https://github.com/linspector/linspector" class="ext">https://github.com/linspector/linspector</a>.</p>
<p>To get the code run the following command:</p>
<pre>git clone https://github.com/linspector/linspector.git</pre>
<h3>Environment</h3>
<p>We are using <a href="http://www.python.org/" class="ext">Python</a> as the programming language interpreted by CPython. The IDE we are using is <a href="http://www.jetbrains.com/pycharm/" class="ext">PyCharm</a>. Source Code Management is done using <a href="http://git-scm.com/" class="ext">Git</a> and it is hosted at <a href="https://github.com/" class="ext">GitHub</a>. All of us are using <a href="http://www.kernel.org/" class="ext">Linux</a> as operating system though Linspector should run on other operating systems like *BSD, UNIX&trade;, OSX&trade; and Windows&trade;.</p>
<h3>External dependencies are currently:</h3>
<ul>
<li><a href="https://pypi.python.org/pypi/APScheduler/" class="ext">APScheduler</a> - for job scheduling (<b>required</b>) / MIT license</li>
<li><a href="http://deavid.github.io/bjsonrpc/" class="ext">bjsonrpc</a> - for the JSON-RPC backend (optionally) / BSD 3-clause license</li>
<li><a href="https://github.com/paramiko/paramiko" class="ext">Paramiko</a> - for the SSH service (optionally) / LGPL license</li>
<li><a href="https://github.com/mongodb/mongo-python-driver" class="ext">pymongo</a> - for the MongoDB task (optionally) / Apache License Version 2.0</li>
<li><a href="https://github.com/farcepest/MySQLdb1" class="ext">MySQLdb1</a> - for the MariaDB task (optionally) / GPL License Version 2</li>
<li><a href="http://pysnmp.sourceforge.net/" class="ext">PySNMP</a> - for the SNMP service (optionally) / BSD-style license</li>
<li><a href="https://bitbucket.org/xi/pyyaml" class="ext">PyYAML</a> - for YAML formatted configuration files (optionally) / MIT license</li>
<li><a href="https://github.com/kennethreitz/requests" class="ext">requests</a> - for using HTTP services (optionally) / Apache License Version 2.0</li>
<li><a href="http://excess.org/urwid/" class="ext">urwid</a> - when using the urwid based frontend called urlish (optionally) / GNU Lesser General Public License 2.1</li>
</ul>
<p>In the future the required dependencies are based on which services and tasks you use in Linspector. For example APScheduler is a core library which is always used, PyYAML when using the YAML style configuration and Paramiko is only needed when you use the SSH service to poll hosts. XMPP is only needed when reporting alerts using the Jabber task etc.</p>
<h3>API</h3>
<p>You will find API related documentation here:</p>
<ul>
<li><a href="/development/api/">API Documentation</a></li>
</ul>
<h3>Developers</h3>
<h4>Johannes Findeisen (Founder and Maintainer)</h4>
<ul>
<li>Email: <a href="mailto:you@hanez.org" class="mail">you@hanez.org</a></li>
<li>GitHub: <a href="https://github.com/hanez" class="ext">https://github.com/hanez</a></li>
<li>Homepage: <a href="http://hanez.org" class="ext">http://hanez.org</a></li>
<li>XMPP: <a href="xmpp:hanez@systemchaos.org" class="cube">hanez@systemchaos.org</a></li>
</ul>
<h3>Commit Log</h3>
<div id="github-commits"></div>
<script>
$(function() {
$('#github-commits').githubInfoWidget({ user: 'linspector', repo: 'linspector', branch: 'master', last: 30 });
});
</script>