support.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Network UPS Tools - Support instructions</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" />
<meta name="description" content="Power Devices support" />
<meta name="keywords" content="NUT, Network UPS Tools, Eaton, APC, Free Software, UPS, Uninterruptible Power Supplies, PDU, Power Distributions Units, Solar Controllers, power, power devices, control, monitor, Linux, Unix, Windows, Mac OS X" />
<meta name="format-detection" content="telephone=no" />
<link rel="stylesheet" href="css/xhtml11.css" type="text/css" />
<link rel="stylesheet" href="css/xhtml11-quirks.css" type="text/css" />
<link rel="stylesheet" href="css/web-layout.css" type="text/css" />
<link rel="shortcut icon" href="faviconut.ico" />
<link rel="icon" type="image/png" href="faviconut.png" />
<script type="text/javascript" src="./scripts/asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
<!--[if lte IE 7]>
<link rel="stylesheet" href="css/ie-overrides.css" type="text/css" />
<![endif]-->
<!--[if lte IE 6]>
<script type="text/javascript" src="./scripts/filter_png.js"></script>
<![endif]-->
</head>
<body>
<div id="layout-banner-box">
<div id="layout-banner">
  <div id="layout-logo"><img src="images/nut-logo.png" alt="NUT logo" /></div>
  <div id="layout-title">Network UPS Tools</div>
  <div id="layout-description">Power Devices support</div>
</div>
</div>
<div id="layout-menu-box">
  <ul id="layout-menu">
    <li><a href="index.html">Home</a></li>
    <li><a href="download.html">Download</a></li>
    <li><a href="projects.html">Related projects</a></li>
    <li><a href="stable-hcl.html">Compatibility</a></li>
    <li><a href="features.html">Features</a></li>
    <li><a href="documentation.html">Documentation</a></li>
    <li><a href="support.html">Support</a></li>
    <li>* <a href="https://alioth-lists.debian.net/pipermail/nut-upsuser/">NUT UPS User archive</a></li>
    <li>* <a href="https://alioth-lists.debian.net/pipermail/nut-upsdev/">NUT UPS Dev archive</a></li>
    <li>* <a href="https://github.com/networkupstools/nut/">GitHub</a>:<a
        href="https://github.com/networkupstools/nut/issues">issues</a>,<a
        href="https://github.com/networkupstools/nut/wiki">wiki</a>
        and more</li>
    <li><a href="/historic/index.html">Sub-sites for historic releases</a></li>
    <li><a href="https://opencollective.com/networkupstools/">Sponsor NUT</a></li>
  </ul>
  <!-- div id="sponsor"><span>Hosted by<br/></span>
    <a href="http://sponsor.com"><img src="images/sponsor-logo.png" alt="Sponsor" /></a>
  </div -->
</div>
<div id="layout-content-box">
<div id="layout-content">
<div id="header">
<h1>Support instructions</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>There are various ways to obtain support for NUT.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
First, be sure to read the <a href="docs/FAQ.html">FAQ</a>. The most common
problems are already addressed there.
</p>
</li>
<li>
<p>
Else, you can read the <a href="docs/user-manual.chunked/index.html">NUT User Manual</a>.
It also covers many areas about installing, configuring and using NUT.
The specific steps on system integration are also discussed.
</p>
</li>
<li>
<p>
Finally, <a href="docs/man/index.html#User_man">User manual pages</a> will also
complete the User Manual provided information. At least, read the manual
page related to your driver(s).
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_mailing_lists">Mailing lists</h2>
<div class="sectionbody">
<div class="paragraph"><p>If you have still not found a solution, you should search the lists before
posting a question.</p></div>
<div class="paragraph"><p>Someone may have already solved the problem:</p></div>
<form action="http://www.google.com/search" method="get">
  <input maxlength="2048" name="as_q" size="25" type="text">
  <input name="as_oq" type="hidden" value="nut-upsuser nut-upsdev">
  <input name="domains" value="lists.alioth.debian.org" type="hidden">
  <input name="sitesearch" value="lists.alioth.debian.org" type="hidden">
  <input name="btnG" value="Search NUT lists" type="submit">
</form>
<div class="paragraph"><p>Finally, you can <strong>subscribe</strong> to a NUT mailing list to:</p></div>
<div class="sect2">
<h3 id="_request_help">Request help</h3><div style="clear:left"></div>
<div class="paragraph"><p>Use the <a href="http://lists.alioth.debian.org/mailman/listinfo/nut-upsuser">NUT Users</a>
mailing list.</p></div>
<div class="paragraph"><p>In this case, be sure to include the following information:</p></div>
<div class="ulist"><ul>
<li>
<p>
OS name and version,
</p>
</li>
<li>
<p>
exact NUT version,
</p>
</li>
<li>
<p>
NUT installation method: package, or a custom build from source tarball
  or GitHub (which fork, branch, PR),
</p>
</li>
<li>
<p>
exact device name and related information (manufacturing date, web
  pointers, &#8230;),
</p>
</li>
<li>
<p>
complete problem description, with any relevant traces, like system
  log excerpts, and driver debug output. You can obtain the latter using
  the following command, running as root and after having stopped NUT:
</p>
<div class="literalblock">
<div class="content">
<pre><code>/path/to/driver -DD -a &lt;upsname&gt;</code></pre>
</div></div>
</li>
</ul></div>
<div class="paragraph"><p>If you don&#8217;t include the above information in your help request, we will
not be able to help you!</p></div>
</div>
<div class="sect2">
<h3 id="_post_a_patch_ask_a_development_question_8230">Post a patch, ask a development question, &#8230;</h3><div style="clear:left"></div>
<div class="paragraph"><p>Use the <a href="http://lists.alioth.debian.org/mailman/listinfo/nut-upsdev">NUT Developers</a>
mailing list.</p></div>
<div class="paragraph"><p>Refer to the
<a href="docs/developer-guide.chunked/index.html">NUT Developer Guide</a>
for more information, and the chapter on how to
<a href="docs/developer-guide.chunked/developers.html#_submitting_patches">submit patches</a>.</p></div>
<div class="paragraph"><p>Note that the currently preferable way for ultimate submission of improvements
is to <a href="https://github.com/networkupstools/nut/pulls">post a pull request</a>
from your GitHub fork of NUT. Benefits of PRs include automated testing and
merge-conflict detection and resolution, as well as tracking discussion that
is often needed to better understand, integrate or document the patch.</p></div>
</div>
<div class="sect2">
<h3 id="_discuss_packaging_and_related_topics">Discuss packaging and related topics</h3><div style="clear:left"></div>
<div class="paragraph"><p>Use the <a href="http://lists.alioth.debian.org/mailman/listinfo/nut-packaging">NUT Packagers</a>
mailing list.</p></div>
<div class="paragraph"><p>Refer to the
<a href="docs/packager-guide.chunked/index.html">NUT Packager Guide</a>
 for more information.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_irc_internet_relay_chat">IRC (Internet Relay Chat)</h2>
<div class="sectionbody">
<div class="paragraph"><p>Yes, we&#8217;re open!</p></div>
<div class="paragraph"><p>There is an official <code>#nut</code> channel on <a href="https://libera.chat/">https://libera.chat/</a> network.</p></div>
<div class="paragraph"><p>Feel free to hang out with whoever is on-line at the moment, or watch reports
from the NUT CI farm as they come.</p></div>
<div class="paragraph"><p>Please don&#8217;t forget the basics of netiquette, such as that any help is done
on a best-effort basis, people have other obligations, and are not always
there even if their chat client is, and that respect and politeness are the
norm (this includes doing some research before asking, and explaining the
context where it is not trivial).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_github_issues">GitHub Issues</h2>
<div class="sectionbody">
<div class="paragraph"><p>See <a href="https://github.com/networkupstools/nut/issues">https://github.com/networkupstools/nut/issues</a> for another venue of
asking (and answering) questions, as well as proposing improvements.</p></div>
<div class="paragraph"><p>To report new Devices Dumps Library entries, posting an issue is okay, but
posting a <a href="https://github.com/networkupstools/nut-ddl/pulls">pull request</a>
is a lot better&#8201;&#8212;&#8201;easier for maintainers to review and merge any time.
For some more detailed instructions about useful DDL reports, please see
<a href="https://www.networkupstools.org/ddl/#_file_naming_convention">NUT DDL page</a>.</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version nut:v2.8.2-201-g4a6e1d4ee ddl:v2.8.2 web:v2.8.2-87-g20818b25-master<br />
Last updated 2024-05-10 20:20:32
</div>
<div id="footer-badges">
<a href="https://github.com/networkupstools/nut">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/checks-status/networkupstools/nut/master"
    alt="Latest GitHub checks status: master branch"/>
</a>
<!--
<a href="https://travis-ci.org/github/networkupstools/nut">
  <img style="border:0;height:20"
    src="https://api.travis-ci.org/networkupstools/nut.svg?branch=master"
    alt="Latest Travis CI build status: master branch"/>
</a>
-->
<a href="https://ci.networkupstools.org/job/nut/job/nut/job/master/">
  <img style="border:0;height:20"
    src="https://ci.networkupstools.org/buildStatus/icon?job=nut%2Fnut%2Fmaster"
    alt="Latest NUT CI build status: master branch"/>
</a>
<!-- MacOS, maybe later Windows builds: -->
<a href="https://app.circleci.com/pipelines/github/networkupstools">
  <img style="border:0;height:20"
    src="https://circleci.com/gh/networkupstools/nut/tree/master.svg?style=svg"
    alt="Latest Circle CI build status: master branch"/>
</a>
<!-- Windows, maybe later MacOS builds: -->
<a href="https://ci.appveyor.com/project/nut-travis/nut/build/artifacts">
  <img style="border:0;height:20"
    src="https://ci.appveyor.com/api/projects/status/vrhkatid9hr7lq7r/branch/master?svg=true&failingText=Windows-FAIL&passingText=Windows-OK&pendingText-Windows-PENDING"
    alt="Latest AppVeyor build status (NUT for Windows iterations)"/>
</a>
<!--
<a href="https://ci.networkupstools.org/job/nut/job/nut/job/fightwarn/">
  <img style="border:0;height:20"
    src="https://ci.networkupstools.org/buildStatus/icon?job=nut%2Fnut%2Ffightwarn&subject=Fightwarn%20Branch"
    alt="Latest NUT CI build status: fightwarn branch"/>
</a>
-->
<!--
<a href="https://github.com/networkupstools/nut/releases">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/v/release/networkupstools/nut"
    alt="Latest GitHub drafted NUT source release"/>
</a>
-->
<a href="https://github.com/networkupstools/nut/releases">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/v/tag/networkupstools/nut?sort=semver"
    alt="Latest Git-tagged NUT source release"/>
</a>
<!-- Maintainer note: for the counter below to work, a git tag
     is not sufficient -- a release must be drafted and published
     at https://github.com/networkupstools/nut/releases
     Counter URL may also be .../latest/BRANCHNAME -->
<a href="https://github.com/networkupstools/nut">
  <img style="border:0;height:20"
    src="https://img.shields.io/github/commits-since/networkupstools/nut/latest.svg"
    alt="Commits on master branch since latest release on GitHub"/>
</a>
<!-- See also:
 // https://web.archive.org/web/20200731075618/http://www.methods.co.nz/asciidoc/
 // https://github.com/asciidoc-py/asciidoc-py
 -->
<a href="https://asciidoc.org/">
  <img style="border:0;width:88px;height:31px"
    src="images/asciidoc.png"
    alt="Powered by AsciiDoc"/>
</a>
<a href="https://validator.w3.org/check?uri=referer">
  <img style="border:0;width:88px;height:31px"
    src="https://www.w3.org/Icons/valid-xhtml11-blue"
    alt="Valid XHTML 1.1"/>
</a>
<a href="https://jigsaw.w3.org/css-validator/check?uri=referer">
  <img style="border:0;width:88px;height:31px"
    src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
    alt="Valid CSS!"/>
</a>
<a href="https://www.gandi.net/">
  <img style="border:0;height:38px;"
       src="images/gandi-ar21.svg"
       alt="DNS, redirection and related services Hoster"/>
</a>
<!--
// FH web site defunct since ~Apr 2024
<a href="https://fosshost.org/">
  <img style="border:0;width:112px;height:38px;"
       src="images/ci/fosshost.org_Host_Light_38px.png"
       alt="Dedicated Hosting for NUT CI"/>
</a>
-->
<a href="https://www.digitalocean.com/?refcode=d2fbf2b9e082&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
  <img style="border:0;height:38px;"
       src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/PoweredByDO/DO_Powered_by_Badge_blue.svg"
       alt="Dedicated Hosting for NUT CI"/>
</a>
</div>
</div>
</div>
</div>
<!-- Google Analytics integration -->
<script type="text/javascript">

        var _gaq = _gaq || [];
        _gaq.push(['_setAccount', 'UA-9664272-1']);
        _gaq.push(['_trackPageview']);

        (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
        })();

</script>
</body>
</html>