__netbox*: updated man pages

This commit is contained in:
matze 2020-09-02 07:50:12 +02:00
parent facb5a64d3
commit dbc91cb339
3 changed files with 37 additions and 9 deletions

View file

@ -12,8 +12,12 @@ This (singleton) type installs and configures a NetBox instance, a web
application to help manage and document computer networks. application to help manage and document computer networks.
It installs it with the user ``netbox`` at ``/opt/netbox`` with `python-venv`. It installs it with the user ``netbox`` at ``/opt/netbox`` with `python-venv`.
Netbox will be run via `gnuicorn` as WSGI service. It setup systemd unit files It setup systemd unit files for the services `netbox` and `netbox-rq`. To
for the services `netbox` and `netbox-rq`. access the application through WSGI, uWSGI or Gunicorn can be used. The setup
can be done via there own types `__netbox_gunicorn` and `__netbox_uwsgi`.
The Gunicorn setup is recommended from the NetBox documentation. Consult each
manual page to decide. The types must be called after the `__netbox` type.
REQUIRED PARAMETERS REQUIRED PARAMETERS
@ -36,6 +40,7 @@ host
Hostname (domain or IP address) on which the application is served. Hostname (domain or IP address) on which the application is served.
Multiple hostnames are possible; given as multiple arguments. Multiple hostnames are possible; given as multiple arguments.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
secret-key secret-key
@ -147,6 +152,7 @@ scripts-root
needed. By default, it will be stored into the installation directory needed. By default, it will be stored into the installation directory
(``/opt/netbox/netbox/netbox/scripts``). (``/opt/netbox/netbox/netbox/scripts``).
BOOLEAN PARAMETERS BOOLEAN PARAMETERS
------------------ ------------------
redis-ssl redis-ssl
@ -171,6 +177,7 @@ update-notify
Enables the NetBox version check for new upstream updates. It checks every Enables the NetBox version check for new upstream updates. It checks every
24 hours for new releases and notify the admin users in the gui if any. 24 hours for new releases and notify the admin users in the gui if any.
MESSAGES MESSAGES
-------- --------
installed $VERSION installed $VERSION
@ -199,6 +206,8 @@ EXAMPLES
--ldap-group-base "ou=groups,dc=domain,dc=tld" \ --ldap-group-base "ou=groups,dc=domain,dc=tld" \
--ldap-require-group "cn=netbox-login,ou=groups,dc=domain,dc=tld" \ --ldap-require-group "cn=netbox-login,ou=groups,dc=domain,dc=tld" \
--ldap-superuser-group "cn=netbox-admin,ou=groups,dc=domain,dc=tld" --ldap-superuser-group "cn=netbox-admin,ou=groups,dc=domain,dc=tld"
# using recommended gunicorn setup
require="__netbox" __netbox_gunicorn
NOTES NOTES
@ -216,9 +225,14 @@ If you not setup ldap authentification, you may be interested into how to
<https://netbox.readthedocs.io/en/stable/installation/3-netbox/#create-a-super-user>` <https://netbox.readthedocs.io/en/stable/installation/3-netbox/#create-a-super-user>`
directly on the machine to be able to access and use NetBox. directly on the machine to be able to access and use NetBox.
SEE ALSO SEE ALSO
-------- --------
- `NetBox documentation <https://netbox.readthedocs.io/en/stable/>`_ `NetBox documentation <https://netbox.readthedocs.io/en/stable/>`_
:strong:`cdist-type__netbox_gunicorn`\ (7)
:strong:`cdist-type__netbox_uwsgi`\ (7)
AUTHORS AUTHORS
------- -------

View file

@ -3,12 +3,16 @@ cdist-type__netbox_uwsgi(7)
NAME NAME
---- ----
cdist-type__netbox_gunicorn - run netbox with gunicorn cdist-type__netbox_gunicorn - Run NetBox with Gunicorn
DESCRIPTION DESCRIPTION
----------- -----------
This space intentionally left blank. This (singleton) type installs Gunicorn into the NetBox `python-venv` to host
the NetBox WSGI application. It provides the application as HTTP over the given
sockets. Static content must be served independent of Gunicorn. The Gunicorn
daemon is available as the `gunicorn-netbox` systemd service, but also
available via the `netbox` wrapper service.
REQUIRED PARAMETERS REQUIRED PARAMETERS
@ -58,7 +62,10 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
:strong:`__netbox`\ (7) `Gunicorn Documentation <https://docs.gunicorn.org/en/stable/>`_
:strong:`cdist-type__netbox`\ (7)
:strong:`cdist-type__netbox_uwsgi`\ (7)
AUTHORS AUTHORS

View file

@ -3,12 +3,16 @@ cdist-type__netbox_uwsgi(7)
NAME NAME
---- ----
cdist-type__netbox_uwsgi - run netbox with uwsgi cdist-type__netbox_uwsgi - Run NetBox with uWSGI
DESCRIPTION DESCRIPTION
----------- -----------
This space intentionally left blank. This (singleton) type installs uWSGI into the NetBox `python-venv`. It hosts
the NetBox WSGI application over the WSGI protocol. A further server must be
installed to provide it as HTTP. This application is available via the
`uwsgi-netbox` systemd service. It is controllable via the `netbox` wrapper
service, too.
REQUIRED PARAMETERS REQUIRED PARAMETERS
@ -58,7 +62,10 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
:strong:`TODO`\ (7) `uWSGI Documentation <https://uwsgi-docs.readthedocs.io/en/latest/>`_
:strong:`cdist-type__netbox`\ (7)
:strong:`cdist-type__netbox_gunicorn`\ (7)
AUTHORS AUTHORS