Nagios Webmin Module
This commit is contained in:
parent
0f25e48548
commit
1806c6751f
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
50
README.md
50
README.md
|
|
@ -1,2 +1,50 @@
|
||||||
# Nagios-Webmin-Module
|
|
||||||
|
|
||||||
|
# Nagios Webmin Module
|
||||||
|
|
||||||
|
[](https://nagios-module.citedcorp.com/en/latest/?badge=latest)
|
||||||
|
|
||||||
|
# Info
|
||||||
|
Nagios Module for Webmin. Install and Manage Nagios Core and nrpe.
|
||||||
|
|
||||||
|
# Install via script:
|
||||||
|
|
||||||
|
wget https://raw.githubusercontent.com/cited/nagios-webmin-module/master/scripts/pre-install.sh
|
||||||
|
chmod +x pre-install.sh
|
||||||
|
./pre-install.sh
|
||||||
|
|
||||||
|
Go to Servers->Nagios and complete the installtion Wizard.
|
||||||
|
|
||||||
|
# Install from GIT
|
||||||
|
Archive module
|
||||||
|
|
||||||
|
$ git clone https://github.com/cited/nagios-webmin-module/
|
||||||
|
|
||||||
|
$ mv nagios-webmin-module nagios
|
||||||
|
|
||||||
|
$ tar -cvzf nagios.wbm.gz nagios/
|
||||||
|
|
||||||
|
Upload from Webmin->Webmin Configuration->Webmin Modules
|
||||||
|
|
||||||
|
Go to Servers->Nagios and complete the installtion Wizard.
|
||||||
|
|
||||||
|
# Notes
|
||||||
|
|
||||||
|
## **Ubuntu**
|
||||||
|
Tested on Ubuntu 18 and 20 LTS
|
||||||
|
|
||||||
|
## **Readhat/Fedora/CentOS**
|
||||||
|
Tested on CentOS 7x64
|
||||||
|
|
||||||
|
## **Issues**
|
||||||
|
Please report issue here
|
||||||
|
|
||||||
|
# Screen Shot
|
||||||
|
|
||||||
|
Nagios Module:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Copyright
|
||||||
|
---------
|
||||||
|
|
||||||
|
* Copyright Cited, Inc, 2020
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
nagios_config=Path to the Nagios Webmin module config file,8
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
#!/usr/bin/perl
|
||||||
|
# Update a manually edited config file
|
||||||
|
|
||||||
|
require './nagios-lib.pl';
|
||||||
|
&error_setup($text{'manual_err'});
|
||||||
|
&ReadParse();
|
||||||
|
|
||||||
|
# Work out the file
|
||||||
|
my $obj_dir = get_nagios_home().'/etc/objects';
|
||||||
|
my $cfg_file = $obj_dir."/".$in{'new_filename'};
|
||||||
|
|
||||||
|
# Write to it
|
||||||
|
©_source_dest($module_root_directory."/template.cfg", $cfg_file)
|
||||||
|
|
||||||
|
&redirect("/nagios/edit_objects.cgi?file=".&urlize($cfg_file));
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
SPHINXPROJ = ReadtheDocsSphinxTheme
|
||||||
|
SOURCEDIR = .
|
||||||
|
BUILDDIR = build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
1
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
|
|
@ -0,0 +1,30 @@
|
||||||
|
"""
|
||||||
|
Sphinx Read the Docs theme.
|
||||||
|
|
||||||
|
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from os import path
|
||||||
|
|
||||||
|
import sphinx
|
||||||
|
|
||||||
|
|
||||||
|
__version__ = '0.4.3.dev0'
|
||||||
|
__version_full__ = __version__
|
||||||
|
|
||||||
|
|
||||||
|
def get_html_theme_path():
|
||||||
|
"""Return list of HTML theme paths."""
|
||||||
|
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
|
||||||
|
return cur_dir
|
||||||
|
|
||||||
|
|
||||||
|
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
|
||||||
|
def setup(app):
|
||||||
|
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
|
||||||
|
|
||||||
|
if sphinx.version_info >= (1, 8, 0):
|
||||||
|
# Add Sphinx message catalog for newer versions of Sphinx
|
||||||
|
# See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog
|
||||||
|
rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale')
|
||||||
|
app.add_message_catalog('sphinx', rtd_locale_path)
|
||||||
|
|
@ -0,0 +1,82 @@
|
||||||
|
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
|
||||||
|
|
||||||
|
{% if page_source_suffix %}
|
||||||
|
{% set suffix = page_source_suffix %}
|
||||||
|
{% else %}
|
||||||
|
{% set suffix = source_suffix %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if meta is defined and meta is not none %}
|
||||||
|
{% set check_meta = True %}
|
||||||
|
{% else %}
|
||||||
|
{% set check_meta = False %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if check_meta and 'github_url' in meta %}
|
||||||
|
{% set display_github = True %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if check_meta and 'bitbucket_url' in meta %}
|
||||||
|
{% set display_bitbucket = True %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if check_meta and 'gitlab_url' in meta %}
|
||||||
|
{% set display_gitlab = True %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||||
|
|
||||||
|
<ul class="wy-breadcrumbs">
|
||||||
|
{% block breadcrumbs %}
|
||||||
|
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> »</li>
|
||||||
|
{% for doc in parents %}
|
||||||
|
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li>
|
||||||
|
{% endfor %}
|
||||||
|
<li>{{ title }}</li>
|
||||||
|
{% endblock %}
|
||||||
|
{% block breadcrumbs_aside %}
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
{% if hasdoc(pagename) %}
|
||||||
|
{% if display_github %}
|
||||||
|
{% if check_meta and 'github_url' in meta %}
|
||||||
|
<!-- User defined GitHub URL -->
|
||||||
|
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||||
|
{% else %}
|
||||||
|
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
{% elif display_bitbucket %}
|
||||||
|
{% if check_meta and 'bitbucket_url' in meta %}
|
||||||
|
<!-- User defined Bitbucket URL -->
|
||||||
|
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||||
|
{% else %}
|
||||||
|
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
{% elif display_gitlab %}
|
||||||
|
{% if check_meta and 'gitlab_url' in meta %}
|
||||||
|
<!-- User defined GitLab URL -->
|
||||||
|
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||||
|
{% else %}
|
||||||
|
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
{% elif show_source and source_url_prefix %}
|
||||||
|
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
|
||||||
|
{% elif show_source and has_source and sourcename %}
|
||||||
|
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
</li>
|
||||||
|
{% endblock %}
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||||
|
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
|
||||||
|
{% if next %}
|
||||||
|
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
{% endif %}
|
||||||
|
{% if prev %}
|
||||||
|
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
<hr/>
|
||||||
|
</div>
|
||||||
|
|
@ -0,0 +1,56 @@
|
||||||
|
<footer>
|
||||||
|
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
|
||||||
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||||
|
{% if next %}
|
||||||
|
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
|
||||||
|
{% endif %}
|
||||||
|
{% if prev %}
|
||||||
|
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<hr/>
|
||||||
|
|
||||||
|
<div role="contentinfo">
|
||||||
|
<p>
|
||||||
|
{%- if show_copyright %}
|
||||||
|
{%- if hasdoc('copyright') %}
|
||||||
|
{% set path = pathto('copyright') %}
|
||||||
|
{% set copyright = copyright|e %}
|
||||||
|
© <a href="{{ path }}">{% trans %}Copyright{% endtrans %}</a> {{ copyright }}
|
||||||
|
{%- else %}
|
||||||
|
{% set copyright = copyright|e %}
|
||||||
|
© {% trans %}Copyright{% endtrans %} {{ copyright }}
|
||||||
|
{%- endif %}
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- if build_id and build_url %}
|
||||||
|
<span class="build">
|
||||||
|
{# Translators: Build is a noun, not a verb #}
|
||||||
|
{% trans %}Build{% endtrans %}
|
||||||
|
<a href="{{ build_url }}">{{ build_id }}</a>.
|
||||||
|
</span>
|
||||||
|
{%- elif commit %}
|
||||||
|
<span class="commit">
|
||||||
|
{% trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
|
||||||
|
</span>
|
||||||
|
{%- elif last_updated %}
|
||||||
|
<span class="lastupdated">
|
||||||
|
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
|
||||||
|
</span>
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{%- if show_sphinx %}
|
||||||
|
{% set sphinx_web = '<a href="http://sphinx-doc.org/">Sphinx</a>' %}
|
||||||
|
{% set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
|
||||||
|
{% trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %} <a href="https://github.com/rtfd/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a> {% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
|
||||||
|
{%- endif %}
|
||||||
|
|
||||||
|
{%- block extrafooter %} {% endblock %}
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
|
@ -0,0 +1,240 @@
|
||||||
|
{# TEMPLATE VAR SETTINGS #}
|
||||||
|
{%- set url_root = pathto('', 1) %}
|
||||||
|
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
|
||||||
|
{%- if not embedded and docstitle %}
|
||||||
|
{%- set titlesuffix = " — "|safe + docstitle|e %}
|
||||||
|
{%- else %}
|
||||||
|
{%- set titlesuffix = "" %}
|
||||||
|
{%- endif %}
|
||||||
|
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="{{ lang_attr }}" >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
{{ metatags }}
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
{% block htmltitle %}
|
||||||
|
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
|
||||||
|
{% endblock %}
|
||||||
|
|
||||||
|
{# FAVICON #}
|
||||||
|
{% if favicon %}
|
||||||
|
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
|
||||||
|
{% endif %}
|
||||||
|
{# CANONICAL URL #}
|
||||||
|
{% if theme_canonical_url %}
|
||||||
|
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{# JAVASCRIPTS #}
|
||||||
|
{%- block scripts %}
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
|
||||||
|
<![endif]-->
|
||||||
|
{%- if not embedded %}
|
||||||
|
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
|
||||||
|
{% if sphinx_version >= "1.8.0" %}
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
|
||||||
|
{%- for scriptfile in script_files %}
|
||||||
|
{{ js_tag(scriptfile) }}
|
||||||
|
{%- endfor %}
|
||||||
|
{% else %}
|
||||||
|
<script type="text/javascript">
|
||||||
|
var DOCUMENTATION_OPTIONS = {
|
||||||
|
URL_ROOT:'{{ url_root }}',
|
||||||
|
VERSION:'{{ release|e }}',
|
||||||
|
LANGUAGE:'{{ language }}',
|
||||||
|
COLLAPSE_INDEX:false,
|
||||||
|
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
|
||||||
|
HAS_SOURCE: {{ has_source|lower }},
|
||||||
|
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
|
||||||
|
};
|
||||||
|
</script>
|
||||||
|
{%- for scriptfile in script_files %}
|
||||||
|
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
|
||||||
|
{%- endfor %}
|
||||||
|
{% endif %}
|
||||||
|
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
|
||||||
|
|
||||||
|
{# OPENSEARCH #}
|
||||||
|
{%- if use_opensearch %}
|
||||||
|
<link rel="search" type="application/opensearchdescription+xml"
|
||||||
|
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
|
||||||
|
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
|
||||||
|
{%- endif %}
|
||||||
|
{%- endif %}
|
||||||
|
{%- endblock %}
|
||||||
|
|
||||||
|
{# CSS #}
|
||||||
|
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
|
||||||
|
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
|
||||||
|
{%- for css in css_files %}
|
||||||
|
{%- if css|attr("rel") %}
|
||||||
|
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
|
||||||
|
{%- else %}
|
||||||
|
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- endfor %}
|
||||||
|
|
||||||
|
{%- for cssfile in extra_css_files %}
|
||||||
|
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
||||||
|
{%- endfor %}
|
||||||
|
|
||||||
|
{%- block linktags %}
|
||||||
|
{%- if hasdoc('about') %}
|
||||||
|
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- if hasdoc('genindex') %}
|
||||||
|
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- if hasdoc('search') %}
|
||||||
|
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- if hasdoc('copyright') %}
|
||||||
|
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- if next %}
|
||||||
|
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- if prev %}
|
||||||
|
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
|
||||||
|
{%- endif %}
|
||||||
|
{%- endblock %}
|
||||||
|
{%- block extrahead %} {% endblock %}
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="wy-body-for-nav">
|
||||||
|
|
||||||
|
{% block extrabody %} {% endblock %}
|
||||||
|
<div class="wy-grid-for-nav">
|
||||||
|
{# SIDE NAV, TOGGLES ON MOBILE #}
|
||||||
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||||
|
<div class="wy-side-scroll">
|
||||||
|
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
|
||||||
|
{% block sidebartitle %}
|
||||||
|
|
||||||
|
{% if logo and theme_logo_only %}
|
||||||
|
<a href="{{ pathto(master_doc) }}">
|
||||||
|
{% else %}
|
||||||
|
<a href="{{ pathto(master_doc) }}" class="icon icon-home" alt="{{ _("Documentation Home") }}"> {{ project }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if logo %}
|
||||||
|
{# Not strictly valid HTML, but it's the only way to display/scale
|
||||||
|
it properly, without weird scripting or heaps of work
|
||||||
|
#}
|
||||||
|
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="{{ _('Logo') }}"/>
|
||||||
|
{% endif %}
|
||||||
|
</a>
|
||||||
|
|
||||||
|
{% if theme_display_version %}
|
||||||
|
{%- set nav_version = version %}
|
||||||
|
{% if READTHEDOCS and current_version %}
|
||||||
|
{%- set nav_version = current_version %}
|
||||||
|
{% endif %}
|
||||||
|
{% if nav_version %}
|
||||||
|
<div class="version">
|
||||||
|
{{ nav_version }}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% include "searchbox.html" %}
|
||||||
|
|
||||||
|
{% endblock %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{% block navigation %}
|
||||||
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||||
|
{% block menu %}
|
||||||
|
{#
|
||||||
|
The singlehtml builder doesn't handle this toctree call when the
|
||||||
|
toctree is empty. Skip building this for now.
|
||||||
|
#}
|
||||||
|
{% if 'singlehtml' not in builder %}
|
||||||
|
{% set global_toc = toctree(maxdepth=theme_navigation_depth|int,
|
||||||
|
collapse=theme_collapse_navigation|tobool,
|
||||||
|
includehidden=theme_includehidden|tobool,
|
||||||
|
titles_only=theme_titles_only|tobool) %}
|
||||||
|
{% endif %}
|
||||||
|
{% if global_toc %}
|
||||||
|
{{ global_toc }}
|
||||||
|
{% else %}
|
||||||
|
<!-- Local TOC -->
|
||||||
|
<div class="local-toc">{{ toc }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% endblock %}
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||||
|
|
||||||
|
{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
||||||
|
<nav class="wy-nav-top" aria-label="top navigation">
|
||||||
|
{% block mobile_nav %}
|
||||||
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||||
|
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
|
||||||
|
{% endblock %}
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="wy-nav-content">
|
||||||
|
{%- block content %}
|
||||||
|
{% if theme_style_external_links|tobool %}
|
||||||
|
<div class="rst-content style-external-links">
|
||||||
|
{% else %}
|
||||||
|
<div class="rst-content">
|
||||||
|
{% endif %}
|
||||||
|
{% include "breadcrumbs.html" %}
|
||||||
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||||
|
{%- block document %}
|
||||||
|
<div itemprop="articleBody">
|
||||||
|
{% block body %}{% endblock %}
|
||||||
|
</div>
|
||||||
|
{% if self.comments()|trim %}
|
||||||
|
<div class="articleComments">
|
||||||
|
{% block comments %}{% endblock %}
|
||||||
|
</div>
|
||||||
|
{% endif%}
|
||||||
|
</div>
|
||||||
|
{%- endblock %}
|
||||||
|
{% include "footer.html" %}
|
||||||
|
</div>
|
||||||
|
{%- endblock %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</section>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
{% include "versions.html" %}
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
jQuery(function () {
|
||||||
|
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
{# Do not conflict with RTD insertion of analytics script #}
|
||||||
|
{% if not READTHEDOCS %}
|
||||||
|
{% if theme_analytics_id %}
|
||||||
|
<!-- Theme Analytics -->
|
||||||
|
<script>
|
||||||
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||||
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||||
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||||
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||||
|
|
||||||
|
ga('create', '{{ theme_analytics_id }}', 'auto');
|
||||||
|
ga('send', 'pageview');
|
||||||
|
</script>
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{%- block footer %} {% endblock %}
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,147 @@
|
||||||
|
# English translations for sphinx_rtd_theme.
|
||||||
|
# Copyright (C) 2019 ORGANIZATION
|
||||||
|
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||||
|
# project.
|
||||||
|
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||||
|
#
|
||||||
|
msgid ""
|
||||||
|
msgstr ""
|
||||||
|
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||||
|
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||||
|
"POT-Creation-Date: 2019-07-24 23:51-0600\n"
|
||||||
|
"PO-Revision-Date: 2019-07-16 15:43-0600\n"
|
||||||
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
|
"Language: en\n"
|
||||||
|
"Language-Team: en <LL@li.org>\n"
|
||||||
|
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
||||||
|
"MIME-Version: 1.0\n"
|
||||||
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
|
"Generated-By: Babel 2.7.0\n"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:31
|
||||||
|
msgid "Docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:43 sphinx_rtd_theme/breadcrumbs.html:45
|
||||||
|
msgid "Edit on GitHub"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:50 sphinx_rtd_theme/breadcrumbs.html:52
|
||||||
|
msgid "Edit on Bitbucket"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:57 sphinx_rtd_theme/breadcrumbs.html:59
|
||||||
|
msgid "Edit on GitLab"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:62 sphinx_rtd_theme/breadcrumbs.html:64
|
||||||
|
msgid "View page source"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:74 sphinx_rtd_theme/footer.html:5
|
||||||
|
msgid "Next"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:77 sphinx_rtd_theme/footer.html:8
|
||||||
|
msgid "Previous"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:21 sphinx_rtd_theme/footer.html:24
|
||||||
|
#: sphinx_rtd_theme/layout.html:92
|
||||||
|
msgid "Copyright"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. Build is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/footer.html:31
|
||||||
|
msgid "Build"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:36
|
||||||
|
msgid "Revision"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:40
|
||||||
|
#, python-format
|
||||||
|
msgid "Last updated on %(last_updated)s."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "Built with %(sphinx_web)s using a"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
msgid "theme"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "provided by %(readthedocs_web)s"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:61
|
||||||
|
#, python-format
|
||||||
|
msgid "Search within %(docstitle)s"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:83
|
||||||
|
msgid "About these documents"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:86
|
||||||
|
msgid "Index"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:89 sphinx_rtd_theme/search.html:11
|
||||||
|
msgid "Search"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:124
|
||||||
|
msgid "Logo"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:26
|
||||||
|
msgid "Please activate JavaScript to enable the search functionality."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. Search is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/search.html:34
|
||||||
|
msgid "Search Results"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:36
|
||||||
|
msgid ""
|
||||||
|
"Your search did not match any documents. Please make sure that all words "
|
||||||
|
"are spelled correctly and that you've selected enough categories."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/searchbox.html:4
|
||||||
|
msgid "Search docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:11
|
||||||
|
msgid "Versions"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:17
|
||||||
|
msgid "Downloads"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. The phrase "Read the Docs" is not translated
|
||||||
|
#: sphinx_rtd_theme/versions.html:24
|
||||||
|
msgid "On Read the Docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:26
|
||||||
|
msgid "Project Home"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:29
|
||||||
|
msgid "Builds"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:33
|
||||||
|
msgid "Free document hosting provided by"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,149 @@
|
||||||
|
# Spanish translations for sphinx_rtd_theme.
|
||||||
|
# Copyright (C) 2019 Read the Docs, Inc
|
||||||
|
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||||
|
# project.
|
||||||
|
msgid ""
|
||||||
|
msgstr ""
|
||||||
|
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||||
|
"Report-Msgid-Bugs-To: support@readthedocs.org\n"
|
||||||
|
"POT-Creation-Date: 2019-07-24 23:51-0600\n"
|
||||||
|
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||||
|
"Last-Translator: Anthony <aj@ohess.org>, 2019\n"
|
||||||
|
"Language: es\n"
|
||||||
|
"Language-Team: Spanish "
|
||||||
|
"(https://www.transifex.com/readthedocs/teams/101354/es/)\n"
|
||||||
|
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
||||||
|
"MIME-Version: 1.0\n"
|
||||||
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
|
"Generated-By: Babel 2.7.0\n"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:31
|
||||||
|
msgid "Docs"
|
||||||
|
msgstr "Documentos"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:43 sphinx_rtd_theme/breadcrumbs.html:45
|
||||||
|
msgid "Edit on GitHub"
|
||||||
|
msgstr "Editar en GitHub"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:50 sphinx_rtd_theme/breadcrumbs.html:52
|
||||||
|
msgid "Edit on Bitbucket"
|
||||||
|
msgstr "Editar en Bitbucket"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:57 sphinx_rtd_theme/breadcrumbs.html:59
|
||||||
|
msgid "Edit on GitLab"
|
||||||
|
msgstr "Editar en GitLab"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:62 sphinx_rtd_theme/breadcrumbs.html:64
|
||||||
|
msgid "View page source"
|
||||||
|
msgstr "Ver código fuente de la página"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:74 sphinx_rtd_theme/footer.html:5
|
||||||
|
msgid "Next"
|
||||||
|
msgstr "Siguiente"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:77 sphinx_rtd_theme/footer.html:8
|
||||||
|
msgid "Previous"
|
||||||
|
msgstr "Anterior"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:21 sphinx_rtd_theme/footer.html:24
|
||||||
|
#: sphinx_rtd_theme/layout.html:92
|
||||||
|
msgid "Copyright"
|
||||||
|
msgstr "Derechos de autor"
|
||||||
|
|
||||||
|
#. Build is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/footer.html:31
|
||||||
|
msgid "Build"
|
||||||
|
msgstr "Construido"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:36
|
||||||
|
msgid "Revision"
|
||||||
|
msgstr "Revisión"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:40
|
||||||
|
#, python-format
|
||||||
|
msgid "Last updated on %(last_updated)s."
|
||||||
|
msgstr "Actualizado por última vez en %(last_updated)s."
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "Built with %(sphinx_web)s using a"
|
||||||
|
msgstr "Construido con %(sphinx_web)s usando un"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
msgid "theme"
|
||||||
|
msgstr "tema"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "provided by %(readthedocs_web)s"
|
||||||
|
msgstr "proporcionado por %(readthedocs_web)s"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:61
|
||||||
|
#, python-format
|
||||||
|
msgid "Search within %(docstitle)s"
|
||||||
|
msgstr "Buscar en %(docstitle)s"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:83
|
||||||
|
msgid "About these documents"
|
||||||
|
msgstr "Sobre esta documentación"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:86
|
||||||
|
msgid "Index"
|
||||||
|
msgstr "Índice"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:89 sphinx_rtd_theme/search.html:11
|
||||||
|
msgid "Search"
|
||||||
|
msgstr "Búsqueda"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:124
|
||||||
|
msgid "Logo"
|
||||||
|
msgstr "Logotipo"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:26
|
||||||
|
msgid "Please activate JavaScript to enable the search functionality."
|
||||||
|
msgstr "Por favor, active JavaScript para habilitar la funcionalidad de búsqueda."
|
||||||
|
|
||||||
|
#. Search is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/search.html:34
|
||||||
|
msgid "Search Results"
|
||||||
|
msgstr "Resultados de la búsqueda"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:36
|
||||||
|
msgid ""
|
||||||
|
"Your search did not match any documents. Please make sure that all words "
|
||||||
|
"are spelled correctly and that you've selected enough categories."
|
||||||
|
msgstr ""
|
||||||
|
"Su búsqueda no coincide con ningún documento. Por favor, asegúrese de que"
|
||||||
|
" todas las palabras estén correctamente escritas y que usted haya "
|
||||||
|
"seleccionado las suficientes categorías."
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/searchbox.html:4
|
||||||
|
msgid "Search docs"
|
||||||
|
msgstr "Buscar documentos"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:11
|
||||||
|
msgid "Versions"
|
||||||
|
msgstr "Versiones"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:17
|
||||||
|
msgid "Downloads"
|
||||||
|
msgstr "Descargas"
|
||||||
|
|
||||||
|
#. The phrase "Read the Docs" is not translated
|
||||||
|
#: sphinx_rtd_theme/versions.html:24
|
||||||
|
msgid "On Read the Docs"
|
||||||
|
msgstr "En Read the Docs"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:26
|
||||||
|
msgid "Project Home"
|
||||||
|
msgstr "Página de Proyecto"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:29
|
||||||
|
msgid "Builds"
|
||||||
|
msgstr "Construcciones"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:33
|
||||||
|
msgid "Free document hosting provided by"
|
||||||
|
msgstr "Alojamiento gratuito de documentos proporcionado por"
|
||||||
|
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,152 @@
|
||||||
|
# English translations for sphinx_rtd_theme.
|
||||||
|
# Copyright (C) 2019 ORGANIZATION
|
||||||
|
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||||
|
# project.
|
||||||
|
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||||
|
#
|
||||||
|
# Translators:
|
||||||
|
# Jesse Tan, 2019
|
||||||
|
msgid ""
|
||||||
|
msgstr ""
|
||||||
|
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||||
|
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||||
|
"POT-Creation-Date: 2019-07-24 23:51-0600\n"
|
||||||
|
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||||
|
"Last-Translator: Jesse Tan, 2019\n"
|
||||||
|
"Language: nl\n"
|
||||||
|
"Language-Team: Dutch "
|
||||||
|
"(https://www.transifex.com/readthedocs/teams/101354/nl/)\n"
|
||||||
|
"Plural-Forms: nplurals=2; plural=(n != 1)\n"
|
||||||
|
"MIME-Version: 1.0\n"
|
||||||
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
|
"Generated-By: Babel 2.7.0\n"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:31
|
||||||
|
msgid "Docs"
|
||||||
|
msgstr "Documentatie"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:43 sphinx_rtd_theme/breadcrumbs.html:45
|
||||||
|
msgid "Edit on GitHub"
|
||||||
|
msgstr "Bewerk op GitHub"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:50 sphinx_rtd_theme/breadcrumbs.html:52
|
||||||
|
msgid "Edit on Bitbucket"
|
||||||
|
msgstr "Bewerk op BitBucket"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:57 sphinx_rtd_theme/breadcrumbs.html:59
|
||||||
|
msgid "Edit on GitLab"
|
||||||
|
msgstr "Bewerk op GitLab"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:62 sphinx_rtd_theme/breadcrumbs.html:64
|
||||||
|
msgid "View page source"
|
||||||
|
msgstr "Bekijk paginabron"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:74 sphinx_rtd_theme/footer.html:5
|
||||||
|
msgid "Next"
|
||||||
|
msgstr "Volgende"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:77 sphinx_rtd_theme/footer.html:8
|
||||||
|
msgid "Previous"
|
||||||
|
msgstr "Vorige"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:21 sphinx_rtd_theme/footer.html:24
|
||||||
|
#: sphinx_rtd_theme/layout.html:92
|
||||||
|
msgid "Copyright"
|
||||||
|
msgstr "Copyright"
|
||||||
|
|
||||||
|
#. Build is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/footer.html:31
|
||||||
|
msgid "Build"
|
||||||
|
msgstr "Bouwsel"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:36
|
||||||
|
msgid "Revision"
|
||||||
|
msgstr "Revisie"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:40
|
||||||
|
#, python-format
|
||||||
|
msgid "Last updated on %(last_updated)s."
|
||||||
|
msgstr "Laatste update op %(last_updated)s."
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "Built with %(sphinx_web)s using a"
|
||||||
|
msgstr "Gebouwd met %(sphinx_web)s met een"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
msgid "theme"
|
||||||
|
msgstr "thema"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "provided by %(readthedocs_web)s"
|
||||||
|
msgstr "geleverd door %(readthedocs_web)s"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:61
|
||||||
|
#, python-format
|
||||||
|
msgid "Search within %(docstitle)s"
|
||||||
|
msgstr "Zoek binnen %(docstitle)s"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:83
|
||||||
|
msgid "About these documents"
|
||||||
|
msgstr "Over deze documenten"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:86
|
||||||
|
msgid "Index"
|
||||||
|
msgstr "Index"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:89 sphinx_rtd_theme/search.html:11
|
||||||
|
msgid "Search"
|
||||||
|
msgstr "Zoek"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:124
|
||||||
|
msgid "Logo"
|
||||||
|
msgstr "Logo"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:26
|
||||||
|
msgid "Please activate JavaScript to enable the search functionality."
|
||||||
|
msgstr "Zet JavaScript aan om de zoekfunctie mogelijk te maken."
|
||||||
|
|
||||||
|
#. Search is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/search.html:34
|
||||||
|
msgid "Search Results"
|
||||||
|
msgstr "Zoekresultaten"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:36
|
||||||
|
msgid ""
|
||||||
|
"Your search did not match any documents. Please make sure that all words "
|
||||||
|
"are spelled correctly and that you've selected enough categories."
|
||||||
|
msgstr ""
|
||||||
|
"Zoekpoging vond geen documenten. Zorg ervoor dat alle woorden correct "
|
||||||
|
"zijn gespeld en dat voldoende categorieën zijn geselecteerd."
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/searchbox.html:4
|
||||||
|
msgid "Search docs"
|
||||||
|
msgstr "Zoek in documentatie"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:11
|
||||||
|
msgid "Versions"
|
||||||
|
msgstr "Versies"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:17
|
||||||
|
msgid "Downloads"
|
||||||
|
msgstr "Downloads"
|
||||||
|
|
||||||
|
#. The phrase "Read the Docs" is not translated
|
||||||
|
#: sphinx_rtd_theme/versions.html:24
|
||||||
|
msgid "On Read the Docs"
|
||||||
|
msgstr "Op Read the Docs"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:26
|
||||||
|
msgid "Project Home"
|
||||||
|
msgstr "Project Home"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:29
|
||||||
|
msgid "Builds"
|
||||||
|
msgstr "Bouwsels"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:33
|
||||||
|
msgid "Free document hosting provided by"
|
||||||
|
msgstr "Gratis hosting voor documentatie verzorgd door"
|
||||||
|
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,148 @@
|
||||||
|
# Russian translations for sphinx_rtd_theme.
|
||||||
|
# Copyright (C) 2019 Read the Docs, Inc
|
||||||
|
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||||
|
# project.
|
||||||
|
msgid ""
|
||||||
|
msgstr ""
|
||||||
|
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||||
|
"Report-Msgid-Bugs-To: support@readthedocs.org\n"
|
||||||
|
"POT-Creation-Date: 2019-07-24 23:51-0600\n"
|
||||||
|
"PO-Revision-Date: 2019-07-16 21:44+0000\n"
|
||||||
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
|
"Language: ru\n"
|
||||||
|
"Language-Team: Russian "
|
||||||
|
"(https://www.transifex.com/readthedocs/teams/101354/ru/)\n"
|
||||||
|
"Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && "
|
||||||
|
"n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) "
|
||||||
|
"|| (n%100>=11 && n%100<=14)? 2 : 3)\n"
|
||||||
|
"MIME-Version: 1.0\n"
|
||||||
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
|
"Generated-By: Babel 2.7.0\n"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:31
|
||||||
|
msgid "Docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:43 sphinx_rtd_theme/breadcrumbs.html:45
|
||||||
|
msgid "Edit on GitHub"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:50 sphinx_rtd_theme/breadcrumbs.html:52
|
||||||
|
msgid "Edit on Bitbucket"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:57 sphinx_rtd_theme/breadcrumbs.html:59
|
||||||
|
msgid "Edit on GitLab"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:62 sphinx_rtd_theme/breadcrumbs.html:64
|
||||||
|
msgid "View page source"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:74 sphinx_rtd_theme/footer.html:5
|
||||||
|
msgid "Next"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:77 sphinx_rtd_theme/footer.html:8
|
||||||
|
msgid "Previous"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:21 sphinx_rtd_theme/footer.html:24
|
||||||
|
#: sphinx_rtd_theme/layout.html:92
|
||||||
|
msgid "Copyright"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. Build is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/footer.html:31
|
||||||
|
msgid "Build"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:36
|
||||||
|
msgid "Revision"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:40
|
||||||
|
#, python-format
|
||||||
|
msgid "Last updated on %(last_updated)s."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "Built with %(sphinx_web)s using a"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
msgid "theme"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "provided by %(readthedocs_web)s"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:61
|
||||||
|
#, python-format
|
||||||
|
msgid "Search within %(docstitle)s"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:83
|
||||||
|
msgid "About these documents"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:86
|
||||||
|
msgid "Index"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:89 sphinx_rtd_theme/search.html:11
|
||||||
|
msgid "Search"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:124
|
||||||
|
msgid "Logo"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:26
|
||||||
|
msgid "Please activate JavaScript to enable the search functionality."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. Search is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/search.html:34
|
||||||
|
msgid "Search Results"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:36
|
||||||
|
msgid ""
|
||||||
|
"Your search did not match any documents. Please make sure that all words "
|
||||||
|
"are spelled correctly and that you've selected enough categories."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/searchbox.html:4
|
||||||
|
msgid "Search docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:11
|
||||||
|
msgid "Versions"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:17
|
||||||
|
msgid "Downloads"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. The phrase "Read the Docs" is not translated
|
||||||
|
#: sphinx_rtd_theme/versions.html:24
|
||||||
|
msgid "On Read the Docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:26
|
||||||
|
msgid "Project Home"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:29
|
||||||
|
msgid "Builds"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:33
|
||||||
|
msgid "Free document hosting provided by"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
|
@ -0,0 +1,146 @@
|
||||||
|
# Translations template for sphinx_rtd_theme.
|
||||||
|
# Copyright (C) 2019 ORGANIZATION
|
||||||
|
# This file is distributed under the same license as the sphinx_rtd_theme
|
||||||
|
# project.
|
||||||
|
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
|
||||||
|
#
|
||||||
|
#, fuzzy
|
||||||
|
msgid ""
|
||||||
|
msgstr ""
|
||||||
|
"Project-Id-Version: sphinx_rtd_theme 0.4.3.dev0\n"
|
||||||
|
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
|
||||||
|
"POT-Creation-Date: 2019-07-24 23:51-0600\n"
|
||||||
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||||
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||||
|
"MIME-Version: 1.0\n"
|
||||||
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
|
"Generated-By: Babel 2.7.0\n"
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:31
|
||||||
|
msgid "Docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:43 sphinx_rtd_theme/breadcrumbs.html:45
|
||||||
|
msgid "Edit on GitHub"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:50 sphinx_rtd_theme/breadcrumbs.html:52
|
||||||
|
msgid "Edit on Bitbucket"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:57 sphinx_rtd_theme/breadcrumbs.html:59
|
||||||
|
msgid "Edit on GitLab"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:62 sphinx_rtd_theme/breadcrumbs.html:64
|
||||||
|
msgid "View page source"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:74 sphinx_rtd_theme/footer.html:5
|
||||||
|
msgid "Next"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/breadcrumbs.html:77 sphinx_rtd_theme/footer.html:8
|
||||||
|
msgid "Previous"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:21 sphinx_rtd_theme/footer.html:24
|
||||||
|
#: sphinx_rtd_theme/layout.html:92
|
||||||
|
msgid "Copyright"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. Build is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/footer.html:31
|
||||||
|
msgid "Build"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:36
|
||||||
|
msgid "Revision"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:40
|
||||||
|
#, python-format
|
||||||
|
msgid "Last updated on %(last_updated)s."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "Built with %(sphinx_web)s using a"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
msgid "theme"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/footer.html:50
|
||||||
|
#, python-format
|
||||||
|
msgid "provided by %(readthedocs_web)s"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:61
|
||||||
|
#, python-format
|
||||||
|
msgid "Search within %(docstitle)s"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:83
|
||||||
|
msgid "About these documents"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:86
|
||||||
|
msgid "Index"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:89 sphinx_rtd_theme/search.html:11
|
||||||
|
msgid "Search"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/layout.html:124
|
||||||
|
msgid "Logo"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:26
|
||||||
|
msgid "Please activate JavaScript to enable the search functionality."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. Search is a noun, not a verb
|
||||||
|
#: sphinx_rtd_theme/search.html:34
|
||||||
|
msgid "Search Results"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/search.html:36
|
||||||
|
msgid ""
|
||||||
|
"Your search did not match any documents. Please make sure that all words "
|
||||||
|
"are spelled correctly and that you've selected enough categories."
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/searchbox.html:4
|
||||||
|
msgid "Search docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:11
|
||||||
|
msgid "Versions"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:17
|
||||||
|
msgid "Downloads"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#. The phrase "Read the Docs" is not translated
|
||||||
|
#: sphinx_rtd_theme/versions.html:24
|
||||||
|
msgid "On Read the Docs"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:26
|
||||||
|
msgid "Project Home"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:29
|
||||||
|
msgid "Builds"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
#: sphinx_rtd_theme/versions.html:33
|
||||||
|
msgid "Free document hosting provided by"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
{#
|
||||||
|
basic/search.html
|
||||||
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Template for the search page.
|
||||||
|
|
||||||
|
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
|
||||||
|
:license: BSD, see LICENSE for details.
|
||||||
|
#}
|
||||||
|
{%- extends "layout.html" %}
|
||||||
|
{% set title = _('Search') %}
|
||||||
|
{%- block scripts %}
|
||||||
|
{{ super() }}
|
||||||
|
<script type="text/javascript" src="{{ pathto('_static/searchtools.js', 1) }}"></script>
|
||||||
|
{%- endblock %}
|
||||||
|
{% block footer %}
|
||||||
|
<script type="text/javascript">
|
||||||
|
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
|
||||||
|
</script>
|
||||||
|
{# this is used when loading the search index using $.ajax fails,
|
||||||
|
such as on Chrome for documents on localhost #}
|
||||||
|
<script type="text/javascript" id="searchindexloader"></script>
|
||||||
|
{{ super() }}
|
||||||
|
{% endblock %}
|
||||||
|
{% block body %}
|
||||||
|
<noscript>
|
||||||
|
<div id="fallback" class="admonition warning">
|
||||||
|
<p class="last">
|
||||||
|
{% trans trimmed %}Please activate JavaScript to enable the search
|
||||||
|
functionality.{% endtrans %}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</noscript>
|
||||||
|
|
||||||
|
{% if search_performed %}
|
||||||
|
{# Translators: Search is a noun, not a verb #}
|
||||||
|
<h2>{{ _('Search Results') }}</h2>
|
||||||
|
{% if not search_results %}
|
||||||
|
<p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
<div id="search-results">
|
||||||
|
{% if search_results %}
|
||||||
|
<ul>
|
||||||
|
{% for href, caption, context in search_results %}
|
||||||
|
<li>
|
||||||
|
<a href="{{ pathto(item.href) }}">{{ caption }}</a>
|
||||||
|
<p class="context">{{ context|e }}</p>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
|
|
@ -0,0 +1,9 @@
|
||||||
|
{%- if builder != 'singlehtml' %}
|
||||||
|
<div role="search">
|
||||||
|
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
|
||||||
|
<input type="text" name="q" placeholder="{{ _('Search docs') }}" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
{%- endif %}
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
After Width: | Height: | Size: 434 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1 @@
|
||||||
|
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}t.length>0&&($(".wy-menu-vertical .current").removeClass("current"),t.addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l1").parent().addClass("current"),t.closest("li.toctree-l1").addClass("current"),t.closest("li.toctree-l2").addClass("current"),t.closest("li.toctree-l3").addClass("current"),t.closest("li.toctree-l4").addClass("current"),t[0].scrollIntoView())}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t<e.length&&!window.requestAnimationFrame;++t)window.requestAnimationFrame=window[e[t]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[t]+"CancelAnimationFrame"]||window[e[t]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,t){var i=(new Date).getTime(),o=Math.max(0,16-(i-n)),r=window.setTimeout((function(){e(i+o)}),o);return n=i+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()}).call(window)},function(n,e){n.exports=jQuery},function(n,e,t){}]);
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
[theme]
|
||||||
|
inherit = basic
|
||||||
|
stylesheet = css/theme.css
|
||||||
|
pygments_style = default
|
||||||
|
|
||||||
|
[options]
|
||||||
|
canonical_url =
|
||||||
|
analytics_id =
|
||||||
|
collapse_navigation = True
|
||||||
|
sticky_navigation = True
|
||||||
|
navigation_depth = 4
|
||||||
|
includehidden = True
|
||||||
|
titles_only =
|
||||||
|
logo_only =
|
||||||
|
display_version = True
|
||||||
|
prev_next_buttons_location = bottom
|
||||||
|
style_external_links = False
|
||||||
|
style_nav_header_background =
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
{% if READTHEDOCS %}
|
||||||
|
{# Add rst-badge after rst-versions for small badge style. #}
|
||||||
|
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
|
||||||
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||||
|
<span class="fa fa-book"> Read the Docs</span>
|
||||||
|
v: {{ current_version }}
|
||||||
|
<span class="fa fa-caret-down"></span>
|
||||||
|
</span>
|
||||||
|
<div class="rst-other-versions">
|
||||||
|
<dl>
|
||||||
|
<dt>{{ _('Versions') }}</dt>
|
||||||
|
{% for slug, url in versions %}
|
||||||
|
<dd><a href="{{ url }}">{{ slug }}</a></dd>
|
||||||
|
{% endfor %}
|
||||||
|
</dl>
|
||||||
|
<dl>
|
||||||
|
<dt>{{ _('Downloads') }}</dt>
|
||||||
|
{% for type, url in downloads %}
|
||||||
|
<dd><a href="{{ url }}">{{ type }}</a></dd>
|
||||||
|
{% endfor %}
|
||||||
|
</dl>
|
||||||
|
<dl>
|
||||||
|
{# Translators: The phrase "Read the Docs" is not translated #}
|
||||||
|
<dt>{{ _('On Read the Docs') }}</dt>
|
||||||
|
<dd>
|
||||||
|
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
|
||||||
|
</dd>
|
||||||
|
<dd>
|
||||||
|
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
|
||||||
|
</dd>
|
||||||
|
</dl>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
asd
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
************
|
||||||
|
Accesss
|
||||||
|
************
|
||||||
|
|
||||||
|
On completion, you can access your nagios instance at:
|
||||||
|
|
||||||
|
https://yourdomain.com/nagios
|
||||||
|
|
||||||
|
|
||||||
|
Default User and Password
|
||||||
|
=========================
|
||||||
|
|
||||||
|
The default user name is::
|
||||||
|
|
||||||
|
nagiosmin
|
||||||
|
|
||||||
|
A unique password for HTTP access is created and saved to::
|
||||||
|
|
||||||
|
/etc/webmin/nagios/aut.txt
|
||||||
|
|
||||||
|
Example contents for auth.txt are as below::
|
||||||
|
|
||||||
|
nagiosmin http pass:sTpoL-dBhQ
|
||||||
|
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
For security purposes, you change the default admin name as well as the nagios url.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,218 @@
|
||||||
|
*********
|
||||||
|
Changelog
|
||||||
|
*********
|
||||||
|
|
||||||
|
master
|
||||||
|
======
|
||||||
|
|
||||||
|
New Features
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Fix definition lists looking different with Sphinx 2.0+
|
||||||
|
|
||||||
|
Other Changes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
* Add the ``navigation`` template block around the navigation area.
|
||||||
|
* Added Spanish translation
|
||||||
|
* Added i18n support using Babel
|
||||||
|
* Moved build system from Grunt and friends to Webpack
|
||||||
|
* Remove Modernizr, but keep html5shiv (#724, #525)
|
||||||
|
|
||||||
|
0.4.3
|
||||||
|
======
|
||||||
|
|
||||||
|
:Date: Feb 12, 2019
|
||||||
|
|
||||||
|
New Features
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Fix scrolling to active item in sidebar on load (#214)
|
||||||
|
* Style caption link for code and literal blocks
|
||||||
|
* Fix inconsistent font size and line height for autodoc "raises" and "returns" (#267)
|
||||||
|
* Fix last_updated notice appearing in same line as copyright notice (#704)
|
||||||
|
|
||||||
|
|
||||||
|
Other Changes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
v0.4.2
|
||||||
|
======
|
||||||
|
|
||||||
|
:Date: Oct 5, 2018
|
||||||
|
|
||||||
|
New Features
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Set base font size on <html> (#668)
|
||||||
|
* Fix HTML search not working with Sphinx-1.8 (#672)
|
||||||
|
|
||||||
|
Other Changes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
* Upload signed packages to PyPI with twine (#651)
|
||||||
|
* Do not enforce period at the end of copyright statement (666)
|
||||||
|
|
||||||
|
v0.4.1
|
||||||
|
======
|
||||||
|
|
||||||
|
:Date: July 27, 2018
|
||||||
|
|
||||||
|
New Features
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Line height adjustments for Liberation Mono (#656)
|
||||||
|
|
||||||
|
Other Changes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
* Add Sphinx as a dependency
|
||||||
|
|
||||||
|
v0.4.0
|
||||||
|
======
|
||||||
|
|
||||||
|
This version made some changes to how JS and CSS were included
|
||||||
|
when the theme is used on Read the Docs.
|
||||||
|
|
||||||
|
|
||||||
|
New Features
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Do not rely on readthedocs.org for CSS/JS (#614)
|
||||||
|
* Color accessibility improvements on the left navigation
|
||||||
|
|
||||||
|
Other Changes
|
||||||
|
---------------
|
||||||
|
|
||||||
|
* Write theme version and build date at top of JavaScript and CSS
|
||||||
|
* Changed code and literals to use a native font stack (#612)
|
||||||
|
* Fix small styling issues
|
||||||
|
|
||||||
|
v0.3.1
|
||||||
|
======
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Revert part of #576 causing display issues with version selector menu
|
||||||
|
* Backwards compatibility fixes for pre-0.3.0 releases (#623)
|
||||||
|
* Fix mkdocs version selector (#622)
|
||||||
|
* Add open list spacing (#591)
|
||||||
|
* Fix table centering (#599)
|
||||||
|
|
||||||
|
v0.3.0
|
||||||
|
======
|
||||||
|
|
||||||
|
**Note**: this version resulted in some JavaScript incompatibilities when used on readthedocs.org
|
||||||
|
|
||||||
|
New Features
|
||||||
|
-------------
|
||||||
|
|
||||||
|
* Add html language attribute
|
||||||
|
* Allow setting 'rel' and 'title' attributes for stylesheets (#551)
|
||||||
|
* Add option to style external links
|
||||||
|
* Add github, gitlab, bitbucket page arguments option
|
||||||
|
* Add pygments support
|
||||||
|
* Add setuptools entry point allowing to use ``sphinx_rtd_theme`` as
|
||||||
|
Sphinx ``html_theme`` directly.
|
||||||
|
* Add language to the JS output variable
|
||||||
|
|
||||||
|
Fixes
|
||||||
|
-----
|
||||||
|
|
||||||
|
* Fix some HTML warnings and errors
|
||||||
|
* Fix many styling issues
|
||||||
|
* Fix many sidebar glitches
|
||||||
|
* Fix line number spacing to align with the code lines
|
||||||
|
* Hide Edit links on auto created pages
|
||||||
|
* Include missing font files with the theme
|
||||||
|
|
||||||
|
Other Changes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
* Significant improvement of our documentation
|
||||||
|
* Compress our Javascript files
|
||||||
|
* Updated dependencies
|
||||||
|
|
||||||
|
v0.2.4
|
||||||
|
======
|
||||||
|
|
||||||
|
* Yet another patch to deal with extra builders outside Spinx, such as the
|
||||||
|
singlehtml builders from the Read the Docs Sphinx extension
|
||||||
|
|
||||||
|
v0.2.3
|
||||||
|
======
|
||||||
|
|
||||||
|
* Temporarily patch Sphinx issue with ``singlehtml`` builder by inspecting the
|
||||||
|
builder in template.
|
||||||
|
|
||||||
|
v0.2.2
|
||||||
|
======
|
||||||
|
|
||||||
|
* Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and
|
||||||
|
introduced another bug with toctrees display.
|
||||||
|
|
||||||
|
v0.2.1
|
||||||
|
======
|
||||||
|
|
||||||
|
* Add the ``rel`` HTML attribute to the footer links which point to
|
||||||
|
the previous and next pages.
|
||||||
|
* Fix toctree issue caused by Sphinx singlehtml builder (#367)
|
||||||
|
|
||||||
|
v0.2.0
|
||||||
|
======
|
||||||
|
|
||||||
|
* Adds the ``comments`` block after the ``body`` block in the template
|
||||||
|
* Added "Edit on GitLab" support
|
||||||
|
* Many bug fixes
|
||||||
|
|
||||||
|
v0.1.10-alpha
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. note:: This is a pre-release version
|
||||||
|
|
||||||
|
* Removes Sphinx dependency
|
||||||
|
* Fixes hamburger on mobile display
|
||||||
|
* Adds a ``body_begin`` block to the template
|
||||||
|
* Added ``prev_next_buttons_location``
|
||||||
|
|
||||||
|
v0.1.9
|
||||||
|
======
|
||||||
|
|
||||||
|
* Intermittent scrollbar visibility bug fixed. This change introduces a
|
||||||
|
backwards incompatible change to the theme's layout HTML. This should only be
|
||||||
|
a problem for derivative themes that have overridden styling of nav elements
|
||||||
|
using direct descendant selectors. See `#215`_ for more information.
|
||||||
|
* Safari overscroll bug fixed
|
||||||
|
* Version added to the nav header
|
||||||
|
* Revision id was added to the documentation footer if you are using RTD
|
||||||
|
* An extra block, ``extrafooter`` was added to allow extra content in the
|
||||||
|
document footer block
|
||||||
|
* Fixed modernizr URL
|
||||||
|
* Small display style changes on code blocks, figure captions, and nav elements
|
||||||
|
|
||||||
|
.. _#215: https://github.com/rtfd/sphinx_rtd_theme/pull/215
|
||||||
|
|
||||||
|
v0.1.8
|
||||||
|
======
|
||||||
|
|
||||||
|
* Start keeping changelog :)
|
||||||
|
* Support for third and fourth level headers in the sidebar
|
||||||
|
* Add support for Sphinx 1.3
|
||||||
|
* Add sidebar headers for :caption: in Sphinx toctree
|
||||||
|
* Clean up sidebar scrolling behavior so it never scrolls out of view
|
||||||
|
|
@ -0,0 +1,172 @@
|
||||||
|
.. This is a comment. Note how any initial comments are moved by
|
||||||
|
transforms to after the document title, subtitle, and docinfo.
|
||||||
|
|
||||||
|
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
||||||
|
|
||||||
|
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
|
||||||
|
:width: 1em
|
||||||
|
|
||||||
|
**********************
|
||||||
|
Nrpe Agent
|
||||||
|
**********************
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
Overview
|
||||||
|
==================
|
||||||
|
|
||||||
|
Nrpe is used for monitoring remote hosts.
|
||||||
|
|
||||||
|
To install the nrpe client on a remote host, you can use the nrpe.sh file in /script directory.
|
||||||
|
|
||||||
|
The script content is below:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
#!/bin/bash
|
||||||
|
#Info: This script installs a NRPE client, following [1]
|
||||||
|
#[1] https://support.nagios.com/kb/article.php?id=515
|
||||||
|
|
||||||
|
#Nagious server, that will monitor this client node
|
||||||
|
NAGIOS_MON_HOST='1.2.3.4'
|
||||||
|
NAGIOS_HOME='/usr/local/nagios/'
|
||||||
|
|
||||||
|
function detect_distro(){
|
||||||
|
if [ -f /etc/centos-release ]; then
|
||||||
|
DISTRO='centos'
|
||||||
|
DISTRO_VER=$(grep VERSION_ID /etc/os-release | tr -d '"' | cut -f2 -d= | cut -f1 -d.)
|
||||||
|
|
||||||
|
#opensuse,debian,slackware, ubuntu
|
||||||
|
elif [ -f /etc/os-release ]; then
|
||||||
|
DISTRO=$(grep -m 1 ID /etc/os-release | cut -f2 -d= | tr -d '"')
|
||||||
|
DISTRO_VER=$(grep VERSION_ID /etc/os-release | tr -d '"' | cut -f2 -d= | cut -f1 -d.)
|
||||||
|
else
|
||||||
|
echo "Error: Failed to detect distribution"; exit 1;
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_deps(){
|
||||||
|
if [ ${DISTRO} == 'centos' ]; then
|
||||||
|
yum install -y gcc glibc glibc-common openssl openssl-devel perl wget
|
||||||
|
elif [ ${DISTRO} == 'ubuntu' ]; then
|
||||||
|
export DEBIAN_FRONTEND=noninteractive
|
||||||
|
if [ ${DISTRO_VER} -eq 18 ]; then
|
||||||
|
apt-add-repository universe
|
||||||
|
fi
|
||||||
|
apt-get install -y autoconf automake gcc libc6 libmcrypt-dev make libssl-dev wget openssl make
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_nrpe(){
|
||||||
|
NRPE_VER='3.2.1'
|
||||||
|
|
||||||
|
if [ $(grep -m 1 -c '^nagios:' /etc/passwd) -eq 0 ]; then
|
||||||
|
useradd -s /bin/false nagios
|
||||||
|
fi
|
||||||
|
|
||||||
|
pushd ${HOME}
|
||||||
|
if [ ! -f nrpe-${NRPE_VER}.tar.gz ]; then
|
||||||
|
wget --no-check-certificate https://github.com/NagiosEnterprises/nrpe/archive/nrpe-${NRPE_VER}.tar.gz
|
||||||
|
fi
|
||||||
|
|
||||||
|
tar xzf nrpe-${NRPE_VER}.tar.gz
|
||||||
|
rm -f nrpe-${NRPE_VER}.tar.gz
|
||||||
|
|
||||||
|
pushd nrpe-nrpe-${NRPE_VER}/
|
||||||
|
|
||||||
|
if [ $(which systemctl 2>/dev/null | grep -c yum) -eq 1 ]; then
|
||||||
|
./configure --enable-command-args --with-init-type=systemd
|
||||||
|
else
|
||||||
|
./configure --enable-command-args
|
||||||
|
fi
|
||||||
|
|
||||||
|
make all install install-groups-users install-plugin install-config install-init
|
||||||
|
popd
|
||||||
|
rm -f nrpe-nrpe-${NRPE_VER}/
|
||||||
|
popd
|
||||||
|
}
|
||||||
|
|
||||||
|
function config_nrpe(){
|
||||||
|
sed -i "/^allowed_hosts=/s/\$/,${NAGIOS_MON_HOST}/" ${NAGIOS_HOME}/etc/nrpe.cfg
|
||||||
|
sed -i 's/^dont_blame_nrpe=.*/dont_blame_nrpe=1/g' ${NAGIOS_HOME}/etc/nrpe.cfg
|
||||||
|
|
||||||
|
#Standard command found in source/package plugins
|
||||||
|
cat >> ${NAGIOS_HOME}/etc/nrpe.cfg <<CMD_EOF
|
||||||
|
command[check_disk_root]=${CUSTOM_PLUGINS_HOME}/check_disk -w 30% -c 10% -p /
|
||||||
|
CMD_EOF
|
||||||
|
|
||||||
|
cat >> ${NAGIOS_HOME}/etc/nrpe.cfg <<CMD_EOF
|
||||||
|
command[check_linuxdiskspace]=${CUSTOM_PLUGINS_HOME}/check_linuxdiskspace
|
||||||
|
CMD_EOF
|
||||||
|
|
||||||
|
#Linux S.M.A.R.T Checks
|
||||||
|
#NOTE: we may have /dev/vda1 for virtual disk
|
||||||
|
for sd in $(find /dev -type b -name 'sd[a-z][0-9]' | cut -f3 -d/); do
|
||||||
|
echo "command[check_linux_smart_${sd}]=${CUSTOM_PLUGINS_HOME}/check_ide_smart -d /dev/${sd}" >> ${NAGIOS_HOME}/etc/nrpe.cfg
|
||||||
|
done
|
||||||
|
|
||||||
|
|
||||||
|
if [ $(which systemctl 2>/dev/null | grep -c systemctl) -eq 1 ]; then
|
||||||
|
systemctl enable nrpe.service
|
||||||
|
systemctl start nrpe
|
||||||
|
else
|
||||||
|
chkconfig --set nrpe on
|
||||||
|
service nrpe start
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_plugins_source(){
|
||||||
|
PLUG_VER='2.3.1'
|
||||||
|
|
||||||
|
if [ ${DISTRO} == 'centos' ]; then
|
||||||
|
yum install -y gcc glibc glibc-common make gettext automake autoconf wget openssl-devel net-snmp net-snmp-utils epel-release perl-Net-SNMP
|
||||||
|
elif [ ${DISTRO} == 'ubuntu' ]; then
|
||||||
|
apt-get install -y autoconf gcc libc6 libmcrypt-dev make libssl-dev wget bc gawk dc build-essential snmp libnet-snmp-perl gettext
|
||||||
|
fi
|
||||||
|
|
||||||
|
pushd ${HOME}
|
||||||
|
wget --no-check-certificate https://github.com/nagios-plugins/nagios-plugins/archive/release-${PLUG_VER}.tar.gz
|
||||||
|
tar xzf release-${PLUG_VER}.tar.gz
|
||||||
|
rm -f release-${PLUG_VER}.tar.gz
|
||||||
|
|
||||||
|
pushd nagios-plugins-release-${PLUG_VER}/
|
||||||
|
./tools/setup
|
||||||
|
./configure
|
||||||
|
make
|
||||||
|
make install
|
||||||
|
popd
|
||||||
|
rm -rf nagios-plugins-release-${PLUG_VER}/
|
||||||
|
popd
|
||||||
|
|
||||||
|
NAGIOS_PLUGINS_HOME='/usr/local/nagios/libexec/'
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function install_plugins(){
|
||||||
|
install_plugins_source
|
||||||
|
}
|
||||||
|
|
||||||
|
function test_nrpe(){
|
||||||
|
if [ ! -f ${NAGIOS_HOME}/etc/nrpe.cfg ]; then
|
||||||
|
echo 'Error: nrpe.cfg is missing!'
|
||||||
|
fi
|
||||||
|
|
||||||
|
OUT=$(${NAGIOS_HOME}/libexec/check_nrpe -H 127.0.0.1)
|
||||||
|
if [ "${OUT}" == "NRPE v${NRPE_VER}" ]; then
|
||||||
|
echo "NRPE Test OK"
|
||||||
|
else
|
||||||
|
echo "NRPE Test FAILED"
|
||||||
|
exit 1;
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
detect_distro;
|
||||||
|
install_deps;
|
||||||
|
install_nrpe;
|
||||||
|
install_plugins;
|
||||||
|
config_nrpe;
|
||||||
|
|
||||||
|
test_nrpe;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,99 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
|
if not 'READTHEDOCS' in os.environ:
|
||||||
|
sys.path.insert(0, os.path.abspath('..'))
|
||||||
|
sys.path.append(os.path.abspath('./demo/'))
|
||||||
|
|
||||||
|
from sphinx.locale import _
|
||||||
|
from sphinx_rtd_theme import __version__
|
||||||
|
|
||||||
|
|
||||||
|
project = u'Nagios Webmin Module'
|
||||||
|
copyright = u'2020 Cited Inc.'
|
||||||
|
slug = re.sub(r'\W+', '-', project.lower())
|
||||||
|
version = __version__
|
||||||
|
release = __version__
|
||||||
|
author = u'Cited, Inc'
|
||||||
|
copyright = author
|
||||||
|
language = 'en'
|
||||||
|
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.intersphinx',
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.mathjax',
|
||||||
|
'sphinx.ext.viewcode',
|
||||||
|
'sphinxcontrib.httpdomain',
|
||||||
|
'sphinx_rtd_theme',
|
||||||
|
]
|
||||||
|
|
||||||
|
templates_path = ['_templates']
|
||||||
|
source_suffix = '.rst'
|
||||||
|
exclude_patterns = []
|
||||||
|
locale_dirs = ['locale/']
|
||||||
|
gettext_compact = False
|
||||||
|
|
||||||
|
master_doc = 'index'
|
||||||
|
suppress_warnings = ['image.nonlocal_uri']
|
||||||
|
pygments_style = 'default'
|
||||||
|
|
||||||
|
intersphinx_mapping = {
|
||||||
|
'rtd': ('https://docs.readthedocs.io/en/latest/', None),
|
||||||
|
'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
|
||||||
|
}
|
||||||
|
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
|
html_theme_options = {
|
||||||
|
'logo_only': False,
|
||||||
|
'display_version': True
|
||||||
|
}
|
||||||
|
html_theme_path = ["_themes", ]
|
||||||
|
#html_logo = "_static/geohelm-logo-small.png"
|
||||||
|
html_show_sourcelink = True
|
||||||
|
|
||||||
|
htmlhelp_basename = slug
|
||||||
|
|
||||||
|
latex_documents = [
|
||||||
|
('index', '{0}.tex'.format(slug), project, author, 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
man_pages = [
|
||||||
|
('index', slug, project, [author], 1)
|
||||||
|
]
|
||||||
|
|
||||||
|
texinfo_documents = [
|
||||||
|
('index', slug, project, author, slug, project, 'Miscellaneous'),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# Extensions to theme docs
|
||||||
|
def setup(app):
|
||||||
|
from sphinx.domains.python import PyField
|
||||||
|
from sphinx.util.docfields import Field
|
||||||
|
|
||||||
|
app.add_object_type(
|
||||||
|
'confval',
|
||||||
|
'confval',
|
||||||
|
objname='configuration value',
|
||||||
|
indextemplate='pair: %s; configuration value',
|
||||||
|
doc_field_types=[
|
||||||
|
PyField(
|
||||||
|
'type',
|
||||||
|
label=_('Type'),
|
||||||
|
has_arg=False,
|
||||||
|
names=('type',),
|
||||||
|
bodyrolename='class'
|
||||||
|
),
|
||||||
|
Field(
|
||||||
|
'default',
|
||||||
|
label=_('Default'),
|
||||||
|
has_arg=False,
|
||||||
|
names=('default',),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,224 @@
|
||||||
|
*************
|
||||||
|
Configuration
|
||||||
|
*************
|
||||||
|
|
||||||
|
Theme options
|
||||||
|
=============
|
||||||
|
|
||||||
|
The following options can be defined in your project's ``conf.py`` file, using
|
||||||
|
the :confval:`html_theme_options <sphinx:html_theme_options>` configuration option.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
.. code:: python
|
||||||
|
|
||||||
|
html_theme_options = {
|
||||||
|
'canonical_url': '',
|
||||||
|
'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
|
||||||
|
'logo_only': False,
|
||||||
|
'display_version': True,
|
||||||
|
'prev_next_buttons_location': 'bottom',
|
||||||
|
'style_external_links': False,
|
||||||
|
'vcs_pageview_mode': '',
|
||||||
|
'style_nav_header_background': 'white',
|
||||||
|
# Toc options
|
||||||
|
'collapse_navigation': True,
|
||||||
|
'sticky_navigation': True,
|
||||||
|
'navigation_depth': 4,
|
||||||
|
'includehidden': True,
|
||||||
|
'titles_only': False
|
||||||
|
}
|
||||||
|
|
||||||
|
Table of contents options
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
The following options change how :rst:dir:`sphinx:toctree` directives generate
|
||||||
|
documentation navigation.
|
||||||
|
|
||||||
|
.. confval:: collapse_navigation
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: ``True``
|
||||||
|
|
||||||
|
With this enabled, navigation entries are not expandable -- the ``[+]``
|
||||||
|
icons next to each entry are removed.
|
||||||
|
|
||||||
|
.. confval:: sticky_navigation
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: ``True``
|
||||||
|
|
||||||
|
Scroll the navigation with the main page content as you scroll the page.
|
||||||
|
|
||||||
|
.. confval:: navigation_depth
|
||||||
|
|
||||||
|
:type: integer
|
||||||
|
:default: ``4``
|
||||||
|
|
||||||
|
The maximum depth of the table of contents tree. Set
|
||||||
|
this to ``-1`` to allow unlimited depth.
|
||||||
|
|
||||||
|
.. confval:: includehidden
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: ``True``
|
||||||
|
|
||||||
|
Specifies if the navigation includes hidden table(s) of contents -- that is,
|
||||||
|
any :rst:dir:`sphinx:toctree` directive that is marked with the ``:hidden:``
|
||||||
|
option.
|
||||||
|
|
||||||
|
.. confval:: titles_only
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: False
|
||||||
|
|
||||||
|
When enabled, page subheadings are not included in the
|
||||||
|
navigation.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Setting :confval:`collapse_navigation` to ``False`` and using a high value
|
||||||
|
for :confval:`navigation_depth` on projects with many files and a deep file
|
||||||
|
structure can cause long compilation times and can result in HTML files that
|
||||||
|
are significantly larger in file size.
|
||||||
|
|
||||||
|
.. _table of contents configuration options: http://www.sphinx-doc.org/en/stable/templating.html#toctree
|
||||||
|
|
||||||
|
|
||||||
|
..
|
||||||
|
TODO
|
||||||
|
.
|
||||||
|
HTML context options
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
||||||
|
Miscellaneous options
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. confval:: analytics_id
|
||||||
|
|
||||||
|
:type: string
|
||||||
|
|
||||||
|
If specified, Google Analytics' javascript is included in your pages.
|
||||||
|
Set the value to the ID provided to you by google (like ``UA-XXXXXXX``).
|
||||||
|
|
||||||
|
.. confval:: canonical_url
|
||||||
|
|
||||||
|
:type: URL
|
||||||
|
|
||||||
|
This will specify a `canonical URL`_ meta link element to tell search
|
||||||
|
engines which URL should be ranked as the primary URL for your
|
||||||
|
documentation. This is important if you have multiple URLs that your
|
||||||
|
documentation is available through. The URL points to the root path of the
|
||||||
|
documentation and requires a trailing slash.
|
||||||
|
|
||||||
|
.. confval:: display_version
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: ``True``
|
||||||
|
|
||||||
|
If ``True``, the version number is shown at the top of the sidebar.
|
||||||
|
|
||||||
|
.. confval:: logo_only
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: ``False``
|
||||||
|
|
||||||
|
Only display the logo image, do not display the project name at the top of
|
||||||
|
the sidebar
|
||||||
|
|
||||||
|
.. confval:: prev_next_buttons_location
|
||||||
|
|
||||||
|
:type: string
|
||||||
|
:default: ``bottom``
|
||||||
|
|
||||||
|
Location to display :guilabel:`Next` and :guilabel:`Previous` buttons. This
|
||||||
|
can be either ``bottom``, ``top``, ``both`` , or ``None``.
|
||||||
|
|
||||||
|
.. confval:: style_external_links
|
||||||
|
|
||||||
|
:type: boolean
|
||||||
|
:default: ``False``
|
||||||
|
|
||||||
|
Add an icon next to external links.
|
||||||
|
|
||||||
|
.. confval:: vcs_pageview_mode
|
||||||
|
|
||||||
|
:type: string
|
||||||
|
:default: ``blob`` or ``view``
|
||||||
|
|
||||||
|
Changes how to view files when using ``display_github``, ``display_gitlab``,
|
||||||
|
etc. When using GitHub or GitLab this can be: ``blob`` (default), ``edit``,
|
||||||
|
or ``raw``. On Bitbucket, this can be either: ``view`` (default) or
|
||||||
|
``edit``.
|
||||||
|
|
||||||
|
.. confval:: style_nav_header_background
|
||||||
|
|
||||||
|
:type: string
|
||||||
|
:default: ``#2980B9``
|
||||||
|
|
||||||
|
Changes the background of the search area in the navigation bar. The value
|
||||||
|
can be anything valid in a CSS `background` property.
|
||||||
|
|
||||||
|
.. _canonical URL: https://en.wikipedia.org/wiki/Canonical_link_element
|
||||||
|
|
||||||
|
|
||||||
|
File-wide metadata
|
||||||
|
==================
|
||||||
|
|
||||||
|
The following options can be used as :ref:`file-wide metadata
|
||||||
|
<sphinx:metadata>`:
|
||||||
|
|
||||||
|
.. confval:: github_url
|
||||||
|
|
||||||
|
Force the :guilabel:`Edit on GitHub` button to use the configured URL.
|
||||||
|
|
||||||
|
.. confval:: bitbucket_url
|
||||||
|
|
||||||
|
Force the :guilabel:`Edit on Bitbucket` button to use the configured URL.
|
||||||
|
|
||||||
|
.. confval:: gitlab_url
|
||||||
|
|
||||||
|
Force the :guilabel:`Edit on GitLab` button to use the configured URL.
|
||||||
|
|
||||||
|
|
||||||
|
Other configuration
|
||||||
|
===================
|
||||||
|
|
||||||
|
Adding a logo
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Using the Sphinx standard option :py:confval:`html_logo <sphinx:html_logo>`,
|
||||||
|
you can set an image file to be used as a logo at the top of the sidebar. The
|
||||||
|
theme option :py:confval:`logo_only` also allows for *only* the logo to be shown
|
||||||
|
at the top of the sidebar.
|
||||||
|
|
||||||
|
Adding custom CSS or Javascript
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
Adding custom CSS or Javascript can help you alter the look and feel of this
|
||||||
|
theme without forking the theme for local use.
|
||||||
|
|
||||||
|
In order to add custom CSS or Javascript without disrupting the existing theme
|
||||||
|
files, you can :doc:`add files to be included in your documentation output
|
||||||
|
<rtd:guides/adding-custom-css>`.
|
||||||
|
|
||||||
|
How the table of contents displays
|
||||||
|
==================================
|
||||||
|
|
||||||
|
Currently the left menu will build based upon any ``toctree`` directives defined
|
||||||
|
in your source files. It outputs 4 levels of depth by default, to allow for
|
||||||
|
quick navigation through topics. If no TOC trees are defined, Sphinx's default
|
||||||
|
behavior is to use the page headings instead.
|
||||||
|
|
||||||
|
It's important to note that if you don't follow the same styling for your reST
|
||||||
|
headings across your documents, the TOC tree will build incorrectly, and the
|
||||||
|
resulting menu might not show the correct depth when it renders.
|
||||||
|
|
||||||
|
Also note that by default the table of contents is set with
|
||||||
|
``includehidden=True``. This allows you to set a hidden TOC in your index file
|
||||||
|
with the :ref:`:hidden: <sphinx:toctree-directive>` property that will allow you
|
||||||
|
to build a TOC without it rendering in your index.
|
||||||
|
|
||||||
|
By default, the navigation will "stick" to the screen as you scroll. However if
|
||||||
|
your TOC is not tall enough, it will revert to static positioning. To disable the
|
||||||
|
sticky navigation altogether, change the :confval:`sticky_navigation` theme option.
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<<<<<<< HEAD
|
||||||
|
sda
|
||||||
|
=======
|
||||||
|
1
|
||||||
|
>>>>>>> 0fe13662c55108f10afe8bdaca0828b19bef44fd
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 8.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
|
|
@ -0,0 +1,59 @@
|
||||||
|
.. This is a comment. Note how any initial comments are moved by
|
||||||
|
transforms to after the document title, subtitle, and docinfo.
|
||||||
|
|
||||||
|
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
||||||
|
|
||||||
|
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
|
||||||
|
:width: 1em
|
||||||
|
|
||||||
|
***************************
|
||||||
|
Main Configuration Files
|
||||||
|
***************************
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
|
||||||
|
Editing Files
|
||||||
|
==============
|
||||||
|
|
||||||
|
To access the Main Conf file editor, click the Objects icon as show below.
|
||||||
|
|
||||||
|
.. image:: _static/nagios-main-tab.png
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
From here you can edit any existing file within the /usr/local/nagios/etc directory.
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: _static/nagios-conf-select.png
|
||||||
|
|
||||||
|
|
||||||
|
Once you have completed any edits, click the Save and Close button and restart Nagios.
|
||||||
|
|
||||||
|
|
||||||
|
Adding New File
|
||||||
|
===================
|
||||||
|
|
||||||
|
Any new file added to the directory will appear in the editor drop-downn.
|
||||||
|
|
||||||
|
|
||||||
|
Restart Nagios
|
||||||
|
=============
|
||||||
|
|
||||||
|
For the edits to register, you must restart Nagios.
|
||||||
|
|
||||||
|
This can be done via Servers > Nagios in your control panel.
|
||||||
|
|
||||||
|
It can also be done via command line using::
|
||||||
|
|
||||||
|
systemctl restart nagios.service
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Conf Location
|
||||||
|
===============
|
||||||
|
|
||||||
|
By default, all main conf files are saved to /usr/local/nagios/etc
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.9 KiB |
|
|
@ -0,0 +1,162 @@
|
||||||
|
.. This is a comment. Note how any initial comments are moved by
|
||||||
|
transforms to after the document title, subtitle, and docinfo.
|
||||||
|
|
||||||
|
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
||||||
|
|
||||||
|
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
|
||||||
|
:width: 1em
|
||||||
|
|
||||||
|
***************************
|
||||||
|
Objects Configuration Files
|
||||||
|
***************************
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
|
||||||
|
Editing Files
|
||||||
|
==============
|
||||||
|
|
||||||
|
To access the Objects file editor, click the Objects icon as show below.
|
||||||
|
|
||||||
|
.. image:: _static/nagios-obects-tab.png
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
From here you can edit any existing file within the NAGIOS/obects directory.
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: _static/nagios-obect-select.png
|
||||||
|
|
||||||
|
|
||||||
|
Once you have completed any edits, click the Save and Close button and restart Nagios.
|
||||||
|
|
||||||
|
|
||||||
|
Creating a New File
|
||||||
|
===================
|
||||||
|
|
||||||
|
You can create a new service file from a template via the editor.
|
||||||
|
|
||||||
|
Enter a new filename.cfg and click the Create button.
|
||||||
|
|
||||||
|
Give your file a name that will make it easy to identify, such as myconf.cfg
|
||||||
|
|
||||||
|
.. image:: _static/nagios-new-cfg.png
|
||||||
|
|
||||||
|
|
||||||
|
Click the Create button.
|
||||||
|
|
||||||
|
The Create button will load the template below.
|
||||||
|
|
||||||
|
.. image:: _static/nagios-obect-select-new.png
|
||||||
|
|
||||||
|
The template is commented.
|
||||||
|
|
||||||
|
1. Replace all instances of <HOST> with the host you have added.
|
||||||
|
|
||||||
|
2. Replace <IP> with the host IP
|
||||||
|
|
||||||
|
3. Click Save and Close
|
||||||
|
|
||||||
|
4. Restart Nagios for the new cfg to register
|
||||||
|
|
||||||
|
|
||||||
|
Template File
|
||||||
|
==============
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
# Host configuration file
|
||||||
|
|
||||||
|
define host {
|
||||||
|
use linux-server
|
||||||
|
host_name <HOST>
|
||||||
|
alias <HOST>
|
||||||
|
address <IP>
|
||||||
|
register 1
|
||||||
|
}
|
||||||
|
|
||||||
|
define service {
|
||||||
|
host_name <HOST>
|
||||||
|
service_description PING
|
||||||
|
check_command check_ping!100.0,20%!500.0,60%
|
||||||
|
max_check_attempts 2
|
||||||
|
check_interval 2
|
||||||
|
retry_interval 2
|
||||||
|
check_period 24x7
|
||||||
|
check_freshness 1
|
||||||
|
contact_groups admins,slackmins
|
||||||
|
notification_interval 2
|
||||||
|
notification_period 24x7
|
||||||
|
notifications_enabled 1
|
||||||
|
register 1
|
||||||
|
}
|
||||||
|
|
||||||
|
define service {
|
||||||
|
host_name <HOST>
|
||||||
|
service_description Check SSH
|
||||||
|
check_command check_ssh!-p 3838
|
||||||
|
max_check_attempts 2
|
||||||
|
check_interval 2
|
||||||
|
retry_interval 2
|
||||||
|
check_period 24x7
|
||||||
|
check_freshness 1
|
||||||
|
contact_groups admins
|
||||||
|
notification_interval 2
|
||||||
|
notification_period 24x7
|
||||||
|
notifications_enabled 1
|
||||||
|
register 1
|
||||||
|
}
|
||||||
|
|
||||||
|
define service {
|
||||||
|
host_name <HOST>
|
||||||
|
service_description Check HTTP
|
||||||
|
check_command check_http
|
||||||
|
max_check_attempts 2
|
||||||
|
check_interval 2
|
||||||
|
retry_interval 2
|
||||||
|
check_period 24x7
|
||||||
|
check_freshness 1
|
||||||
|
contact_groups admins
|
||||||
|
notification_interval 2
|
||||||
|
notification_period 24x7
|
||||||
|
notifications_enabled 1
|
||||||
|
register 1
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
To create your own template, simply update the template.cfg located at /usr/share/webmin/nagios.
|
||||||
|
|
||||||
|
|
||||||
|
Restart Nagios
|
||||||
|
=============
|
||||||
|
|
||||||
|
For the new cfg to register, you must restart Nagios.
|
||||||
|
|
||||||
|
This can be done via Servers > Nagios in your control panel.
|
||||||
|
|
||||||
|
It can also be done via command line using::
|
||||||
|
|
||||||
|
systemctl restart nagios.service
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Edit Conf
|
||||||
|
=========
|
||||||
|
|
||||||
|
To edit a Conf File you have created, simply select the conf file from the drop down.
|
||||||
|
|
||||||
|
Make the required edits and click Save.
|
||||||
|
|
||||||
|
|
||||||
|
Conf Location
|
||||||
|
===============
|
||||||
|
|
||||||
|
By default, all conf files are saved to /usr/local/nagios/obejcts/
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
Nagios Module
|
||||||
|
==================================================
|
||||||
|
|
||||||
|
.. include:: ../README.rst
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: Getting Started
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
intro
|
||||||
|
installing
|
||||||
|
wizard
|
||||||
|
webmin
|
||||||
|
access
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
:caption: Editors
|
||||||
|
|
||||||
|
editors/nagios/nagiosconfs
|
||||||
|
editors/objects/objectconfs
|
||||||
|
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Services
|
||||||
|
|
||||||
|
services/nagios/index
|
||||||
|
services/nrpe/index
|
||||||
|
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Nrpe Agent
|
||||||
|
|
||||||
|
client/nrpe/index
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
:caption: Resources
|
||||||
|
|
||||||
|
resources/nagios
|
||||||
|
resources/support
|
||||||
|
resources/license
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
************
|
||||||
|
Installation
|
||||||
|
************
|
||||||
|
|
||||||
|
Installation can be done using the pre-installer.sh script or via GIT.
|
||||||
|
|
||||||
|
Using the Pre-Installer
|
||||||
|
=======================
|
||||||
|
|
||||||
|
On a fresh CentOS 7 or Ubuntu 18 installation, the fastest method is to use the pre-installer script:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
wget wget https://raw.githubusercontent.com/cited/nagios-webmin-module/master/scripts/pre-install.sh
|
||||||
|
chmod +x pre-install.sh
|
||||||
|
./pre-install.sh
|
||||||
|
|
||||||
|
The above will install Webmin, Apache HTTPD Server, and the Nagios module, as well as our (optional) Certbot Module for SSL.
|
||||||
|
|
||||||
|
When the script completes, you will see the message below:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
~
|
||||||
|
/opt ~
|
||||||
|
Installed Nagios Module in /usr/share/webmin/certbot (336 kb)
|
||||||
|
~
|
||||||
|
Nagios is now installed. Go to Servers > Nagios to complete installation
|
||||||
|
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Following above, you will need to log in to Webmin to complete installation using the install :ref:`wizard-label`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Via Git or Download
|
||||||
|
===================
|
||||||
|
|
||||||
|
You can use Git to build module for an existing Webmin installation:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
git clone https://github.com/cited/nagios-webmin-module/
|
||||||
|
mv nagios-webmin-module-master nagios
|
||||||
|
tar -cvzf nagios.wbm.gz nagios/
|
||||||
|
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Following above, you will need to log in to Webmin to complete installation using the install :ref:`wizard-label`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
Intro
|
||||||
|
===========================
|
||||||
|
|
||||||
|
Overview
|
||||||
|
------------
|
||||||
|
|
||||||
|
The Nagios Webmin Module that allows you to install and manage Nagios Core.
|
||||||
|
|
||||||
|
The UI panel allows you start and stop Nagios and Nrpe, as well as edit and create cfg files
|
||||||
|
|
||||||
|
The moudle has been tested on CentOS 7 and Ubuntu 18.
|
||||||
|
|
||||||
|
All installed components are non-forked and un-modified and installed via the projects archive.
|
||||||
|
|
||||||
|
.. image:: _static/nagios-main.png
|
||||||
|
|
||||||
|
|
||||||
|
System Requirements
|
||||||
|
-------------------
|
||||||
|
* CentOS 8 or
|
||||||
|
* Ubuntu 18
|
||||||
|
* Webmin
|
||||||
|
* 1 GB Ram
|
||||||
|
* 10 GB SSD
|
||||||
|
|
||||||
|
Authors
|
||||||
|
-------
|
||||||
|
* `David Ghedini`_
|
||||||
|
* `Kaloyan Petrov`_
|
||||||
|
|
||||||
|
.. _`David Ghedini`: https://github.com/DavidGhedini
|
||||||
|
.. _`Kaloyan Petrov`: https://github.com/kaloyan13
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Components
|
||||||
|
----------
|
||||||
|
|
||||||
|
`Nagios Core`_
|
||||||
|
|
||||||
|
.. _`Nagios Core`: https://www.nagios.org/projects/nagios-core/
|
||||||
|
|
||||||
|
`Nagios Remote Plugin Executor`_
|
||||||
|
|
||||||
|
.. _`Nagios Remote Plugin Executor`: https://exchange.nagios.org/directory/Addons/Monitoring-Agents/NRPE--2D-Nagios-Remote-Plugin-Executor/details
|
||||||
|
|
||||||
|
`Apache Tomcat`_
|
||||||
|
|
||||||
|
.. _`Apache Tomcat`: http://tomcat.apache.org/
|
||||||
|
|
||||||
|
Open Source
|
||||||
|
-----------
|
||||||
|
|
||||||
|
This module is Free, Open Source Software.
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE v3
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,38 @@
|
||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=python -msphinx
|
||||||
|
)
|
||||||
|
set SPHINXOPTS=
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
set SOURCEDIR=.
|
||||||
|
set BUILDDIR=build
|
||||||
|
set SPHINXPROJ=ReadtheDocsSphinxTheme
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% >NUL 2>NUL
|
||||||
|
if errorlevel 9009 (
|
||||||
|
echo.
|
||||||
|
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
|
||||||
|
echo.then set the SPHINXBUILD environment variable to point to the full
|
||||||
|
echo.path of the 'sphinx-build' executable. Alternatively you may add the
|
||||||
|
echo.Sphinx directory to PATH.
|
||||||
|
echo.
|
||||||
|
echo.If you don't have Sphinx installed, grab it from
|
||||||
|
echo.http://sphinx-doc.org/
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
sphinx
|
||||||
|
sphinxcontrib-httpdomain
|
||||||
|
|
@ -0,0 +1,678 @@
|
||||||
|
**********************
|
||||||
|
License
|
||||||
|
**********************
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
Nagios
|
||||||
|
------
|
||||||
|
|
||||||
|
Nagios and nrpe client are produced by `Nagios`_
|
||||||
|
|
||||||
|
.. _`Nagios`: https://www.nagios.com/
|
||||||
|
|
||||||
|
`Nagios Exchange`_ provides plugins, addons, docs, extensions and other tools
|
||||||
|
|
||||||
|
.. _`Nagios Exchange`: https://exchange.nagios.org/
|
||||||
|
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
.. This is a comment. Note how any initial comments are moved by
|
||||||
|
transforms to after the document title, subtitle, and docinfo.
|
||||||
|
|
||||||
|
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
||||||
|
|
||||||
|
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
|
||||||
|
:width: 1em
|
||||||
|
|
||||||
|
**********************
|
||||||
|
Security
|
||||||
|
**********************
|
||||||
|
|
||||||
|
Below are common items for securing your instance::
|
||||||
|
|
||||||
|
Disable root login
|
||||||
|
Change SSH port to non-standard (22) port
|
||||||
|
Change Webmin port to non-standard (10000) port
|
||||||
|
Install IP Tables
|
||||||
|
Restrict access to Webmin to your IP
|
||||||
|
Disable all services not in use
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
|
||||||
|
Project Support
|
||||||
|
---------------
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
========================
|
||||||
|
We welcome all contributors.
|
||||||
|
|
||||||
|
Issues
|
||||||
|
========================
|
||||||
|
If you've found a bug, let us know.
|
||||||
|
|
||||||
|
Pull Requests
|
||||||
|
========================
|
||||||
|
|
||||||
|
Create a fork of our repo.
|
||||||
|
|
||||||
|
To submit a pull request for a **new feature**:
|
||||||
|
|
||||||
|
1. Run the tests. Every pull request for a new feature should have an accompanying unit test and docs changes.
|
||||||
|
2. Create a new branch off of the `master` branch for your feature.
|
||||||
|
3. Add a test (or multiple tests) for your feature.
|
||||||
|
4. Add your new feature.
|
||||||
|
5. Push to your fork and submit the pull request.
|
||||||
|
|
||||||
|
To submit a **bug fix**:
|
||||||
|
|
||||||
|
1. Create a new branch off of the `master` branch.
|
||||||
|
2. Add a test that demonstrates the bug.
|
||||||
|
3. Make the test pass.
|
||||||
|
4. Push to your fork and submit the pull request!
|
||||||
|
|
||||||
|
To submit a **documentation fix**:
|
||||||
|
|
||||||
|
1. Create a new branch off of the `master` branch.
|
||||||
|
2. Add your documentation fixes (no tests required).
|
||||||
|
3. Push to your fork and submit the pull request!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
sda
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 2.9 KiB |
|
|
@ -0,0 +1,55 @@
|
||||||
|
.. This is a comment. Note how any initial comments are moved by
|
||||||
|
transforms to after the document title, subtitle, and docinfo.
|
||||||
|
|
||||||
|
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
||||||
|
|
||||||
|
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
|
||||||
|
:width: 1em
|
||||||
|
|
||||||
|
**********************
|
||||||
|
Nagios Service
|
||||||
|
**********************
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
Overview
|
||||||
|
==================
|
||||||
|
|
||||||
|
Nagios is installed as a service.
|
||||||
|
|
||||||
|
The service file is located under::
|
||||||
|
|
||||||
|
/lib/systemd/system/nagios.service
|
||||||
|
|
||||||
|
It has the contents below:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
[Unit]
|
||||||
|
Description=Nagios Core 4.4.5
|
||||||
|
Documentation=https://www.nagios.org/documentation
|
||||||
|
After=network.target local-fs.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=forking
|
||||||
|
ExecStartPre=/usr/local/nagios/bin/nagios -v /usr/local/nagios/etc/nagios.cfg
|
||||||
|
ExecStart=/usr/local/nagios/bin/nagios -d /usr/local/nagios/etc/nagios.cfg
|
||||||
|
ExecStop=/bin/kill -s TERM ${MAINPID}
|
||||||
|
ExecStopPost=/bin/rm -f /usr/local/nagios/var/rw/nagios.cmd
|
||||||
|
ExecReload=/bin/kill -s HUP ${MAINPID}
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
|
||||||
|
Start and Stop
|
||||||
|
==============
|
||||||
|
|
||||||
|
The Nagios service can be started and stopped via the module or via command line.
|
||||||
|
|
||||||
|
To start and stop via the module, go to Servers > Nagios and click the Start or Stop button:
|
||||||
|
|
||||||
|
.. image:: _static/nagios-service.png
|
||||||
|
|
||||||
|
To start and stop via command line, as root, issue::
|
||||||
|
|
||||||
|
service nagios stop | start
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 2.6 KiB |
|
|
@ -0,0 +1,65 @@
|
||||||
|
.. This is a comment. Note how any initial comments are moved by
|
||||||
|
transforms to after the document title, subtitle, and docinfo.
|
||||||
|
|
||||||
|
.. demo.rst from: http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
||||||
|
|
||||||
|
.. |EXAMPLE| image:: static/yi_jing_01_chien.jpg
|
||||||
|
:width: 1em
|
||||||
|
|
||||||
|
**********************
|
||||||
|
Nrpe Service
|
||||||
|
**********************
|
||||||
|
|
||||||
|
.. contents:: Table of Contents
|
||||||
|
Overview
|
||||||
|
==================
|
||||||
|
|
||||||
|
Nrpe is installed as a service.
|
||||||
|
|
||||||
|
The service file is located under::
|
||||||
|
|
||||||
|
/lib/systemd/system/nrpe.service
|
||||||
|
|
||||||
|
It has the contents below:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
:linenos:
|
||||||
|
|
||||||
|
[Unit]
|
||||||
|
Description=Nagios Remote Plugin Executor
|
||||||
|
Documentation=http://www.nagios.org/documentation
|
||||||
|
After=var-run.mount nss-lookup.target network.target local-fs.target time-sync.target
|
||||||
|
Before=getty@tty1.service plymouth-quit.service xdm.service
|
||||||
|
Conflicts=nrpe.socket
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
Restart=on-abort
|
||||||
|
PIDFile=/usr/local/nagios/var/nrpe.pid
|
||||||
|
RuntimeDirectory=nrpe
|
||||||
|
RuntimeDirectoryMode=0755
|
||||||
|
ExecStart=/usr/local/nagios/bin/nrpe -c /usr/local/nagios/etc/nrpe.cfg -f
|
||||||
|
ExecReload=/bin/kill -HUP $MAINPID
|
||||||
|
ExecStopPost=/bin/rm -f /usr/local/nagios/var/nrpe.pid
|
||||||
|
TimeoutStopSec=60
|
||||||
|
User=nagios
|
||||||
|
Group=nagios
|
||||||
|
PrivateTmp=true
|
||||||
|
OOMScoreAdjust=-500
|
||||||
|
|
||||||
|
|
||||||
|
Start and Stop
|
||||||
|
==============
|
||||||
|
|
||||||
|
The Nrpe service can be started and stopped via the module or via command line.
|
||||||
|
|
||||||
|
To start and stop via the module, go to Servers > Nagios and click the Start or Stop button:
|
||||||
|
|
||||||
|
.. image:: _static/nrpe-service.png
|
||||||
|
|
||||||
|
To start and stop via command line, as root, issue::
|
||||||
|
|
||||||
|
service nrpe stop | start
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
Webmin
|
||||||
|
------
|
||||||
|
|
||||||
|
Webmin can be accessed via::
|
||||||
|
|
||||||
|
https://yourdomain.com:10000
|
||||||
|
|
||||||
|
The Nagios module is found under Servers > Nagios as shown below:
|
||||||
|
|
||||||
|
.. image:: _static/nagios-webmin.png
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
.. _wizard-label:
|
||||||
|
|
||||||
|
************
|
||||||
|
Wizard
|
||||||
|
************
|
||||||
|
|
||||||
|
Once the module is installed, the Wizard is used to configure the components.
|
||||||
|
|
||||||
|
Go to Servers > Nagios:
|
||||||
|
|
||||||
|
The main Wizard screen contains a link for completing each step.
|
||||||
|
|
||||||
|
.. image:: _static/nagiosWizard.png
|
||||||
|
|
||||||
|
The steps are self-explanatory, and you simply need to click through each step.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Due to compiling of components, completion of the Wizard may take up to 10 minutes to complete.
|
||||||
|
|
||||||
|
**Nrpe**
|
||||||
|
|
||||||
|
Installation of nrpe service is optional.
|
||||||
|
|
||||||
|
|
||||||
|
Once installation is completed, the page will appear as below:
|
||||||
|
|
||||||
|
.. image:: _static/nagios-main.png
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
About nrpe
|
||||||
|
===================
|
||||||
|
|
||||||
|
NRPE allows you to remotely execute Nagios plugins on on compatible servers.
|
||||||
|
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
#!/usr/bin/perl
|
||||||
|
|
||||||
|
require './nagios-lib.pl';
|
||||||
|
&ReadParse();
|
||||||
|
&ui_print_header(undef, $text{'manual_title'}, "");
|
||||||
|
|
||||||
|
# Work out and show the files
|
||||||
|
@files = get_cfg_files(get_nagios_home().'/etc');
|
||||||
|
$in{'file'} ||= $files[0];
|
||||||
|
&indexof($in{'file'}, @files) >= 0 || &error($text{'manual_efile'});
|
||||||
|
|
||||||
|
print &ui_form_start("edit_cfg.cgi");
|
||||||
|
print "<b>$text{'manual_file'}</b>\n";
|
||||||
|
print &ui_select("file", $in{'file'}, [ map { [ $_ ] } @files ], 1, 0);
|
||||||
|
print &ui_submit($text{'manual_ok'});
|
||||||
|
print &ui_form_end();
|
||||||
|
|
||||||
|
# Show the file contents
|
||||||
|
print &ui_form_start("save_cfg.cgi", "form-data");
|
||||||
|
print &ui_hidden("file", $in{'file'}),"\n";
|
||||||
|
$data = &read_file_contents($in{'file'});
|
||||||
|
print &ui_textarea("data", $data, 20, 80),"\n";
|
||||||
|
print &ui_form_end([ [ "save", $text{'save'} ] ]);
|
||||||
|
|
||||||
|
&ui_print_footer("", $text{'index_return'});
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
#!/usr/bin/perl
|
||||||
|
|
||||||
|
require './nagios-lib.pl';
|
||||||
|
&ReadParse();
|
||||||
|
&ui_print_header(undef, $text{'objects_title'}, "");
|
||||||
|
|
||||||
|
# Work out and show the files
|
||||||
|
@files = get_cfg_files(get_nagios_home().'/etc/objects');
|
||||||
|
$in{'file'} ||= $files[0];
|
||||||
|
&indexof($in{'file'}, @files) >= 0 || &error($text{'manual_efile'});
|
||||||
|
|
||||||
|
print &ui_form_start("create_cfg.cgi", 'post');
|
||||||
|
print "<b>$text{'create_cfg_file'}</b>".&ui_textbox("new_filename", '', 20, 0).&ui_submit($text{'create_ok'});
|
||||||
|
print &ui_form_end();
|
||||||
|
|
||||||
|
print &ui_form_start("edit_objects.cgi");
|
||||||
|
print "<b>$text{'manual_file'}</b>\n";
|
||||||
|
print &ui_select("file", $in{'file'}, [ map { [ $_ ] } @files ], 1, 0);
|
||||||
|
print &ui_submit($text{'manual_ok'});
|
||||||
|
print &ui_form_end();
|
||||||
|
|
||||||
|
# Show the file contents
|
||||||
|
print &ui_form_start("save_objects.cgi", "form-data");
|
||||||
|
print &ui_hidden("file", $in{'file'}),"\n";
|
||||||
|
$data = &read_file_contents($in{'file'});
|
||||||
|
print &ui_textarea("data", $data, 20, 80),"\n";
|
||||||
|
print &ui_form_end([ [ "save", $text{'save'} ] ]);
|
||||||
|
|
||||||
|
&ui_print_footer("", $text{'index_return'});
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
index_title=Nagios
|
||||||
|
index_root=The root directory is $1.
|
||||||
|
|
||||||
|
index_start=Start Nagios
|
||||||
|
index_startmsg=Click to start Nagios Service
|
||||||
|
index_stop=Stop Nagios
|
||||||
|
index_stopmsg=Click to stop Nagios Service
|
||||||
|
|
||||||
|
|
||||||
|
index_start_nrpe=Start Nrpe
|
||||||
|
index_startmsg_nrpe=Click to start Nrpe Service
|
||||||
|
index_stop_nrpe=Stop Nrpe
|
||||||
|
index_stopmsg_nrpe=Click to stop Nrpe Service
|
||||||
|
|
||||||
|
index_return=Nagios
|
||||||
|
|
||||||
|
manual_title=Main Confs
|
||||||
|
manual_ecannot=You are not allowed to edit the file
|
||||||
|
manual_ok=Edit
|
||||||
|
manual_efile=Selected file is not part of configuration
|
||||||
|
manual_file=Edit config file:
|
||||||
|
manual_edata=Nothing entered!
|
||||||
|
manual_err=Failed to save config file
|
||||||
|
|
||||||
|
objects_title=Objects
|
||||||
|
|
||||||
|
create_ok=Create
|
||||||
|
create_cfg_file=New Filename:
|
||||||
|
|
||||||
|
setup_title=Setup
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
<header>Nagios Module</header>
|
||||||
|
|
||||||
|
<p>This module is used to install and manage Nagios via Webmin</p>
|
||||||
|
|
||||||
|
<p>Nagios is open soft software and use is subject to terms provided by
|
||||||
|
the <a href="https://www.nagios.org/" rel="nofollow">Nagios Foundation</a>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>Module produced by <a href="https://www.citedcorp.com/" rel="nofollow">Cited, Inc.</a>
|
||||||
|
</p>
|
||||||
|
<p>© 2020, Cited, Inc.</p>
|
||||||
|
|
||||||
|
<hr>
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
|
|
@ -0,0 +1,60 @@
|
||||||
|
#!/usr/bin/perl
|
||||||
|
|
||||||
|
require './nagios-lib.pl';
|
||||||
|
|
||||||
|
# Check if config file exists
|
||||||
|
if (! -r $config{'nagios_config'}) {
|
||||||
|
&ui_print_header(undef, $text{'index_title'}, "", "intro", 1, 1);
|
||||||
|
print &text('index_econfig', "<tt>$config{'nagios_config'}</tt>",
|
||||||
|
"$gconfig{'webprefix'}/config.cgi?$module_name"),"<p>\n";
|
||||||
|
&ui_print_footer("/", $text{"index"});
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(-f "$module_root_directory/setup.cgi"){
|
||||||
|
&redirect('setup.cgi');
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check if tomcat is the right version
|
||||||
|
%version = &get_nagios_version();
|
||||||
|
&ui_print_header(undef, $text{'index_title'}, "", "intro", 1, 1, 0,
|
||||||
|
&help_search_link("Nagios", "nrpe"), undef, undef,
|
||||||
|
'Nagios ver.'.$version{'number'}.'<br><a href="https://www.citedcorp.com" target="_blank">Cited, Inc.</a> © 2020');
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
push(@links, "edit_cfg.cgi");
|
||||||
|
push(@titles, $text{'manual_title'});
|
||||||
|
push(@icons, "images/edit-file.png");
|
||||||
|
|
||||||
|
push(@links, "edit_objects.cgi");
|
||||||
|
push(@titles, $text{'objects_title'});
|
||||||
|
push(@icons, "images/objects.png");
|
||||||
|
|
||||||
|
|
||||||
|
&icons_table(\@links, \@titles, \@icons, 2);
|
||||||
|
|
||||||
|
print &ui_hr();
|
||||||
|
print &ui_buttons_start();
|
||||||
|
|
||||||
|
my $is_running = nagios_is_running();
|
||||||
|
if ($is_running == 1) {
|
||||||
|
print &ui_buttons_row("stop.cgi", $text{'index_stop'}, $text{'index_stopmsg'});
|
||||||
|
}else {
|
||||||
|
print &ui_buttons_row("start.cgi", $text{'index_start'}, $text{'index_startmsg'});
|
||||||
|
}
|
||||||
|
print &ui_buttons_end();
|
||||||
|
|
||||||
|
|
||||||
|
print &ui_buttons_start();
|
||||||
|
|
||||||
|
my $is_running = nrpe_is_running();
|
||||||
|
if ($is_running == 1) {
|
||||||
|
print &ui_buttons_row("stop_nrpe.cgi", $text{'index_stop_nrpe'}, $text{'index_stopmsg_nrpe'});
|
||||||
|
}else {
|
||||||
|
print &ui_buttons_row("start_nrpe.cgi", $text{'index_start_nrpe'}, $text{'index_startmsg_nrpe'});
|
||||||
|
}
|
||||||
|
print &ui_buttons_end();
|
||||||
|
|
||||||
|
|
||||||
|
&ui_print_footer("/", $text{"index_return"});
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
# install_check.pl
|
||||||
|
|
||||||
|
do 'nagios-lib.pl';
|
||||||
|
|
||||||
|
# is_installed(mode)
|
||||||
|
# For mode 1, returns 2 if the server is installed and configured for use by
|
||||||
|
# Webmin, 1 if installed but not configured, or 0 otherwise.
|
||||||
|
# For mode 0, returns 1 if installed, 0 if not
|
||||||
|
sub is_installed
|
||||||
|
{
|
||||||
|
return 0 if (!-r $config{'nagios_config'} || !&has_command('check_nrpe'));
|
||||||
|
return $_[0] ? 2 : 1;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
index_title=Nagios
|
||||||
|
index_root=The root directory is $1.
|
||||||
|
|
||||||
|
index_start=Start Nagios
|
||||||
|
index_startmsg=Click to start Nagios Service
|
||||||
|
index_stop=Stop Nagios
|
||||||
|
index_stopmsg=Click to stop Nagios Service
|
||||||
|
|
||||||
|
|
||||||
|
index_start_nrpe=Start Nrpe
|
||||||
|
index_startmsg_nrpe=Click to start Nrpe Service
|
||||||
|
index_stop_nrpe=Stop Nrpe
|
||||||
|
index_stopmsg_nrpe=Click to stop Nrpe Service
|
||||||
|
|
||||||
|
index_return=Nagios
|
||||||
|
|
||||||
|
manual_title=Main Confs
|
||||||
|
manual_ecannot=You are not allowed to edit the file
|
||||||
|
manual_ok=Edit
|
||||||
|
manual_efile=Selected file is not part of configuration
|
||||||
|
manual_file=Edit config file:
|
||||||
|
manual_edata=Nothing entered!
|
||||||
|
manual_err=Failed to save config file
|
||||||
|
|
||||||
|
objects_title=Objects
|
||||||
|
|
||||||
|
create_ok=Create
|
||||||
|
create_cfg_file=New Filename:
|
||||||
|
|
||||||
|
setup_title=Setup
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
desc=Nagios
|
||||||
|
os_support=*-linux freebsd archlinux
|
||||||
|
category=servers
|
||||||
|
|
@ -0,0 +1,134 @@
|
||||||
|
BEGIN { push(@INC, ".."); };
|
||||||
|
use WebminCore;
|
||||||
|
|
||||||
|
init_config();
|
||||||
|
|
||||||
|
sub get_nagios_config{
|
||||||
|
my $lref = &read_file_lines($config{'nagios_config'});
|
||||||
|
my @rv;
|
||||||
|
my $lnum = 0;
|
||||||
|
foreach my $line (@$lref) {
|
||||||
|
my ($n, $v) = split(/\s+/, $line, 2);
|
||||||
|
if ($n) {
|
||||||
|
push(@rv, { 'name' => $n, 'value' => $v, 'line' => $lnum });
|
||||||
|
}
|
||||||
|
$lnum++;
|
||||||
|
}
|
||||||
|
return @rv;
|
||||||
|
}
|
||||||
|
|
||||||
|
sub get_nagios_home(){
|
||||||
|
return '/usr/local/nagios';
|
||||||
|
}
|
||||||
|
|
||||||
|
sub get_nagios_version(){
|
||||||
|
my %version;
|
||||||
|
my $nagios_home = get_nagios_home();
|
||||||
|
|
||||||
|
&open_execute_command(CMD, $nagios_home.'/bin/nagios -h', 1);
|
||||||
|
while(my $line = <CMD>) {
|
||||||
|
if ($line =~ /Nagios Core ([0-9\.]+)$/i) {
|
||||||
|
$version{'number'} = $1;
|
||||||
|
last;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
close(CMD);
|
||||||
|
|
||||||
|
return %version;
|
||||||
|
}
|
||||||
|
|
||||||
|
sub nagios_is_running(){
|
||||||
|
my $rv = 0;
|
||||||
|
my $nagios_bin = get_nagios_home().'/bin/nagios';
|
||||||
|
|
||||||
|
&open_execute_command(CMD, '/bin/ps -ef', 1);
|
||||||
|
while(my $line = <CMD>) {
|
||||||
|
if ($line =~ /$nagios_bin/i) {
|
||||||
|
$rv = 1;
|
||||||
|
last;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
close(CMD);
|
||||||
|
|
||||||
|
return $rv;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
sub nrpe_is_running(){
|
||||||
|
my $rv = 0;
|
||||||
|
my $nrpe_bin = get_nagios_home().'/bin/nrpe';
|
||||||
|
|
||||||
|
&open_execute_command(CMD, '/bin/ps -ef', 1);
|
||||||
|
while(my $line = <CMD>) {
|
||||||
|
if ($line =~ /$nrpe_bin/i) {
|
||||||
|
$rv = 1;
|
||||||
|
last;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
close(CMD);
|
||||||
|
|
||||||
|
return $rv;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
sub get_cfg_files{
|
||||||
|
my $dirpath = $_[0];
|
||||||
|
my @files;
|
||||||
|
|
||||||
|
opendir(DIR, $dirpath) or die $!;
|
||||||
|
my @cfg_files = grep {
|
||||||
|
/\.cfg$/ # ends in .cfg
|
||||||
|
&& -f $dirpath.'/'.$_ # its a file
|
||||||
|
} readdir(DIR);
|
||||||
|
closedir(DIR);
|
||||||
|
|
||||||
|
#make file have full path name
|
||||||
|
@cfg_files = map { $dirpath.'/'.$_} @cfg_files;
|
||||||
|
push(@files, @cfg_files);
|
||||||
|
|
||||||
|
return @files;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
sub exec_cmd{
|
||||||
|
my $cmd = $_[0];
|
||||||
|
my $cmd_out='';
|
||||||
|
|
||||||
|
my $rv = &execute_command($cmd, undef, \$cmd_out, \$cmd_out, 0, 0);
|
||||||
|
if($cmd_out){
|
||||||
|
$cmd_out = &html_escape($cmd_out);
|
||||||
|
$cmd_out =~ s/[\r\n]/<\/br>/g;
|
||||||
|
print $cmd_out;
|
||||||
|
}
|
||||||
|
return $rv;
|
||||||
|
}
|
||||||
|
|
||||||
|
sub download_file{
|
||||||
|
my $url = $_[0];
|
||||||
|
|
||||||
|
my ($proto, $x, $host, $path) = split('/', $url, 4);
|
||||||
|
my @paths = split('/', $url);
|
||||||
|
my $filename = $paths[-1];
|
||||||
|
if($filename eq ''){
|
||||||
|
$filename = 'index.html';
|
||||||
|
}
|
||||||
|
|
||||||
|
my $sslmode = $proto eq 'https:';
|
||||||
|
my $port = 80;
|
||||||
|
if($sslmode){
|
||||||
|
$port = 443;
|
||||||
|
}
|
||||||
|
|
||||||
|
&error_setup(&text('install_err3', $url));
|
||||||
|
my $tmpfile = &transname($filename);
|
||||||
|
$progress_callback_url = $url;
|
||||||
|
|
||||||
|
&http_download($host, $port, '/'.$path, $tmpfile, \$error, \&progress_callback, $sslmode);
|
||||||
|
|
||||||
|
if($error){
|
||||||
|
print &html_escape($error);
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
return $tmpfile;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
#!/usr/bin/perl
|
||||||
|
|
||||||
|
require './nagios-lib.pl';
|
||||||
|
&error_setup($text{'manual_err'});
|
||||||
|
&ReadParseMime();
|
||||||
|
|
||||||
|
# Work out the file
|
||||||
|
@files = get_cfg_files(get_nagios_home().'/etc');
|
||||||
|
&indexof($in{'file'}, @files) >= 0 || &error($text{'manual_efile'});
|
||||||
|
$in{'data'} =~ s/\r//g;
|
||||||
|
$in{'data'} =~ /\S/ || &error($text{'manual_edata'});
|
||||||
|
|
||||||
|
# Write to it
|
||||||
|
&open_lock_tempfile(DATA, ">$in{'file'}");
|
||||||
|
&print_tempfile(DATA, $in{'data'});
|
||||||
|
&close_tempfile(DATA);
|
||||||
|
|
||||||
|
&webmin_log("manual", undef, $in{'file'});
|
||||||
|
&redirect("");
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
#!/usr/bin/perl
|
||||||
|
|
||||||
|
require './nagios-lib.pl';
|
||||||
|
&error_setup($text{'manual_err'});
|
||||||
|
&ReadParseMime();
|
||||||
|
|
||||||
|
# Work out the file
|
||||||
|
@files = get_cfg_files(get_nagios_home().'/etc/objects');
|
||||||
|
&indexof($in{'file'}, @files) >= 0 || &error($text{'manual_efile'});
|
||||||
|
$in{'data'} =~ s/\r//g;
|
||||||
|
$in{'data'} =~ /\S/ || &error($text{'manual_edata'});
|
||||||
|
|
||||||
|
# Write to it
|
||||||
|
&open_lock_tempfile(DATA, ">$in{'file'}");
|
||||||
|
&print_tempfile(DATA, $in{'data'});
|
||||||
|
&close_tempfile(DATA);
|
||||||
|
|
||||||
|
&webmin_log("manual", undef, $in{'file'});
|
||||||
|
&redirect("");
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,156 @@
|
||||||
|
# !/bin/bash -e
|
||||||
|
# nrpe client installer for CentOS and Ubuntu
|
||||||
|
# Info: This script installs a NRPE client, following [1]
|
||||||
|
# [1] https://support.nagios.com/kb/article.php?id=515
|
||||||
|
# For use on clean CentOS or Ubuntu box only
|
||||||
|
# Usage:
|
||||||
|
# wget https://raw.githubusercontent.com/DavidGhedini/nagios-webmin-module/master/scripts/pre-install.sh
|
||||||
|
# chmod +x pre-installer
|
||||||
|
# ./pre-installer.sh
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#Nagious server, that will monitor this client node
|
||||||
|
NAGIOS_MON_HOST='1.2.3.4'
|
||||||
|
NAGIOS_HOME='/usr/local/nagios/'
|
||||||
|
|
||||||
|
function detect_distro(){
|
||||||
|
if [ -f /etc/centos-release ]; then
|
||||||
|
DISTRO='centos'
|
||||||
|
DISTRO_VER=$(grep VERSION_ID /etc/os-release | tr -d '"' | cut -f2 -d= | cut -f1 -d.)
|
||||||
|
|
||||||
|
#opensuse,debian,slackware, ubuntu
|
||||||
|
elif [ -f /etc/os-release ]; then
|
||||||
|
DISTRO=$(grep -m 1 ID /etc/os-release | cut -f2 -d= | tr -d '"')
|
||||||
|
DISTRO_VER=$(grep VERSION_ID /etc/os-release | tr -d '"' | cut -f2 -d= | cut -f1 -d.)
|
||||||
|
else
|
||||||
|
echo "Error: Failed to detect distribution"; exit 1;
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_deps(){
|
||||||
|
|
||||||
|
if [ ${DISTRO} == 'centos' ]; then
|
||||||
|
yum install -y gcc glibc glibc-common openssl openssl-devel perl wget
|
||||||
|
elif [ ${DISTRO} == 'ubuntu' ]; then
|
||||||
|
export DEBIAN_FRONTEND=noninteractive
|
||||||
|
if [ ${DISTRO_VER} -eq 18 ]; then
|
||||||
|
apt-add-repository universe
|
||||||
|
fi
|
||||||
|
apt-get install -y autoconf automake gcc libc6 libmcrypt-dev make libssl-dev wget openssl make
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_nrpe(){
|
||||||
|
NRPE_VER='3.2.1'
|
||||||
|
|
||||||
|
if [ $(grep -m 1 -c '^nagios:' /etc/passwd) -eq 0 ]; then
|
||||||
|
useradd -s /bin/false nagios
|
||||||
|
fi
|
||||||
|
|
||||||
|
pushd ${HOME}
|
||||||
|
if [ ! -f nrpe-${NRPE_VER}.tar.gz ]; then
|
||||||
|
wget --no-check-certificate https://github.com/NagiosEnterprises/nrpe/archive/nrpe-${NRPE_VER}.tar.gz
|
||||||
|
fi
|
||||||
|
|
||||||
|
tar xzf nrpe-${NRPE_VER}.tar.gz
|
||||||
|
rm -f nrpe-${NRPE_VER}.tar.gz
|
||||||
|
|
||||||
|
pushd nrpe-nrpe-${NRPE_VER}/
|
||||||
|
|
||||||
|
if [ $(which systemctl 2>/dev/null | grep -c yum) -eq 1 ]; then
|
||||||
|
./configure --enable-command-args --with-init-type=systemd
|
||||||
|
else
|
||||||
|
./configure --enable-command-args
|
||||||
|
fi
|
||||||
|
|
||||||
|
make all install install-groups-users install-plugin install-config install-init
|
||||||
|
popd
|
||||||
|
rm -f nrpe-nrpe-${NRPE_VER}/
|
||||||
|
popd
|
||||||
|
}
|
||||||
|
|
||||||
|
function config_nrpe(){
|
||||||
|
|
||||||
|
sed -i "/^allowed_hosts=/s/\$/,${NAGIOS_MON_HOST}/" ${NAGIOS_HOME}/etc/nrpe.cfg
|
||||||
|
sed -i 's/^dont_blame_nrpe=.*/dont_blame_nrpe=1/g' ${NAGIOS_HOME}/etc/nrpe.cfg
|
||||||
|
|
||||||
|
#Standard command found in source/package plugins
|
||||||
|
cat >> ${NAGIOS_HOME}/etc/nrpe.cfg <<CMD_EOF
|
||||||
|
command[check_disk_root]=${CUSTOM_PLUGINS_HOME}/check_disk -w 30% -c 10% -p /
|
||||||
|
CMD_EOF
|
||||||
|
|
||||||
|
cat >> ${NAGIOS_HOME}/etc/nrpe.cfg <<CMD_EOF
|
||||||
|
command[check_linuxdiskspace]=${CUSTOM_PLUGINS_HOME}/check_linuxdiskspace
|
||||||
|
CMD_EOF
|
||||||
|
|
||||||
|
#Linux S.M.A.R.T Checks
|
||||||
|
#NOTE: we may have /dev/vda1 for virtual disk
|
||||||
|
for sd in $(find /dev -type b -name 'sd[a-z][0-9]' | cut -f3 -d/); do
|
||||||
|
echo "command[check_linux_smart_${sd}]=${CUSTOM_PLUGINS_HOME}/check_ide_smart -d /dev/${sd}" >> ${NAGIOS_HOME}/etc/nrpe.cfg
|
||||||
|
done
|
||||||
|
|
||||||
|
|
||||||
|
if [ $(which systemctl 2>/dev/null | grep -c systemctl) -eq 1 ]; then
|
||||||
|
systemctl enable nrpe.service
|
||||||
|
systemctl start nrpe
|
||||||
|
else
|
||||||
|
chkconfig --set nrpe on
|
||||||
|
service nrpe start
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_plugins_source(){
|
||||||
|
PLUG_VER='2.3.1'
|
||||||
|
|
||||||
|
if [ ${DISTRO} == 'centos' ]; then
|
||||||
|
yum install -y gcc glibc glibc-common make gettext automake autoconf wget openssl-devel net-snmp net-snmp-utils epel-release perl-Net-SNMP
|
||||||
|
elif [ ${DISTRO} == 'ubuntu' ]; then
|
||||||
|
apt-get install -y autoconf gcc libc6 libmcrypt-dev make libssl-dev wget bc gawk dc build-essential snmp libnet-snmp-perl gettext
|
||||||
|
fi
|
||||||
|
|
||||||
|
pushd ${HOME}
|
||||||
|
wget --no-check-certificate https://github.com/nagios-plugins/nagios-plugins/archive/release-${PLUG_VER}.tar.gz
|
||||||
|
tar xzf release-${PLUG_VER}.tar.gz
|
||||||
|
rm -f release-${PLUG_VER}.tar.gz
|
||||||
|
|
||||||
|
pushd nagios-plugins-release-${PLUG_VER}/
|
||||||
|
./tools/setup
|
||||||
|
./configure
|
||||||
|
make
|
||||||
|
make install
|
||||||
|
popd
|
||||||
|
rm -rf nagios-plugins-release-${PLUG_VER}/
|
||||||
|
popd
|
||||||
|
|
||||||
|
NAGIOS_PLUGINS_HOME='/usr/local/nagios/libexec/'
|
||||||
|
}
|
||||||
|
|
||||||
|
#Install plugins not found in source or packages
|
||||||
|
function install_plugins(){
|
||||||
|
|
||||||
|
install_plugins_source
|
||||||
|
}
|
||||||
|
|
||||||
|
function test_nrpe(){
|
||||||
|
|
||||||
|
if [ ! -f ${NAGIOS_HOME}/etc/nrpe.cfg ]; then
|
||||||
|
echo 'Error: nrpe.cfg is missing!'
|
||||||
|
fi
|
||||||
|
|
||||||
|
OUT=$(${NAGIOS_HOME}/libexec/check_nrpe -H 127.0.0.1)
|
||||||
|
if [ "${OUT}" == "NRPE v${NRPE_VER}" ]; then
|
||||||
|
echo "NRPE Test OK"
|
||||||
|
else
|
||||||
|
echo "NRPE Test FAILED"
|
||||||
|
exit 1;
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
detect_distro;
|
||||||
|
install_deps;
|
||||||
|
install_nrpe;
|
||||||
|
install_plugins;
|
||||||
|
config_nrpe;
|
||||||
|
|
||||||
|
test_nrpe;
|
||||||
|
|
@ -0,0 +1,119 @@
|
||||||
|
# !/bin/bash -e
|
||||||
|
# nagios-webmin-module Pre-Install Script for CentOS and Ubuntu
|
||||||
|
# For use on clean CentOS or Ubuntu box only
|
||||||
|
# Usage:
|
||||||
|
# wget https://raw.githubusercontent.com/cited/nagios-webmin-module/master/scripts/pre-install.sh
|
||||||
|
# chmod +x pre-installer
|
||||||
|
# ./pre-installer.sh
|
||||||
|
|
||||||
|
function get_repo(){
|
||||||
|
if [ -f /etc/centos-release ]; then
|
||||||
|
REPO='rpm'
|
||||||
|
|
||||||
|
elif [ -f /etc/debian_version ]; then
|
||||||
|
REPO='apt'
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_webmin(){
|
||||||
|
|
||||||
|
if [ "${REPO}" == 'apt' ]; then
|
||||||
|
|
||||||
|
echo "deb http://download.webmin.com/download/repository sarge contrib" > /etc/apt/sources.list.d/webmin.list
|
||||||
|
wget -qO - http://www.webmin.com/jcameron-key.asc | apt-key add -
|
||||||
|
apt-get -y update
|
||||||
|
apt-get -y install webmin
|
||||||
|
|
||||||
|
elif [ "${REPO}" == 'rpm' ]; then
|
||||||
|
|
||||||
|
cat >/etc/yum.repos.d/webmin.repo <<EOF
|
||||||
|
[Webmin]
|
||||||
|
name=Webmin Distribution Neutral
|
||||||
|
#baseurl=http://download.webmin.com/download/yum
|
||||||
|
mirrorlist=http://download.webmin.com/download/yum/mirrorlist
|
||||||
|
enabled=1
|
||||||
|
EOF
|
||||||
|
wget http://www.webmin.com/jcameron-key.asc
|
||||||
|
rpm --import jcameron-key.asc
|
||||||
|
yum -y install webmin
|
||||||
|
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function download_nagios_webmin_module(){
|
||||||
|
pushd /tmp/
|
||||||
|
wget https://github.com/cited/nagios-webmin-module/archive/master.zip
|
||||||
|
unzip master.zip
|
||||||
|
mv nagios-webmin-module-master nagios
|
||||||
|
tar -czf /opt/nagios.wbm.gz nagios
|
||||||
|
rm -rf nagios master.zip
|
||||||
|
popd
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function download_certbot_module(){
|
||||||
|
pushd /tmp/
|
||||||
|
wget https://github.com/cited/Certbot-Webmin-Module/archive/master.zip
|
||||||
|
unzip master.zip
|
||||||
|
mv Certbot-Webmin-Module-master certbot
|
||||||
|
tar -czf /opt/certbot.wbm.gz certbot
|
||||||
|
rm -rf certbot master.zip
|
||||||
|
popd
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_apache(){
|
||||||
|
if [ "${REPO}" == 'apt' ]; then
|
||||||
|
apt-get -y install apache2
|
||||||
|
elif [ "${REPO}" == 'rpm' ]; then
|
||||||
|
yum -y install httpd
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_nagios_webmin_module(){
|
||||||
|
pushd /opt/
|
||||||
|
if [ "${REPO}" == 'apt' ]; then
|
||||||
|
/usr/share/webmin/install-module.pl nagios.wbm.gz
|
||||||
|
elif [ "${REPO}" == 'rpm' ]; then
|
||||||
|
/usr/libexec/webmin/install-module.pl nagios.wbm.gz
|
||||||
|
fi
|
||||||
|
popd
|
||||||
|
echo -e "Nagios Module is now installed. Go to Servers > Nagios to complete installation"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_certbot_module(){
|
||||||
|
pushd /opt/
|
||||||
|
if [ "${REPO}" == 'apt' ]; then
|
||||||
|
/usr/share/webmin/install-module.pl certbot.wbm.gz
|
||||||
|
elif [ "${REPO}" == 'rpm' ]; then
|
||||||
|
/usr/libexec/webmin/install-module.pl certbot.wbm.gz
|
||||||
|
fi
|
||||||
|
popd
|
||||||
|
echo -e "Certbot is now installed. Go to Servers > Certbot to complete installation"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_deps(){
|
||||||
|
if [ "${REPO}" == 'apt' ]; then
|
||||||
|
apt-get -y install wget unzip
|
||||||
|
elif [ "${REPO}" == 'rpm' ]; then
|
||||||
|
yum -y install wget unzip bzip2
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_apache(){
|
||||||
|
if [ "${REPO}" == 'apt' ]; then
|
||||||
|
apt-get -y install apache2
|
||||||
|
elif [ "${REPO}" == 'rpm' ]; then
|
||||||
|
yum -y install httpd
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
get_repo;
|
||||||
|
get_deps;
|
||||||
|
install_webmin;
|
||||||
|
install_apache;
|
||||||
|
download_nagios_webmin_module;
|
||||||
|
download_certbot_module;
|
||||||
|
install_certbot_module;
|
||||||
|
install_nagios_webmin_module;
|
||||||
|
|
@ -0,0 +1,88 @@
|
||||||
|
# !/bin/bash -e
|
||||||
|
# nagios-webmin-module Pre-Install Script for CentOS and Ubuntu
|
||||||
|
# For use on Ubuntu box only
|
||||||
|
# Usage:
|
||||||
|
# wget https://raw.githubusercontent.com/cited/nagios-webmin-module/master/scripts/pre-install.sh
|
||||||
|
# chmod +x pre-installer
|
||||||
|
# ./pre-installer.sh
|
||||||
|
|
||||||
|
function install_webmin(){
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
echo "deb http://download.webmin.com/download/repository sarge contrib" > /etc/apt/sources.list.d/webmin.list
|
||||||
|
wget -qO - http://www.webmin.com/jcameron-key.asc | apt-key add -
|
||||||
|
apt-get -y update
|
||||||
|
apt-get -y install webmin
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function download_nagios_webmin_module(){
|
||||||
|
pushd /tmp/
|
||||||
|
wget https://github.com/cited/nagios-webmin-module/archive/master.zip
|
||||||
|
unzip master.zip
|
||||||
|
mv nagios-webmin-module-master nagios
|
||||||
|
tar -czf /opt/nagios.wbm.gz nagios
|
||||||
|
rm -rf nagios master.zip
|
||||||
|
popd
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function download_certbot_module(){
|
||||||
|
pushd /tmp/
|
||||||
|
wget https://github.com/cited/Certbot-Webmin-Module/archive/master.zip
|
||||||
|
unzip master.zip
|
||||||
|
mv Certbot-Webmin-Module-master certbot
|
||||||
|
tar -czf /opt/certbot.wbm.gz certbot
|
||||||
|
rm -rf certbot master.zip
|
||||||
|
popd
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_apache(){
|
||||||
|
|
||||||
|
apt-get -y install apache2
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_nagios_webmin_module(){
|
||||||
|
pushd /opt/
|
||||||
|
|
||||||
|
/usr/share/webmin/install-module.pl nagios.wbm.gz
|
||||||
|
|
||||||
|
popd
|
||||||
|
echo -e "Nagios Module is now installed. Go to Servers > Nagios to complete installation"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_certbot_module(){
|
||||||
|
pushd /opt/
|
||||||
|
|
||||||
|
/usr/share/webmin/install-module.pl certbot.wbm.gz
|
||||||
|
popd
|
||||||
|
echo -e "Certbot is now installed. Go to Servers > Certbot to complete installation"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function get_deps(){
|
||||||
|
|
||||||
|
apt-get -y install wget unzip
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function install_apache(){
|
||||||
|
|
||||||
|
apt-get -y install apache2
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
get_deps;
|
||||||
|
install_webmin;
|
||||||
|
install_apache;
|
||||||
|
download_nagios_webmin_module;
|
||||||
|
download_certbot_module;
|
||||||
|
install_certbot_module;
|
||||||
|
install_nagios_webmin_module;
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue