Commit Graph

302 Commits

Author SHA1 Message Date
Michael Friedrich f7a8f72794 Add documentation for user group authentication (groups.ini)
This commit also enhances the external backend with the missing
`strip_username_regex` attribute.

fixes #2974
2017-09-29 11:01:45 +02:00
Michael Friedrich 4259a2cbe7 Add documentation for MySQL SSL options as database resource
fixes #2975
2017-09-29 11:01:45 +02:00
Michael Friedrich 34bd8e14c3 Enhance the documentation and fix outdated information (preferences, etc.)
This applies a new structure for the main doc/ and modules/*/doc tree with

01-About.md
02-Installation.md
...

This allows us to link from the main doc directory into module specific
documentation entries.

Furthermore table formatting, examples, and missing settings have been added
where applicable.

This patch also takes care about proper URL anchors and file names and directories.

fixes #2950
2017-09-29 11:01:37 +02:00
Michael Friedrich ab364e0fc7 Remove unsupported livestatus functionality
Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>
2017-09-29 10:33:55 +02:00
Michael Friedrich 03b5e69d9d Docs: Add global URL parameters to advanced topics
fixes #2190
fixes #2447
2017-09-21 10:21:34 +02:00
Michael Friedrich 8d2e22a738 Merge pull request #2947 from rhopfer/fix/doc-install-centos-selinux
Add note about SELinux to CentOS install doc
2017-09-13 11:41:02 +02:00
Roland Hopferwieser 63ad7817d2 Add note about SELinux to CentOS install doc 2017-09-13 11:32:56 +02:00
Michael Friedrich b20fc1c464 Docs: Add an example for Apache VHost configuration into Advanced Topics 2017-09-08 13:13:45 +02:00
Michael Friedrich 661014747d Docs: Split installation into basic; create advanced topics, upgrading, troubleshooting 2017-08-11 15:30:28 +02:00
Michael Friedrich 9e6e39f795 Docs: Add required database/user details for Debian and web setup
refs #2909
2017-08-11 15:30:22 +02:00
Markus Frosch 6e61f0f17d doc: Update Icinga repository release rpm location 2017-08-04 16:37:57 +02:00
Michael Friedrich 9a3d71f379 Fix Debian Stretch description 2017-08-04 09:33:58 +02:00
Michael Friedrich f9c5f91831 Docs: Update to Debian stretch & use icinga-rpm-release
Further add a note about EPEL setup how it is done in Icinga 2.
Minor formatting and wording.
2017-08-03 19:30:40 +02:00
Hector Sanjuan 0e480dd54a Doc: Add automating Web 2 installation section
Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>

Closes #37
2017-07-28 10:17:03 +02:00
Blerim Sheqa 75516526b5 Update docs for better compatibility with mkdocs
* Move HTML links (<a>...</a>) to the end of the header lines
  * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC
  * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-14 16:33:05 +02:00
Eric Lippmann 686d022987 Merge pull request #2863 from Icinga/feature/domain-support-for-authn-authz-2153 2017-06-21 13:16:36 +02:00
Alexander A. Klimov 6668556e50 Document domain-aware authentication
refs #2153
2017-06-19 09:37:17 +02:00
Francesco Colista e267aeb655 doc: Add install instructions for Alpine Linux
Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>
2017-06-02 09:50:52 +02:00
Eric Lippmann 68842f00d8 Fix version 2017-05-03 15:12:07 +02:00
Eric Lippmann 96a0476ebb Merge pull request #2791 from dlorych/patch-1
Update 02-Installation.md
2017-03-28 09:13:47 +02:00
Pavlos Daoglou 963623bda1 Update file path of icingaweb2 mysql schema for the manual installation procedure 2017-03-21 14:22:29 +02:00
Daniel 3effe41fdb Update 02-Installation.md
PDF export has a dependency on PHP's *mbstring* library.
2017-03-14 13:57:41 +01:00
Christoph Wiechert 87b92c3a77 Doc: Add charset hint 2017-01-30 15:37:16 +01:00
Michael Friedrich 08a82daea3 Update to icinga.com
refs #2687
2017-01-18 12:04:43 +01:00
Eric Lippmann eed1d7ab68 Merge branch 'feature/selinux-8270'
resolves #8270
2016-12-13 12:31:51 +01:00
Eric Lippmann 43d5b01a22 doc: Add note about upgrading to version 2.4.0 2016-12-13 11:58:22 +01:00
Eric Lippmann de94749502 Note that its possible to provide multiple LDAP hosts separated by a space
fixes #11809
2016-12-12 16:42:56 +01:00
Dirk Goetz e6cce08376 Add SELinux policy
Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>

refs #8270
2016-12-12 12:48:33 +01:00
Eric Lippmann 25d37b9a70 doc: Mention default time zone for PHP as requirement 2016-12-11 17:24:04 +01:00
Ian Shearin cee86d1a8c Fix links in about doc
Without this change, the links in the about doc are broken.

Signed-off-by: Eric Lippmann <eric.lippmann@icinga.com>
2016-11-03 16:27:07 +01:00
Eric Lippmann e4695b6937 Doc: Mention PHP cURL extension requirement for using the Icinga 2 API
refs #11398
2016-10-13 12:08:40 +02:00
Eric Lippmann a5da4afb5c doc: Mention FreeBSD and Gentoo packages 2016-09-05 11:26:19 +02:00
Eric Lippmann c09c96677c Update 02-Installation.md 2016-09-05 11:00:53 +02:00
Eric Lippmann c322077aed Fix code block related syntax issues in markdown files 2016-09-01 14:32:23 +02:00
Eric Lippmann 2d32f4a3be Fix markdown table syntax 2016-09-01 14:32:23 +02:00
Heike Jurzik cbf55ffbf1 Fix some syntax bugs in markdown files
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2016-09-01 14:32:20 +02:00
Chris Reeves 8e40d3cc25 doc: document 'encryption' directive for LDAP
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2016-09-01 11:33:55 +02:00
Eric Lippmann 3398453293 doc: Update upgrading section 2016-04-18 01:13:04 +02:00
Eric Lippmann 0fdd02e0d2 Add version 2.3.0 upgrading note 2016-04-13 13:47:11 +02:00
Eric Lippmann ffd5a56ded Fix doc links 2016-04-13 13:43:39 +02:00
Michael Friedrich e298ee8e3d Docs: Fix global permission table formatting
'<' and '>' must be escaped using html-tags in tables.

refs #11568
2016-04-11 16:43:38 +02:00
Eric Lippmann aefb5cfe08 doc: Remove external_authentication.md
fixes #9386
2016-03-30 16:03:53 +02:00
Eric Lippmann fde78cdeb8 doc: Improve order of chapters
refs #9386
2016-03-30 15:40:56 +02:00
Eric Lippmann c5aab53745 Add upgrading note about the changed Authentication and Authorization menu entries
refs #10309
2016-02-27 15:27:59 +01:00
Joe Doherty 358b20cec3 doc: Fix backports misspelling
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2016-02-23 16:09:12 +01:00
Eric Lippmann 6aab5d889e doc: Remove livestatus from the requirements and leave note about the IDO table_prefix
refs #10408
2016-02-17 15:26:52 +01:00
Eric Lippmann cdf9b50910 doc: Mention PageSpeed module incompatibility
refs #10102
2016-02-16 00:25:35 +01:00
Alexander A. Klimov 8a7b840369 Doc: mention what users eventually have to do while upgrading to v2.1.3
refs #11142
2016-02-11 16:33:43 +01:00
Alexander A. Klimov 5a8c430aa5 Doc: mention that LDAP user group backends respect the config option group_filter since v2.1.3
refs #11142
2016-02-11 16:14:19 +01:00
Eric Lippmann ce705e5926 Add general upgrading note for 2.1.x 2015-12-23 14:24:06 +01:00
Eric Lippmann 77a4cfb431 Add upgrading note 2015-12-22 14:33:28 +01:00
Eric Lippmann 23da8e95a6 Add upgrading note 2015-11-16 15:38:10 +01:00
Thomas Gelf 210053462e doc/installation.md: fix rendering issues
Code prefixed with # was interpreted as a chapter. We should fix that
issue, this is only a quickfix
2015-11-13 09:33:32 +01:00
Benedikt Heine 7b37a0872e Escape < and > to avoid false tags
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-11-09 09:55:35 +01:00
Eric Lippmann c14d33d1e8 Revert "doc: Fix upgrade documentation for 2.0.0"
This reverts commit 20e010bea0.

There's a pending PR on GitHub.
2015-11-09 09:55:17 +01:00
Johannes Meyer 20e010bea0 doc: Fix upgrade documentation for 2.0.0 2015-10-22 09:44:02 +02:00
Eric Lippmann 5fa423cf03 Merge branch 'feature/vagrant-parallels-10167'
resolves #10167
2015-10-02 14:13:16 +02:00
Michael Friedrich c3b5d8ab51 Doc: Fix typo
refs #7153
2015-10-02 10:36:39 +02:00
Michael Friedrich ded631b589 Document example commands for installing from source
That also adds all the details we use for automated deployments
and manual installations (e.g. mysql db setup, user creation, manual
config files).

Maybe this could be split into installation-from-source.md
somewhere in the future, but for now it should help anyone
out there to deploy Icinga Web 2 w/o running the setup wizard
in automated environments.

fixes #8407
refs #9595
refs #7153
2015-10-02 09:50:52 +02:00
Michael Friedrich f077f45b20 Fix wrong anchor 2015-10-02 09:50:52 +02:00
Michael Friedrich 73dfb286f5 Move upgrading to a dedicated section and add a link
refs #7153
2015-10-02 09:50:52 +02:00
Michael Friedrich 48bee8d8fd Doc: Restart the webserver after changing group membership
refs #7153
fixes #9484
2015-10-02 09:50:51 +02:00
Eric Lippmann 2d38eb1650 Document that it's possible to use unix domain sockets for MySQL and PostgreSQL connections
fixes #9787
2015-09-28 16:29:01 +02:00
Michael Friedrich 3a549edd38 Vagrant: Prefer Parallels over VirtualBox
Having both installed on OSX, one should prefer Parallels.
Vagrant uses the first one provided working.

refs #10167
2015-09-18 10:48:21 +02:00
Johannes Meyer 1d6ad6df21 Merge branch 'master' into feature/custom-menu-items-5600
Conflicts:
	modules/monitoring/configuration.php
2015-09-15 13:31:30 +02:00
Johannes Meyer 274a0c8a09 Store a user's preferences in a dedicated directory rather than in a single file
refs #5600
2015-09-07 11:20:36 +02:00
bradynathan 029aeda164 Document filter option for LDAP/AD auth
refs #9612

Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-09-01 23:17:03 +02:00
Alexander Wirt a331b04157 doc: Don't suggest to install icingacli on Debian
On Debian icingacli is part of the icingaweb2 package.

fixes #9837

Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-09-01 23:10:35 +02:00
Johannes Meyer 2829ecc8b7 Document that the instances.ini has been renamed
refs #9651
2015-08-27 15:34:09 +02:00
Johannes Meyer 6063eea34f doc: Suggest the correct backend identifier for ActiveDirectory
fixes #9959
2015-08-19 09:23:29 +02:00
Eric Lippmann de29d66005 doc/security: Add note about module permissions
refs #9644
2015-07-27 15:07:43 +02:00
Eric Lippmann ec5bebea95 doc/installation: Add upgrading note about module permissions
refs #9644
2015-07-27 11:30:44 +02:00
Eric Lippmann 764c67cc66 Document that RHEL/CentOS 5 is not supported 2015-07-02 17:24:12 +02:00
Eric Lippmann ea6e1fa415 Document RHEL/CentOS 7 Zend dependency change 2015-07-02 17:24:11 +02:00
Eric Lippmann ea5e449076 Note that the wheezy-packports repository is required for installing Web 2 on Debian wheezy
refs #9140
refs #9163
2015-07-02 17:24:11 +02:00
Matthias Jentsch bb0ed20200 Assure to install icingacli in installation doc
Make sure that icingacli is installed when following the instructions in installation.md, since those commands are needed by later instructions.
2015-06-22 12:03:56 +02:00
Johannes Meyer 664d6ea513 Provide database upgrade scripts for rc1 2015-06-18 17:20:06 +02:00
Johannes Meyer cf2c2c3ee0 security documentation: Cleanup permission lists 2015-06-18 15:55:58 +02:00
Johannes Meyer 82ed9efd91 Add instructions on how to upgrade to rc1 2015-06-18 15:48:23 +02:00
Johannes Meyer 22feb08f44 monitoring: Update security documentation 2015-06-18 15:48:01 +02:00
Matthias Jentsch 42de13a2b9 Merge branch 'feature/ssh-remote-connection-resource-configuration-7595'
resolves #7595
2015-06-15 17:30:42 +02:00
Matthias Jentsch 1637f4760f Fix table formatting
refs #7595
2015-06-15 17:23:52 +02:00
Matthias Jentsch ea85254cc5 Fix typos and formatting in documentation
refs #9377
2015-06-15 11:09:41 +02:00
Matthias Jentsch 6e28a58739 Fix drawing in doc
refs #9377
2015-06-10 19:06:59 +02:00
Matthias Jentsch 3eb4561f79 Merge branch 'feature/permission-restriction-documentation-9377'
fixes #9377
2015-06-10 19:04:47 +02:00
Matthias Jentsch 4a591db438 Fix a few typos
refs #9377
2015-06-10 19:01:33 +02:00
Matthias Jentsch edd1c2a1f3 Move monitoring permission documentation into a separate module
refs #9377
2015-06-10 18:43:54 +02:00
Matthias Jentsch 6f208e90b5 Improve restriction and filter sections
Add more examples and fix a few typos and minor issues in the doc.

refs #9377
2015-06-09 18:10:02 +02:00
Alexander A. Klimov 7cf0b82b63 doc/about.md: typos and grammar
refs #9379
2015-06-09 17:04:02 +02:00
Alexander A. Klimov 85b3eaa2e3 Add introduction to section `Authorization'
refs #9379
2015-06-09 16:49:44 +02:00
Matthias Jentsch 10592bb7c8 Add documentation for security configuration
Add a doc page to explain configuring user and group permissions and general user and group handling.

refs #9377
2015-06-09 16:09:36 +02:00
Alexander A. Klimov b8debcd257 Add introduction to section `User preferences'
refs #9379
2015-06-09 15:52:44 +02:00
Alexander A. Klimov ee7c91235a Add introduction to section `Authentication'
refs #9379
2015-06-09 15:14:27 +02:00
Alexander A. Klimov 260a33c88b Add introduction to section `Configuration'
refs #9379
2015-06-09 14:54:50 +02:00
Alexander A. Klimov 5412c6d972 doc/about.md: add section `The monitoring module'
refs #9379
2015-06-09 14:23:43 +02:00
Alexander A. Klimov 922bbad476 doc/about.md: add introduction
refs #9379
2015-06-09 14:19:48 +02:00
Alexander A. Klimov d9f68578eb Add doc/about.md
refs #9379
2015-06-08 17:43:12 +02:00
Michael Friedrich cf95994ff5 Documentation: Add config overview as first draft
refs #7153
2015-06-01 19:16:35 +02:00
Alexander Fuhr f3a37e9575 Update documentation for resources and instances
I've just only renamed the identity_key to the private_key thats it

refs #7595
2015-05-28 14:15:01 +02:00
Alexander Fuhr 8dc79a388a Update resource documentation with the ssh resource configuration
refs #7595
2015-05-28 10:42:18 +02:00