README.html

<h1>EiskaltDC++ Web UI</h1>

<p>Official Web User Interface for <a href="https://github.com/eiskaltdcpp/eiskaltdcpp">eiskaltdcpp-daemon</a>. It is designed for using on embedded devices (for example in NAS) in your home network.</p>

<p>Features:</p>

<ul>
<li>Searching of files and directories</li>
<li>List of current/queued downloads</li>
<li>Status of connected hubs and basic statistics</li>
</ul>

<h2>License</h2>

<p><a href="https://github.com/eiskaltdcpp/eiskaltdcpp-web/blob/master/LICENSE">GNU GPLv3 or later</a></p>

<p>Some files are distributed under other licenses, see <a href="https://github.com/eiskaltdcpp/eiskaltdcpp-web/blob/master/full.copyrights.info.in.Debian.style">copyrights</a> file for details.</p>

<h2>Screenshots</h2>

<p><a href="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-web_downloads.png" title="Downloads">
    <img src="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-web_downloads.png" width="99%">
</a></p>

<p><a href="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-web_search.png" title="Search">
    <img src="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-web_search.png" width="99%">
</a></p>

<p><a href="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-web_status.png" title="Status">
    <img src="https://tehnick.github.io/eiskaltdcpp/eiskaltdcpp-web_status.png" width="99%">
</a></p>

<h2>Installation and usage</h2>

<p>See <a href="https://github.com/eiskaltdcpp/eiskaltdcpp-web/blob/master/INSTALL">INSTALL</a> file is you are GNU/Linux or *BSD user.</p>

<p>For MS Windows users it is enough to read <a href="https://github.com/eiskaltdcpp/eiskaltdcpp-web/blob/master/windows/help.md">help</a> file for understanding how to use Web UI. All necessary files are already included in installer and in archive with portable build.</p>

<h2>Contribution</h2>

<ul>
<li>Patches are welcome!</li>
<li>If you need to add extra library, then:
<ul>
<li>check the license of that library very carefully</li>
<li>check if that library is actively maintained (for fixing possible bugs in it)</li>
<li>copy only <strong>source version</strong> of javascript file into this repo (if you prefer using of minified versions of javascript files, you may generate them automatically during Web UI installation)</li>
</ul></li>
</ul>

<h2>Versions history</h2>

<ul>
<li>1.0.1 (2020-01-22):
<ul>
<li>Fix desktop file for Linux.</li>
<li>Add manual page for eiskaltdcpp-web script in Linux.</li>
<li>Updated embedded copies of javascript libraries: jquery-3.4.1, tablesorter-2.31.2, requirejs-2.3.6.</li>
</ul></li>
<li>1.0 (2019-06-01):
<ul>
<li>First stable release.</li>
<li>Compatible with eiskaltdcpp-daemon 2.4.0.</li>
</ul></li>
</ul>