Commit Graph

362 Commits

Author SHA1 Message Date
Rudy Gevaert 83d5d9ee29
Correct documentation about icingacli
icingacli is its own package on Debian and Ubuntu too.
2017-12-03 15:26:51 +01:00
Eric Lippmann 350a3db7bf FPM Doc: Distinct instructions for Apache versions 2017-11-29 14:32:30 +01:00
Eric Lippmann d2e4967800 Document PHP version requirement 2017-11-27 15:58:58 +01:00
lippserd c687bf44e3
Merge pull request #3135 from kirjastojk/fix/wrong-config-generation-command
doc: Use correct command for configuration generation
2017-11-27 13:39:37 +01:00
Markus Frosch 6f8103bee8 doc: Add installation notes for web server 2017-11-24 17:37:11 +01:00
Joonas Kylmälä 9d4a85c753 doc: Use correct command for configuration generation
The command 'icingacli setup config directory' actually produces the
configuration files for Icinga Web 2 instead of the command 'icingacli
setup config webserver'.
2017-11-23 13:25:14 +02:00
Markus Frosch e80ce765f0 Documentation update for 2.5.0
Including:

* FPM migration on EPEL
* Package deprecation
* SUSE PHP upgrade
2017-11-17 11:37:39 +01:00
Simone Orsi c99fd34ed0
Update installation step for Ubuntu
Install `icingacli` to avoid `The program 'icingacli' is currently not installed. You can install...`
2017-11-05 21:47:13 +01:00
Eric Lippmann 88074aeb74 Document php-xml dependency
refs #3030
2017-10-20 09:01:03 +02:00
lippserd 773dae3750 Merge pull request #2978 from Icinga/fix/drop-livestatus
Remove unsupported livestatus functionality
2017-09-29 11:15:54 +02:00
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
Eric Lippmann 20a9621036 doc: Add filenames to anchor links
This allows other markdown viewers like to follow those links.
2015-05-22 15:30:37 +02:00
rkcpi 394c627397 Update links to resources.md in authentication.md
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-05-22 14:23:10 +02:00
Daniel Shirley 75f15b934c Update authentication.md
Typo for database config

Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-05-22 14:17:45 +02:00
Johannes Meyer f11ea04557 Revert "Require `host_name' instead of `host' to show or list particular objects"
This reverts commit b93d18a0fc.
2015-04-20 16:11:22 +02:00
Tim Helfensdörfer 3015028f5d Remove quotation marks in password example
Otherwise the quotation marks are included in the password.

Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-04-16 14:04:10 +02:00
Eric Lippmann 36726560dd Document how to install Icinga Web 2 from Package 2015-04-16 13:59:53 +02:00
Johannes Meyer b93d18a0fc Require `host_name' instead of `host' to show or list particular objects
`host' implies that it is possible to provide case-less identifiers which is
*not* possible.

refs #8613
2015-04-08 16:25:29 +02:00
Eric Lippmann ec60f15f09 Leave note about Upgrading to Icinga Web 2 Beta 3 2015-03-13 17:22:49 +01:00
Johannes Meyer a9d767867d WCAG/2.4.4: Add example for link contexts
refs #8458
2015-02-17 14:02:35 +01:00
Johannes Meyer 97f5018247 WCAG/1.1.1: Fix example for accessible icon fonts to work with NVDA too
refs #8358
2015-02-16 10:23:54 +01:00
Marius Hein 09349288e1 Merge branch 'master' into feature/skip-content-7933 2015-02-12 13:14:56 +01:00
Marius Hein 63ed236434 Add tabindex to skip links
Opera needs a tabindex also for anchor elements

refs #7933
2015-02-12 11:34:12 +01:00
baufrecht a520abe65d Fix usermod for Ubuntu/Debian
Set correct group for Ubuntu/Debian

Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2015-02-12 11:09:46 +01:00
Johannes Meyer 60ec115779 WCAG/1.4.1: Fix example for text cues on a form's required elements
The input element must be wrapped by <label> either or the <label> tag
needs a "for=id" attribute with the id of the respective input.

refs #7934
2015-02-12 09:09:18 +01:00
Eric Lippmann 54292eed20 Merge branch 'master' into feature/doc-search-6630 2015-02-11 13:28:06 +01:00
Marius Hein 278591fbd2 Accessibility: Prototype for skip links 2015-02-11 10:35:12 +01:00
Eric Lippmann 8ad7a30cd7 doc: Fix link to resources in the authentication doc 2015-02-10 17:02:17 +01:00
Michael Friedrich 23ce156681 doc/installation: Add a note where to store the webserver's config 2015-02-07 21:15:26 +01:00
Alexander Klimov 58d48d9fa0 Accessibility: Text cue for required form control labels: Add prototype
refs #7934
2015-02-06 17:50:34 +01:00
Johannes Meyer 707d977cfc WCAG/3.3.3: Add example for required form elements
refs #8349
2015-02-05 13:14:29 +01:00
Eric Lippmann d8c40d40a0 WCAG/1.1.1: Add example for accessible SVGs
refs #8364
2015-02-05 10:16:50 +01:00
Johannes Meyer e315d8c358 Clarify external authentication documentation
It's necessary to enable the HTTPDigestAuthentication module
and to restart the webserver..
2015-02-05 09:15:25 +01:00
Eric Lippmann 5014b5dc46 Fix usermod for SUSE and SLES
fixes #8359
2015-02-04 17:23:07 +01:00
Eric Lippmann 04357d21b6 WCAG/1.1.1: Add example for screen reader muted icon
refs #8360
2015-02-04 16:40:33 +01:00
Eric Lippmann cef9a5c1a2 WCAG/1.1.1: Add example for accessible icon fonts
refs #8358
2015-02-04 16:15:30 +01:00
Eric Lippmann 3b30821ee9 doc: Note that external replaced autologin and not storing preferences means none 2015-02-04 09:22:27 +01:00
Eric Lippmann 2fe3f4c6c2 doc: Add "Upgrading to Icinga Web 2 Beta 2" 2015-02-03 16:52:36 +01:00
Johannes Meyer 7989b48248 Fix ldap auth when the userNameAttribute holds multiple values
fixes #8246
2015-02-03 10:15:54 +01:00
Johannes Meyer 400fbccbb8 Add setup route to the installation documentation
refs #7848
2015-01-28 17:59:43 +01:00
Johannes Meyer 8383320f31 Update documentation covering external authentication
refs #8274
2015-01-28 17:52:17 +01:00
Johannes Meyer 50fc85d7ff Rename authentication type "autologin" to "external"
refs #8274
2015-01-27 09:49:36 +01:00
Eric Lippmann db9e2fe4ca doc/vagrant: Fix version requirement 2015-01-22 11:06:05 +01:00
Eric Lippmann 9cecc4d690 doc: Add vagrant.md 2015-01-20 15:13:33 +01:00
Eric Lippmann b8288b28a7 doc/installation: Add PHP gettext and PHP OpenSSL support as requirement 2015-01-14 14:14:44 +01:00
Eric Lippmann 4971037b37 doc/installation: Add section Preparing Web Setup 2015-01-14 13:24:04 +01:00
Eric Lippmann e2667dfb63 doc: Use icingaweb2 as directory instead of icingaweb 2015-01-13 13:08:09 +01:00
root a48adb5e4b doc: Fix typo in installation.md
Signed-off-by: Eric Lippmann <eric.lippmann@netways.de>
2014-12-29 12:28:14 +01:00
Eric Lippmann 0bcda60dab doc: Remove developer information from preferences.md 2014-12-18 15:40:26 +01:00
Eric Lippmann 53179981d6 doc: Add section 'Database Setup' to authentication.md
fixes #7672
2014-12-18 15:37:08 +01:00
Eric Lippmann b3994f1099 doc: Add chapter IDs to authentication.md 2014-12-18 15:24:06 +01:00