Code Monkey home page Code Monkey logo

netxms-doc's Introduction

Documentation project for NetXMS

Components:

  • concept/ - System concept, architecture, and terminology.
  • admin/ - In-depth administrator guide.
  • developer/ - Describes development process and possible ways of extending NetXMS.
  • manpages/ - UNIX man pages.

Notes

Local setup

  • mkvirtualenv sphinx
  • workon sphinx
  • pip install -r requirements.txt

Ubuntu/Mint

  • apt install python3-pip python3-virtualenv latexmk texlive-latex-extra git
  • git clone https://github.com/netxms/netxms-doc
  • cd netxms-doc
  • python3 -m virtualenv .
  • . bin/activate # activate virtualenv
  • pip install -r requirements.txt

macOS specific

  • brew cask install basictex
  • sudo tlmgr update --self
  • sudo tlmgr install latexmk fncychap titlesec tabulary varwidth framed wrapfig capt-of needspace helvetic courier letltxmacro tex-gyre

Automatic rebuild and reload

  • cd admin && sphinx-autobuild . _build_html

Building translated version:

  • make gettext
  • sphinx-intl update -p _build/locale -l ru
  • sphinx-intl build
  • make -e SPHINXOPTS="-D language=ru" html

Useful links

http://sphinx-doc.org/markup/para.html http://sphinx-doc.org/markup/inline.html http://sphinx-doc.org/markup/

netxms-doc's People

Contributors

2128506 avatar alkk avatar dmarteenez avatar filippsudanov avatar johnvanaltvorst avatar pevot avatar zev333 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

netxms-doc's Issues

[admin/installation.rst] addition of community supported installation within Docker

Hi!

Since I have picked up and began maintaining Dockerfiles for this project, am I able to PR instructions for deployment within Docker.

I understand that official NetXMS may not be willing to support this deployment method, in this case, I can add explicit wording that the method is community supported and issues should be raised at the repository for the Dockerfiles.

Thanks,
Matt

ICMP documentation not updated / missing

image

Documentation is not updated (or entirely missing) on the new ICMP features.

What is the "response statistics collection"?
What are the "additional poll targets"?

Is this pulled during Status poll? Is the server pulling this?
How do I access the polled data?

How does this relate to Agent-based ping.nsm polling?
What should this be used as opposed to ping.nsm?

Wrong path ?

I am new user of netxms, and have trouble with installation netxms-server on linux ubuntu 20.04 LTS

File https://github.com/netxms/netxms-doc/blob/master/admin/installation.rst says:
Database initialization command: /usr/local/bin/nxdbmgr init

but real path is /usr/bin/nxdbmgr

Also :command:apt-get install DRIVER_NAME

Change DRIVER_NAME to driver name that you need:
netxms-dbdrv-mysql - MySQL driver

but exist driver only mariadb

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.