Ready for review
Convert the Debian/Ubuntu (.DEB) installation documentation into the new tree
Converts Installation using Debian/Ubuntu (.DEB) packages into documentation.xs.admin.installation.methods.install-xwiki-debian, a new subtree beside install-xwiki-war and install-xwiki-docker. The new tree had no Debian page at all, while three of its pages already linked the legacy one. Deploy XWiki as the Root Web Application even has an FAQ entry deferring the Debian procedure to a page that did not exist.
Eight new pages: the hub How-to with the installation procedure, a Reference for the repository channels and the packages, a Reference for the files the packages install, and How-tos for the root web application, a standalone Solr server, the systemd file-access restriction and uninstalling, plus an Explanation for troubleshooting.
Five facts on the legacy page were measured wrong or stale and are corrected, not carried over:
- The lts-latest repository it advertises, https:~/~/maven.xwiki.org/lts/xwiki-lts-latest.list, answers 404. The live one is https:~/~/maven.xwiki.org/recommended/xwiki-lts-latest.list: only the link's href was right, its visible label was not.
- The warning that the database password must contain no special character is obsolete: XWIKI-14406 is Closed/Fixed in 18.5.0, 18.4.2 and 17.10.10, so it is false for every supported version.
- xwiki-solr9-extension_index was renamed xwiki-solr9-extension-index; the underscore package stopped at 16.8.0.
- The Solr 8 xwiki-solr-* packages stopped at 16.1.0 and the xwiki-tomcat7/8/9-* ones at 17.0.0, so only Tomcat 10 and 11 and Solr 9 are documented.
- The Java requirement was understated; the pages now defer to the Java Support Strategy instead of freezing a pair of numbers.
The package list was checked against http:~/~/maven.xwiki.org/stable/Packages, and the systemd sandbox, the Solr core names and the office-server properties against the sources in xwiki-platform.
Also fixed while converting: the Jetty root-webapp instruction, which the legacy page stated four times (twice inside {{version}} macros, once bare and once as leftover data-xwikiorg-versions paragraphs) plus a stray verbatim block, now appears once; the five How-tos each end on a result step, which no legacy procedure had.
Dropped as already covered: the LibreOffice section. Connect to an Internal Office Server owns the procedure, Office Server Properties already gives /usr/lib/libreoffice for Linux, and the new Files page carries the rule that a Debian installation configures XWiki through /etc/xwiki/xwiki.properties. The hub links that page instead.
Legacy pages: the original keeps all 35 of its headings, verbatim and in order, each with a pointer, so bookmarked anchors still resolve; it has no attachments. Documentation.AdminGuide.InstallationViaAPT, which is a redirect object rather than a page, is re-aimed at the new hub. Five backlinks are repointed (Prerequisites, Deploy XWiki as the Root Web Application, Java Memory for Tomcat, Upgrade XWiki Installed from the Debian Packages, Installation Methods) along with three old-tree pages; the dated release note, the proposals, the IRC archives and the feedback archive are left alone as historical records, and the extensions-wiki backlink needs its own Change Request since one cannot span two wikis.{{/version}}
macros, once bare and once as leftover data-xwikiorg-versions paragraphs) plus a stray verbatim block, now appears once; the five How-tos each end on a result step, which no legacy procedure had.
Dropped as already covered: the LibreOffice section. Connect to an Internal Office Server owns the procedure, Office Server Properties already gives /usr/lib/libreoffice for Linux, and the new Files page carries the rule that a Debian installation configures XWiki through /etc/xwiki/xwiki.properties. The hub links that page instead.
Legacy pages: the original keeps all 35 of its headings, verbatim and in order, each with a pointer, so bookmarked anchors still resolve; it has no attachments. Documentation.AdminGuide.InstallationViaAPT, which is a redirect object rather than a page, is re-aimed at the new hub. Five backlinks are repointed (Prerequisites, Deploy XWiki as the Root Web Application, Java Memory for Tomcat, Upgrade XWiki Installed from the Debian Packages, Installation Methods) along with three old-tree pages; the dated release note, the proposals, the IRC archives and the feedback archive are left alone as historical records, and the extensions-wiki backlink needs its own Change Request since one cannot span two wikis.
-
Eleni Cojocariu added a new change for Install XWiki from the Debian Packages
17 hours ago
-
Eleni Cojocariu added a new change for XWiki Debian Repositories and Packages
17 hours ago
-
Eleni Cojocariu added a new change for Files Installed by the Debian Packages
17 hours ago
-
Eleni Cojocariu added a new change for Deploy XWiki as the Root Web Application on Debian
17 hours ago
-
Eleni Cojocariu added a new change for Set Up a Standalone Solr Server on Debian
17 hours ago
-
Eleni Cojocariu added a new change for Allow XWiki to Access Files outside Its Data Directory
17 hours ago
-
Eleni Cojocariu added a new change for Debian Package Troubleshooting
17 hours ago
-
Eleni Cojocariu edited the description or the title of the Change Request
17 hours ago
-
Eleni Cojocariu edited the description or the title of the Change Request
17 hours ago
-
Eleni Cojocariu added a new change for Installation using Debian/Ubuntu (.DEB) packages
17 hours ago
-
Eleni Cojocariu refreshed the changes for Installation using Debian/Ubuntu (.DEB) packages
17 hours ago
-
Eleni Cojocariu added a new change for Installation using Debian/Ubuntu (.DEB) packages
17 hours ago
-
Eleni Cojocariu added a new change for Install XWiki from the Debian Packages
17 hours ago
All changes
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -11,7 +11,7 @@ 11 11 12 12 For production environments, where data persistence, reliability, and performance are required, the following methods are recommended: 13 13 14 -* [[ Using##.deb##package>>Documentation.AdminGuide.InstallationViaAPT]]: Provides a ##.deb## package that can be used on a Debian-based operating system. It can be installed with ##dpkg## or ##apt##; installation is thus automated.14 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]: Provides a ##.deb## package that can be used on a Debian-based operating system. It can be installed with ##dpkg## or ##apt##; installation is thus automated. 15 15 * [[Using an official XWiki Docker image>>https://hub.docker.com/_/xwiki/]]: You can also use this method in production if you're used to putting Docker images in production. 16 16 17 17 You could also manually deploy XWiki as a ##WAR## into the Servlet Container of your choice and on the Database of your choice, if the previous methods were not good enough for your needs. Beware that this requires some technical knowledge about Servlet Container and Databases:
- DocApp.Code.DocumentationClass[0]
-
- Highlights
-
... ... @@ -4,3 +4,5 @@ 4 4 ** This method requires manual deployment of XWiki into a servlet container (such as Tomcat or Jetty) and explicit configuration of an external database. 5 5 * [[Install XWiki using Docker>>documentation.xs.admin.installation.methods.install-xwiki-docker.WebHome]] 6 6 ** Provides an easy solution to test XWiki, without manually installing or configuring a servlet container. 7 +* [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]] 8 +** Installs XWiki, its servlet container, its database and its Java runtime from the packages of a Debian-based distribution.
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -14,9 +14,9 @@ 14 14 * [[Docker Engine>>https://docs.docker.com/engine/]] installed on the host system. 15 15 * No Java installation or external database is required for testing purposes. 16 16 ))) 17 -|(% rowspan="3" %)Production|[[ Using##.deb##package>>Documentation.AdminGuide.InstallationViaAPT]]|(((17 +|(% rowspan="3" %)Production|[[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]|((( 18 18 * A [[Debian-based Linux>>https://wiki.debian.org/]] distribution 19 -* Depending on the [[##.deb## package>> Documentation.AdminGuide.InstallationViaAPT]] you choose, you may need a supported database (any database supporting JDBC 4.2, with a JDBC 4.2 driver) and/or a supported servlet container.(((19 +* Depending on the [[##.deb## package>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]] you choose, you may need a supported database (any database supporting JDBC 4.2, with a JDBC 4.2 driver) and/or a supported servlet container.((( 20 20 * Database: Any database that supports JDBC 4.2 and provides a JDBC 4.2 driver. However, we recommend using one of the [[supported databases>>dev:Community.DatabaseSupportStrategy]]. 21 21 * Servlet Container: Any servlet container that supports Servlet 5.0. However, we recommend using one of the [[supported servlet containers>>dev:Community.ServletContainerSupportStrategy.WebHome]]. 22 22 )))
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Install XWiki from the Debian Packages - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,36 @@ 1 +The Debian packages install XWiki together with the servlet container, the database and the Java runtime it needs, on any Debian-based distribution, where the other [[installation methods>>doc:documentation.xs.admin.installation.methods.WebHome]] leave those to you. 2 + 3 +1. Register XWiki's APT repository and the key its packages are signed with. The list file names the release channel, ##stable## here, among the [[four the repository offers>>doc:.packages.WebHome]].((( 4 +{{code language="bash"}} 5 +sudo wget https://maven.xwiki.org/xwiki-keyring.gpg -O /usr/share/keyrings/xwiki-keyring.gpg 6 +sudo wget "https://maven.xwiki.org/stable/xwiki-stable.list" -O /etc/apt/sources.list.d/xwiki-stable.list 7 +{{/code}} 8 +))) 9 +1. Update the package database so that it reads the new repository.((( 10 +{{code language="bash"}} 11 +sudo apt update 12 +{{/code}} 13 +))) 14 +1. Install the package named after your servlet container and your database, among the [[packages the repository offers>>doc:.packages.WebHome]].((( 15 +{{code language="bash"}} 16 +sudo apt install xwiki-tomcat11-mariadb 17 +{{/code}} 18 +))) 19 +1. Accept dbconfig's offer to configure the database, unless you want to create the ##xwiki## database and user yourself. It asks for a password for the ##xwiki## user, which it then writes into XWiki's configuration, so you do not have to remember it. 20 +1. Raise the memory the servlet container gives XWiki, in the file configuring its daemon, as described in [[Java Memory for Tomcat>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.java-memory.WebHome||anchor="HLinux-specificalternatives"]].((( 21 +{{code language="none"}} 22 +/etc/default/tomcat11 # xwiki-tomcat* packages 23 +/lib/systemd/system/xwiki.service # xwiki-xjetty* packages 24 +{{/code}} 25 +))) 26 +1. Restart the service so that the new memory setting takes effect, and check that it is running. The package enabled it at boot.((( 27 +{{code language="bash"}} 28 +sudo systemctl restart tomcat11 29 +sudo systemctl status tomcat11 30 +{{/code}} 31 +))) 32 +1. Open your wiki in a browser and [[install the flavor with the Distribution Wizard>>doc:documentation.xs.admin.distribution-wizard.install-flavor.WebHome]], which fills the still empty wiki with its Pages.((( 33 +{{code language="none"}} 34 +http://localhost:8080/xwiki 35 +{{/code}} 36 +)))
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,19 @@ 1 +== Which package should I install? == 2 + 3 +The one named after the servlet container and the database you want, such as ##xwiki-tomcat11-mariadb##; [[XWiki Debian Repositories and Packages>>doc:.packages.WebHome]] lists them all, including the ones that leave part of the stack to you. 4 + 5 +== Which Debian and Ubuntu versions does this work on? == 6 + 7 +All Debian-based distributions, as long as they ship a supported servlet container and a supported [[Java version>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]]; on Ubuntu, the Tomcat packages additionally need the [[universe repository>>https://help.ubuntu.com/community/Repositories/CommandLine]], which is enabled by default. 8 + 9 +== Is the password dbconfig asks for the database root password? == 10 + 11 +No. The database root password prompt belongs to the database package and is for its superuser, while dbconfig asks for the password of the ##xwiki## user XWiki connects with, which it then writes into XWiki's configuration for you. 12 + 13 +== Why does XWiki run out of memory on Tomcat? == 14 + 15 +Most Debian distributions ship Tomcat with a heap of 128 MB, which is not enough for XWiki. 16 + 17 +== Can I use an ##xwiki-*-mysql## package against a MariaDB server? == 18 + 19 +No. Install the matching ##xwiki-*-mariadb## package instead, since the two databases need different configurations. - Highlights
-
... ... @@ -1,0 +1,12 @@ 1 +* [[XWiki Debian Repositories and Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.packages.WebHome]] 2 +** The repository channels to choose from, and every package they offer. 3 +* [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]] 4 +** Where the packages put the configuration, the permanent data and the logs. 5 +* [[Debian Package Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]] 6 +** What to do when a package is missing or the wiki does not start. 7 +* [[Deploy XWiki as the Root Web Application on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.deploy-root-webapp.WebHome]] 8 +** Serve the wiki from the root URL instead of ##/xwiki/##. 9 +* [[Set Up a Standalone Solr Server on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.standalone-solr.WebHome]] 10 +** Move the search index out of XWiki into a Solr server of its own. 11 +* [[Uninstall the XWiki Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.uninstall.WebHome]] 12 +** Remove XWiki, and what stays behind when you do. - Related
-
... ... @@ -1,0 +1,9 @@ 1 +* [[Install XWiki .war Package Manually>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.WebHome]]. 2 +* [[Install XWiki using Docker>>doc:documentation.xs.admin.installation.methods.install-xwiki-docker.WebHome]]. 3 +* [[Install a Standalone (Demo) Distribution>>doc:documentation.xs.admin.installation.methods.install-standalone-demo-distribution.WebHome]]. 4 +* [[Prerequisites>>doc:documentation.xs.admin.installation.prerequisites.WebHome]]. 5 +* [[Upgrade XWiki Installed from the Debian Packages>>doc:documentation.xs.admin.upgrade.distribution.upgrade-debian-package.WebHome]]. 6 +* [[Configure Tomcat>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.WebHome]]. 7 +* [[Performance>>doc:documentation.xs.admin.performance.WebHome]]. 8 +* [[Connect to an Internal Office Server>>doc:documentation.xs.admin.exports.office-server-properties.connect-internal-office-server.WebHome]]. 9 +* [[User Forum>>dev:Community.Discuss]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +howto
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en
- DocApp.Code.DocumentationClass[0]
-
- Related
-
... ... @@ -1,2 +1,2 @@ 1 -* [[ InstallationusingDebian/Ubuntu (.DEB) packages>>doc:Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome||anchor="HXWikiasrootwebapp28shortURLs29"]]1 +* [[Deploy XWiki as the Root Web Application on Debian>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.deploy-root-webapp.WebHome]] 2 2 * [[Configure a Servlet Container>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.WebHome]]
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. VincentMassol1 +XWiki.elenicojocariu - Content
-
... ... @@ -1,4 +1,4 @@ 1 -To upgrade an XWiki instance [[installed from the Debian packages>> Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome]]:1 +To upgrade an XWiki instance [[installed from the Debian packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]: 2 2 3 3 1. Back up the database, the [[configuration files and the permanent data>>doc:documentation.xs.admin.backup.backup-instance.WebHome]]. 4 4 1. Check the [[Release Notes>>xwiki:ReleaseNotes.WebHome]] of every version between the one you are running and the one you are upgrading to.
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -4,7 +4,7 @@ 4 4 5 5 == Why does apt refuse to upgrade the xwiki packages? == 6 6 7 -Either a dependency cannot be found, because the new XWiki version requires a [[Java version>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]] that your repository has no package for (see the"No packagecan be found for Java" sectionof [[InstallationusingDebian/Ubuntu (.DEB) packages>>Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome]]), or the package name changed because XWiki dropped support for the servlet container version you were using.7 +Either a dependency cannot be found, because the new XWiki version requires a [[Java version>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]] that your repository has no package for (see [[Debian Package Troubleshooting>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]), or the package name changed because XWiki dropped support for the servlet container version you were using. 8 8 9 9 == What do I do when XWiki drops support for my servlet container? == 10 10 - Related
-
... ... @@ -1,3 +1,3 @@ 1 -* [[Install ationusingDebian/Ubuntu(.DEB) packages>>Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome]].1 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 2 2 * [[Java Support Strategy>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]]. 3 3 * [[Servlet Container Support Strategy>>dev:Community.SupportStrategy.ServletContainerSupportStrategy.WebHome]].
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki Debian Repositories and Packages - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,39 @@ 1 +XWiki publishes its Debian packages in four repositories, each tracking a different release channel. Register the one matching the branch you want to follow, as the first step of [[installing XWiki from the Debian packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 2 + 3 +|=Channel|=List file|=Contains 4 +|Releases|https://maven.xwiki.org/releases/xwiki-releases.list|Every released version, milestones and release candidates included, so the newest versions are unstable. 5 +|Stable|https://maven.xwiki.org/stable/xwiki-stable.list|Released versions excluding milestones and release candidates. 6 +|LTS|https://maven.xwiki.org/lts/xwiki-lts.list|Every released Cycle LTS version. 7 +|Latest LTS|https://maven.xwiki.org/recommended/xwiki-lts-latest.list|The latest LTS version, whether that is the Cycle LTS or the Intermediate LTS. 8 + 9 +The [[Support>>Main.Support]] page says which branches are supported at any moment. 10 + 11 +== Packages == 12 + 13 +A package is named ##xwiki-<servlet container>-<database>##, and the ##-common## packages leave one half of that pair to you. Run ##apt search xwiki## to list what the repository you registered actually offers. 14 + 15 +|=Package|=Servlet container|=Database 16 +|##xwiki-common##|yours|yours 17 +|##xwiki-mariadb-common##, ##xwiki-mysql-common##, ##xwiki-pgsql-common##|yours|MariaDB, MySQL or PostgreSQL 18 +|##xwiki-xjetty-common##|XJetty, the Jetty server XWiki packages itself|yours 19 +|##xwiki-xjetty-mariadb##, ##xwiki-xjetty-mysql##, ##xwiki-xjetty-pgsql##|XJetty|MariaDB, MySQL or PostgreSQL 20 +|##xwiki-tomcat10-common##, ##xwiki-tomcat11-common##|your distribution's Tomcat|yours 21 +|##xwiki-tomcat10-mariadb##, ##xwiki-tomcat10-mysql##, ##xwiki-tomcat10-pgsql##|your distribution's Tomcat 10|MariaDB, MySQL or PostgreSQL 22 +|##xwiki-tomcat11-mariadb##, ##xwiki-tomcat11-mysql##, ##xwiki-tomcat11-pgsql##|your distribution's Tomcat 11|MariaDB, MySQL or PostgreSQL 23 + 24 +The ##xwiki-tomcat*## packages depend on the Tomcat package of your distribution instead of shipping Tomcat themselves, so which of them you can install depends on the Tomcat version your distribution offers. 25 + 26 +== Solr core packages == 27 + 28 +These register XWiki's Solr cores in a Solr server you run yourself, as described in [[Set Up a Standalone Solr Server on Debian>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.standalone-solr.WebHome]]. An XWiki that keeps its embedded Solr needs none of them. 29 + 30 +|=Package|=Registers 31 +|##xwiki-solr9-all##|Every core XWiki Standard needs, by depending on the four below. 32 +|##xwiki-solr9-search##|The core backing the search feature. 33 +|##xwiki-solr9-events##|The core storing events and notifications. 34 +|##xwiki-solr9-ratings##|The core storing ratings. 35 +|##xwiki-solr9-extension-index##|The core indexing extensions. 36 + 37 +== Packages that are no longer built == 38 + 39 +The repository also still carries packages for servlet containers and Solr versions XWiki has stopped supporting, along with the ##xwiki-enterprise-*## packages of the former XWiki Enterprise distribution. None of them receives new versions, and installing one gives you an XWiki that can no longer be upgraded.
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,11 @@ 1 +== Which channel should I register? == 2 + 3 +Stable for a production instance you intend to keep up to date, and one of the two LTS channels when you would rather stay on a long-term-support branch. 4 + 5 +== Why does ##apt## find no package for my version of Tomcat? == 6 + 7 +Either because Ubuntu's [[universe repository>>https://help.ubuntu.com/community/Repositories/CommandLine]], which carries Tomcat, is disabled, or because XWiki builds packages only for the Tomcat versions it supports; in the second case install an ##xwiki-xjetty-*## package, which brings its own server. 8 + 9 +== Can I switch from one channel to another later? == 10 + 11 +Yes, by replacing the list file in ##/etc/apt/sources.list.d/## and running ##sudo apt update##, as long as the version you move to is not older than the one you run. - Related
-
... ... @@ -1,0 +1,4 @@ 1 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 2 +* [[Prerequisites>>doc:documentation.xs.admin.installation.prerequisites.WebHome]]. 3 +* [[Servlet Container Support Strategy>>dev:Community.SupportStrategy.ServletContainerSupportStrategy.WebHome]]. 4 +* [[Database Support Strategy>>dev:Community.SupportStrategy.DatabaseSupportStrategy]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +reference
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Files Installed by the Debian Packages - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,33 @@ 1 +The Debian packages spread an [[XWiki installation>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]] over the directories a Debian system expects, where a ##.war## installation keeps everything under one web application directory. 2 + 3 +== XWiki == 4 + 5 +|=Path|=Holds 6 +|##/etc/xwiki/##|XWiki's configuration: ##hibernate.cfg.xml##, ##xwiki.cfg## and ##xwiki.properties##. 7 +|##/etc/xwiki/xwiki-tomcat<version>.xml##|The Tomcat integration, linked from ##/etc/tomcat<version>/Catalina/localhost/##. 8 +|##/usr/lib/xwiki/##|The web application itself: ##META-INF##, ##resources##, ##skins##, ##templates## and ##WEB-INF##. 9 +|##/var/lib/xwiki/data##|The permanent directory. 10 + 11 +Inside ##/usr/lib/xwiki/WEB-INF##, the files ##hibernate.cfg.xml##, ##xwiki.cfg## and ##xwiki.properties## are symbolic links into ##/etc/xwiki/##. So wherever the rest of the documentation tells you to edit ##xwiki/WEB-INF/xwiki.properties##, edit ##/etc/xwiki/xwiki.properties## instead. 12 + 13 +systemd also restricts which files the running XWiki may read and write, which is covered in [[Allow XWiki to Access Files outside Its Data Directory>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.allow-file-access.WebHome]]. 14 + 15 +== Servlet container == 16 + 17 +|=Path|=Holds 18 +|##/lib/systemd/system/xwiki.service##|XJetty only: the ##xwiki## service definition, and the Java startup options you customize. 19 +|##/etc/systemd/system/tomcat<version>.service.d/xwiki-tomcat<version>-systemd.conf##|Tomcat only: the systemd settings the XWiki package adds to the Tomcat service. 20 +|##/etc/tomcat<version>/##|Tomcat only: ##context.xml##, ##logging.properties##, ##server.xml##, ##tomcat-users.xml## and ##web.xml##. 21 +|##/etc/default/tomcat<version>##|Tomcat only: the configuration of the Tomcat daemon, memory settings included. Every change needs a restart. 22 +|##/var/lib/tomcat<version>/##|Tomcat only: ##common##, ##server##, ##shared## and ##webapps##, plus ##conf## and ##logs## linked to the directories below ##/etc## and ##/var/log##. 23 + 24 +XWiki's own log files, and the systemd journal that replaces them on recent distributions, are covered in [[Debian Package Troubleshooting>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]. 25 + 26 +== Database == 27 + 28 +|=Path|=Holds 29 +|##/etc/mysql/##|MariaDB and MySQL: ##debian.cnf## and ##my.cnf##, where ##max_allowed_packet## caps the size of an attachment upload. 30 +|##/var/lib/mysql/xwiki/##|MariaDB and MySQL: the XWiki database itself. 31 +|##/var/log/mysql/error.log##|MariaDB and MySQL: the database error log. The service also writes to ##/var/log/syslog##. 32 +|##/etc/postgresql/<version>/main/##|PostgreSQL: ##postgresql.conf## and ##pg_hba.conf##. 33 +|##/var/lib/postgresql/<version>/main/##|PostgreSQL: the data directory, starting with ##base##.
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,7 @@ 1 +== Which of these do I back up? == 2 + 3 +The database, the configuration in ##/etc/xwiki/## and the permanent directory ##/var/lib/xwiki/data##, as described in [[Back Up an XWiki Instance>>doc:documentation.xs.admin.backup.backup-instance.WebHome]]. 4 + 5 +== Why is ##WEB-INF/xwiki.properties## a symbolic link? == 6 + 7 +Because Debian keeps the configuration of a package under ##/etc##, while XWiki looks for it inside its web application; the link satisfies both, and it is what keeps your settings when the package is upgraded. - Related
-
... ... @@ -1,0 +1,3 @@ 1 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 2 +* [[Configure the Permanent Directory>>doc:documentation.xs.admin.configuration.directories.permanent-directory.configure.WebHome]]. 3 +* [[Back Up an XWiki Instance>>doc:documentation.xs.admin.backup.backup-instance.WebHome]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +reference
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Deploy XWiki as the Root Web Application on Debian - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,37 @@ 1 +On an installation made from the Debian packages, the servlet container is configured by the package rather than by hand, so dropping the ##/xwiki/## part of your [[short URLs>>doc:documentation.xs.admin.configuration.short-urls.WebHome]] means editing the files the package installed. 2 + 3 +1. Stop XWiki. 4 +1. Serve the web application from the container's root context, in the file your package installed.((( 5 +**Tomcat**: rename the context file, then change the ##path## attribute of its ##Context## element in ##/etc/xwiki/xwiki-tomcat<version>.xml##. 6 + 7 +{{code language="bash"}} 8 +sudo mv /etc/tomcat11/Catalina/localhost/xwiki.xml /etc/tomcat11/Catalina/localhost/ROOT.xml 9 +{{/code}} 10 + 11 +{{code language="xml"}} 12 +<Context path="/xwiki" docBase="/usr/lib/xwiki" containerSciFilter="org.apache.jasper.servlet.JasperInitializer"> 13 +{{/code}} 14 + 15 +becomes 16 + 17 +{{code language="xml"}} 18 +<Context path="" docBase="/usr/lib/xwiki" containerSciFilter="org.apache.jasper.servlet.JasperInitializer"> 19 +{{/code}} 20 + 21 +**XJetty**: give the ##WebAppContext## of ##/etc/xwiki/xjetty-web.xml## a root context path. That file is the stable name the package gives its Jetty context configuration. 22 + 23 +{{code language="xml"}} 24 +<Set name="contextPath">/</Set> 25 +{{/code}} 26 +))) 27 +1. Uncomment ##xwiki.webapppath## in ##/etc/xwiki/xwiki.cfg##, leaving its value empty.((( 28 +{{code language="properties"}} 29 +xwiki.webapppath= 30 +{{/code}} 31 +))) 32 +1. Start XWiki. 33 +1. Open any page and read its URL: the application name is gone, while the servlet mapping and the action are still there.((( 34 +{{code language="none"}} 35 +http://server.com/bin/view/Sandbox/WebHome 36 +{{/code}} 37 +)))
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,7 @@ 1 +== Why is my wiki back on ##/xwiki/## after an upgrade? == 2 + 3 +Upgrading the Tomcat package can restore ##/etc/tomcat<version>/Catalina/localhost/xwiki.xml##, which makes the container serve the application under its old name again; check that directory after every upgrade and remove the file if it reappeared. 4 + 5 +== Does the procedure for a ##.war## installation apply here? == 6 + 7 +No, that one moves the web application between ##webapps## directories, which the Debian packages do not use; the three parts of a short URL are the same, but only this page's files exist on a Debian installation. - Related
-
... ... @@ -1,0 +1,3 @@ 1 +* [[Deploy XWiki as the Root Web Application>>doc:documentation.xs.admin.configuration.short-urls.deploy-root-webapp.WebHome]]. 2 +* [[Short URLs>>doc:documentation.xs.admin.configuration.short-urls.WebHome]]. 3 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +howto
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Set Up a Standalone Solr Server on Debian - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,27 @@ 1 +An [[XWiki installed from the Debian packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]] runs its own embedded Solr; moving the index to a Solr server of its own takes the indexing load off the wiki and lets several instances share one search server. 2 + 3 +1. Install Solr itself, following [[Taking Solr to Production>>https://solr.apache.org/guide/solr/latest/deployment-guide/taking-solr-to-production.html]]. 4 +1. Install the core packages, which unpack XWiki's cores into ##/var/solr/data## and give them to the ##solr## user. They only reach a Solr server installed in that standard location.((( 5 +{{code language="bash"}} 6 +sudo apt install xwiki-solr9-all 7 +{{/code}} 8 +))) 9 +1. Point XWiki at the server, in ##/etc/xwiki/xwiki.properties##.((( 10 +{{code language="properties"}} 11 +solr.type=remote 12 +solr.remote.baseURL=http://localhost:8983/solr 13 +{{/code}} 14 +))) 15 +1. Restart XWiki.((( 16 +{{code language="bash"}} 17 +sudo systemctl restart tomcat11 18 +{{/code}} 19 +))) 20 +1. Open the Solr administration interface: the four XWiki cores are listed, and the wiki searches through them.((( 21 +{{code language="none"}} 22 +xwiki_search_9 23 +xwiki_events_9 24 +xwiki_ratings_9 25 +xwiki_extension_index_9 26 +{{/code}} 27 +)))
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,7 @@ 1 +== Can I install only some of the cores? == 2 + 3 +Yes, the ##xwiki-solr9-search##, ##xwiki-solr9-events##, ##xwiki-solr9-ratings## and ##xwiki-solr9-extension-index## packages install one core each, and ##xwiki-solr9-all## simply depends on all four. 4 + 5 +== Why is the core named differently from its package? == 6 + 7 +The package names follow the Debian convention while the core names follow XWiki's, so the package ##xwiki-solr9-extension-index## registers the core ##xwiki_extension_index_9##. - Related
-
... ... @@ -1,0 +1,2 @@ 1 +* [[XWiki Debian Repositories and Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.packages.WebHome]]. 2 +* [[Run XWiki with an External Solr Container>>doc:documentation.xs.admin.installation.methods.install-xwiki-docker.run-xwiki-external-solr.WebHome]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +howto
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Allow XWiki to Access Files outside Its Data Directory - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,29 @@ 1 +The Debian packages run XWiki under a systemd sandbox that allows it only its own permanent directory, so a path that an [[XWiki installed from a ##.war##>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.WebHome]] would read is refused here even when the system user running XWiki is allowed to read it. 2 + 3 +1. Open the systemd configuration your package installed.((( 4 +{{code language="none"}} 5 +/etc/systemd/system/tomcat<version>.service.d/xwiki-tomcat<version>-systemd.conf # xwiki-tomcat* packages 6 +/lib/systemd/system/xwiki.service # xwiki-xjetty* packages 7 +{{/code}} 8 +))) 9 +1. Declare the directory XWiki has to reach, read-write or read-only.((( 10 +{{code language="ini"}} 11 +[Service] 12 +ReadWritePaths=/srv/shared-attachments 13 +{{/code}} 14 +))) 15 +1. Reload the systemd configuration.((( 16 +{{code language="bash"}} 17 +sudo systemctl daemon-reload 18 +{{/code}} 19 +))) 20 +1. Restart the service.((( 21 +{{code language="bash"}} 22 +sudo systemctl restart tomcat11 23 +{{/code}} 24 +))) 25 +1. Read back the setting systemd now applies: the directory you added is listed, and XWiki reaches it.((( 26 +{{code language="bash"}} 27 +systemctl show tomcat11 --property=ReadWritePaths 28 +{{/code}} 29 +)))
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,7 @@ 1 +== Which directories are allowed by default? == 2 + 3 +An ##xwiki-tomcat*## package adds only the permanent directory ##/var/lib/xwiki/data##; an ##xwiki-xjetty*## package writes in the whole of ##/var/lib/xwiki/## and in ##/var/log/xwiki/##, and reads ##/etc/xwiki##. 4 + 5 +== Why is the file different for Tomcat and for XJetty? == 6 + 7 +The ##xwiki-tomcat*## packages extend the service unit the Tomcat package owns, through a drop-in file, while the ##xwiki-xjetty*## packages own their service unit outright. - Related
-
... ... @@ -1,0 +1,2 @@ 1 +* [[Files Installed by the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 2 +* [[Configure the Permanent Directory>>doc:documentation.xs.admin.configuration.directories.permanent-directory.configure.WebHome]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +howto
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Uninstall the XWiki Debian Packages - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,22 @@ 1 +Removing an [[XWiki installed from the Debian packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]] is a matter of purging the packages you installed, and then deciding what to do with the data they leave behind. 2 + 3 +1. Purge the XWiki packages, which removes every package depending on ##xwiki-common##.((( 4 +{{code language="bash"}} 5 +sudo apt purge xwiki-common 6 +{{/code}} 7 +))) 8 +1. Remove the servlet container, the database and the Java runtime that were installed as dependencies, if nothing else on the machine uses them.((( 9 +{{code language="bash"}} 10 +sudo apt autoremove --purge 11 +{{/code}} 12 +))) 13 +1. Delete the permanent directory, once you are sure you no longer need the attachments and the search index it holds.((( 14 +{{code language="bash"}} 15 +sudo rm -r /var/lib/xwiki/data 16 +{{/code}} 17 +))) 18 +1. List the installed packages: no XWiki package is left.((( 19 +{{code language="bash"}} 20 +apt list --installed | grep xwiki 21 +{{/code}} 22 +)))
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,7 @@ 1 +== Is my wiki content deleted? == 2 + 3 +Not by the commands above: the content lives in the database, which dbconfig offers to drop when the package is purged and keeps if you decline. 4 + 5 +== Can I reinstall later and keep my wiki? == 6 + 7 +Yes, as long as you kept the database and the permanent directory; reinstalling the package and pointing it at the existing database brings the wiki back. - Related
-
... ... @@ -1,0 +1,3 @@ 1 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 2 +* [[Files Installed by the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 3 +* [[Back Up an XWiki Instance>>doc:documentation.xs.admin.backup.backup-instance.WebHome]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +howto
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +Debian Package Troubleshooting - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,40 @@ 1 +Problems that belong to the Debian packages rather than to XWiki itself, each with its cause and its solution. 2 + 3 +== No package is available for the Java version XWiki needs == 4 + 5 +=== Cause === 6 + 7 +The XWiki packages depend on a [[supported Java version>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]], and your distribution offers no package for one. ##apt## then refuses to install or upgrade XWiki, reporting an unsatisfiable dependency. 8 + 9 +=== Solution === 10 + 11 +Register a repository that provides one. Adoptium publishes Temurin, a build of OpenJDK, as [[Debian and Ubuntu packages>>https://adoptium.net/installation/linux/#_deb_installation_on_debian_or_ubuntu]]. 12 + 13 +Installing it is not enough: Tomcat goes on running the Java it was started with. Which one that is comes from ##/etc/default/tomcat<version>##, so set ##JAVA_HOME## there and restart the service. 14 + 15 +{{code language="bash"}} 16 +JAVA_HOME=/usr/lib/jvm/temurin-21-jdk-amd64 17 +{{/code}} 18 + 19 +== The wiki does not start, or a page fails == 20 + 21 +=== Cause === 22 + 23 +Almost anything: a database that is unreachable, a permission the systemd sandbox refuses, a Java version mismatch, a half-finished upgrade. The XWiki log records a ##WARNING## or an error for each of them, which is why it is the first thing to read. 24 + 25 +=== Solution === 26 + 27 +Read the log of the server your package installed. 28 + 29 +{{code language="none"}} 30 +/var/log/xwiki/<date>.jetty.log 31 +/var/log/tomcat<version>/catalina.out 32 +/var/log/tomcat<version>/catalina.<date>.log 33 +/var/log/tomcat<version>/localhost.<date>.log 34 +{{/code}} 35 + 36 +The first file is the XJetty log. For Tomcat, ##catalina.out## is the one to check first, while ##localhost.<date>.log## is the container's own log, recording the start of each filter and the failures of each. Recent Debian and Ubuntu releases send the Tomcat service output to the systemd journal instead of ##catalina.out##. 37 + 38 +== A problem that is not specific to Debian == 39 + 40 +The packages install an ordinary servlet container and an ordinary database, so everything the rest of the documentation says about them applies: [[Tomcat Troubleshooting>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.troubleshooting.WebHome]] for the container, [[Configure MySQL>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-mysql.WebHome]] and [[Configure PostgreSQL Manually>>doc:documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-postgresql-manually.WebHome]] for the database, and [[Installation Troubleshooting>>doc:documentation.xs.admin.installation.troubleshooting.WebHome]] for the rest.
- DocApp.Code.DocumentationClass[0]
-
- FAQ
-
... ... @@ -1,0 +1,3 @@ 1 +== How do I follow the log while XWiki starts? == 2 + 3 +With ##sudo journalctl -u tomcat11 -f## for a Tomcat package, or ##sudo journalctl -u xwiki -f## for an XJetty one. - Related
-
... ... @@ -1,0 +1,4 @@ 1 +* [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 2 +* [[Upgrade XWiki Installed from the Debian Packages>>doc:documentation.xs.admin.upgrade.distribution.upgrade-debian-package.WebHome]]. 3 +* [[Installation Troubleshooting>>doc:documentation.xs.admin.installation.troubleshooting.WebHome]]. 4 +* [[Performance>>doc:documentation.xs.admin.performance.WebHome]]. - Target
-
... ... @@ -1,0 +1,1 @@ 1 +administrator - Type
-
... ... @@ -1,0 +1,1 @@ 1 +explanation
- DocApp.Code.DocumentationExtensionClass[0]
-
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -28,7 +28,7 @@ 28 28 29 29 ==== Linux-specific alternatives ==== 30 30 31 -If Tomcat was installed through your Linux distribution's package manager instead (e.g. [[Install ationusingDebian/Ubuntu(.DEB) packages>>Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome]]), it does not use ##bin/catalina.sh## or ##setenv.sh##; memory settings must instead be configured through distribution-specific configuration files such as:31 +If Tomcat was installed through your Linux distribution's package manager instead (e.g. [[Install XWiki from the Debian Packages>>doc:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]), it does not use ##bin/catalina.sh## or ##setenv.sh##; memory settings must instead be configured through distribution-specific configuration files such as: 32 32 33 33 {{code language="none"}} 34 34 /etc/default/tomcatX
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. VincentMassol1 +XWiki.elenicojocariu - Content
-
... ... @@ -2,431 +2,144 @@ 2 2 {{toc start="2"/}} 3 3 {{/box}} 4 4 5 -This distributionallowsinstallingXWikiandeverycomponentneeded foraproductioninstanceautomatically.5 +This page has moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 6 6 7 -This method works for all Debian-based linux distribution. Feel free to use [[the User Forum>>dev:Community.Discuss]] to report issues, or discuss about it. 8 - 9 9 == APT Configuration == 10 10 11 - First, you have toconfigureyourpackagemanagerin ordertouseXWiki’s repository.Forexample,usethis commandtousethe ##stable##repository:9 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]], whose first step registers the repository, and to [[XWiki Debian Repositories and Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.packages.WebHome]] for the channels and the full package list. 12 12 13 -{{code language="bash"}} 14 -sudo wget https://maven.xwiki.org/xwiki-keyring.gpg -O /usr/share/keyrings/xwiki-keyring.gpg 15 -sudo wget "https://maven.xwiki.org/stable/xwiki-stable.list" -O /etc/apt/sources.list.d/xwiki-stable.list 16 -{{/code}} 17 - 18 -{{info}} 19 -Note that there are several repositories you can choose (as alternatives to the stable one you have in the previous example): 20 - 21 -* [[https:~~/~~/maven.xwiki.org/releases/xwiki-releases.list>>https://maven.xwiki.org/releases/xwiki-releases.list]]: all released versions including milestones and release candidates (unstable). 22 -* [[https:~~/~~/maven.xwiki.org/stable/xwiki-stable.list>>https://maven.xwiki.org/stable/xwiki-stable.list]]: all released versions excluding milestones and release candidates (stable). 23 -* [[https:~~/~~/maven.xwiki.org/lts/xwiki-lts.list>>https://maven.xwiki.org/lts/xwiki-lts.list]]: all released Cycle LTS versions. 24 -* [[https:~~/~~/maven.xwiki.org/recommended/xwiki-lts-latest.list>>https://maven.xwiki.org/recommended/xwiki-lts-latest.list]]: latest LTS versions (can be the Cycle LTS or the Intermediate LTS versions if they higher). 25 - 26 -Check out the the [[Support page>>xwiki:Main.Support]] for more information on the various branches we support. 27 -{{/info}} 28 - 29 -Now you can update the packages database to read the data from this repository. 30 - 31 -{{code language="bash"}} 32 -sudo apt update 33 -{{/code}} 34 - 35 -Now you can make a little search to see what this repo offers. 36 - 37 -{{code language="bash"}} 38 -apt search xwiki 39 -{{/code}} 40 - 41 -* Common package not tied to any application server or database 42 -** ##xwiki-common## - XWiki, you can install this if you want to take care yourself of the database and application server 43 - 44 -* Common packages not tied to any application server 45 -** ##xwiki-mariadb-common## - XWiki MariaDB common package, you can install this if you want to take care yourself of the application server 46 -** ##xwiki-mysql-common## - XWiki MySQL common package, you can install this if you want to take care yourself of the application server 47 -** ##xwiki-pgsql-common## - XWiki PostgreSQL common package, you can install this if you want to take care yourself of the application server 48 - 49 -* Packages based on a customized Jetty packaged for XWiki 50 -** ##xwiki-xjetty-common## - XWiki Jetty common package, you can install this if you want to take care yourself of the database link 51 -** ##xwiki-xjetty-mariadb## - XWiki Jetty/MariaDB based package 52 -** ##xwiki-xjetty-mysql## - XWiki Jetty/MySQL based package 53 -** ##xwiki-xjetty-pgsql## - XWiki Jetty/PostgreSQL 54 - 55 -* Packages based on the standard Tomcat package (they do not include Tomcat, they depend on it so the pacjage you use generally depends on what version of Tomcat is available on your distribution's repositories) 56 -** ##xwiki-tomcat10-common## - XWiki Tomcat 10 common package, you can install this if you want to take care yourself of the database link 57 -** ##xwiki-tomcat10-mariadb## - XWiki Tomcat 10/MariaDB based package 58 -** ##xwiki-tomcat10-mysql## - XWiki Tomcat 10/MySQL based package 59 -** ##xwiki-tomcat10-pgsql## - XWiki Tomcat 10/PostgreSQL 60 -** ##xwiki-tomcat11-common## - XWiki Tomcat 11 common package, you can install this if you want to take care yourself of the database link 61 -** ##xwiki-tomcat11-mariadb## - XWiki Tomcat 11/MariaDB based package 62 -** ##xwiki-tomcat11-mysql## - XWiki Tomcat 11/MySQL based package 63 -** ##xwiki-tomcat11-pgsql## - XWiki Tomcat 11/PostgreSQL 64 - 65 -* Not really XWiki itself but Solr cores needed when you want to use a standalone Solr instance with XWiki 66 -** ##xwiki-solr9-all## - An entry point package with dependencies on all the Solr 9 cores required to setup a standalone version compatible with XWiki Standard 67 -** ##xwiki-solr9-search## - A pre configured Solr 9 core for the XWiki search feature 68 -** ##xwiki-solr9-events## - A pre configured Solr 9 core for the XWiki events/notifications storage 69 -** ##xwiki-solr9-ratings## - A pre configured Solr 9 core for the XWiki rating storage 70 -** ##xwiki-solr9-extension_index## - A pre configured Solr 9 core for the XWiki extensions index 71 - 72 -Plus legacy packages from older versions of XWiki like ##xwiki-enterprise-*## packages or for now unsupported versions of Tomcat. 73 - 74 -{{info}} 75 -According to selection, package manager will install all necessary dependencies (application server, database, Java runtime). If you haven't installed these packages before, package manager can ask additional info from you. 76 -{{/info}} 77 - 78 -{{warning}} 79 - On Ubuntu you will need [[##universe## repository>>https://help.ubuntu.com/community/Repositories/CommandLine]] to install Tomcat packages. It's generally enabled by default. 80 -{{/warning}} 81 - 82 82 == Complete Installation == 83 83 84 -{{warning}} 85 -Most Debian distributions provide a Tomcat package with a pretty low Memory setting by default (128MB) and this need to be increased for XWiki to fully work. See [[Tomcat Memory section>>||anchor="HMemory"]] for more details. 86 -{{/warning}} 13 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]. 87 87 88 88 === Using MariaDB === 89 89 90 -{{warning}} 91 -Note that XWiki requires at least MariaDB 10.2. 92 -{{/warning}} 17 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]; the package names are listed in [[XWiki Debian Repositories and Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.packages.WebHome]]. 93 93 94 -Tomcat: 95 - 96 -{{code language="bash"}} 97 -sudo apt install xwiki-tomcat10-mariadb 98 -{{/code}} 99 - 100 -Xjetty: 101 - 102 -{{code language="bash"}} 103 -sudo apt install xwiki-xjetty-mariadb 104 -{{/code}} 105 - 106 -During the installation you may get some questions from DBconfig, which is in charge of the configuration of XWiki with the MariaDB database. Don't confuse it with the MariaDB root password prompt that asks you for a root password (which is intented for the superuser). If you haven't already installed any MariaDB databases and you are not familiar with it you should let DBconfig handle this. 107 - 108 -Afterwards DBconfig asks you for the MariaDB root password for the "xwiki" MariaDB user. This user will be used to connect to MariaDB from the XWiki application. You should choose the password wisely but you don't have to pay a lot of attention to it after that because DBconfig internally configures XWiki to start up with these credentials. 109 - 110 -{{warning}} 111 -The password should not contain any special characters, otherwise XWiki will fail to start. See [[https:~~/~~/jira.xwiki.org/browse/XWIKI-14406>>https://jira.xwiki.org/browse/XWIKI-14406]] 112 -{{/warning}} 113 - 114 -The installation ends with the start of the XWiki or Tomcat daemon which is also setup to start automatically from boot. 115 - 116 116 === Using MySQL === 117 117 118 -{{warning}} 119 -Note that XWiki requires at least MySQL 5.7. It's not recommended to use this package if your "MySQL" server is in fact MariaDB, see [[the MariaDB section>>||anchor="#HUsingMariaDB"]]. 120 -{{/warning}} 21 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]; the package names are listed in [[XWiki Debian Repositories and Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.packages.WebHome]]. 121 121 122 -Tomcat: 123 - 124 -{{code language="bash"}} 125 -sudo apt install xwiki-tomcat10-mysql 126 -{{/code}} 127 - 128 -Xjetty: 129 - 130 -{{code language="bash"}} 131 -sudo apt install xwiki-xjetty-mysql 132 -{{/code}} 133 - 134 -Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]]. 135 - 136 136 === Using PostgreSQL === 137 137 138 - It'sassimpleastheMySQLinstallation, you onlyneedtochoose the rightvirtualpackage.25 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]]; the package names are listed in [[XWiki Debian Repositories and Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.packages.WebHome]]. 139 139 140 -Tomcat: 141 - 142 -{{code language="bash"}} 143 -sudo apt install xwiki-tomcat10-pgsql 144 -{{/code}} 145 - 146 -Xjetty: 147 - 148 -{{code language="bash"}} 149 -sudo apt install xwiki-xjetty-pgsql 150 -{{/code}} 151 - 152 -Everything else is similar to what is described in the [[the MariaDB section>>||anchor="#HUsingMariaDB"]]. 153 - 154 154 === Starting up XWiki for the first time... === 155 155 156 - After you'vemadesuretoupdatethememorysettings(see below), you cannow pointyour favoritebrowsertothefollowingURLto useyourwiki:##[[http:~~/~~/localhost:8080/xwiki>>http://localhost:8080/xwiki]]##29 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]], whose last step opens the wiki and installs the flavor. 157 157 158 -{{warning}} 159 -Note that your wiki is absolutely empty, like a WAR installation. Distribution Wizard will take care of the rest. 160 -{{/warning}} 161 - 162 162 == Performance == 163 163 33 +Moved to [[Performance>>documentation.xs.admin.performance.WebHome]] and, for the servlet container, to the two pages below. 34 + 164 164 === XWiki === 165 165 166 - You can findvarious[[various genericadvices and troubleshooting related to XWiki>>Documentation.AdminGuide.Performances]].37 +Moved to [[Performance>>documentation.xs.admin.performance.WebHome]]. 167 167 168 168 === Tomcat === 169 169 170 - You can find [[various generic advicesandtroubleshootingrelatedtoTomcat>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.WebHome]].41 +Moved to [[Configure Tomcat>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.WebHome]]. 171 171 172 172 ==== Java Version ==== 173 173 174 -M ake sureTomcat isexecutedwiththeright [[Javaversion>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]].45 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]] and to [[Java Support Strategy>>dev:Community.SupportStrategy.JavaSupportStrategy.WebHome]]. 175 175 176 -This is usually indicated in the file ##/etc/default/tomcat10## (or ##/etc/default/tomcat11## for Tomcat 11, etc). 177 - 178 178 ==== Memory ==== 179 179 180 - See[[Java Memory for Tomcat>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.java-memory.WebHome||anchor="HLinux-specificalternatives"]].49 +Moved to [[Java Memory for Tomcat>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.java-memory.WebHome]]. 181 181 182 182 == Concluding Step == 183 183 184 - See[[Install the Flavor Using the Distribution Wizard>>xwiki:documentation.xs.admin.distribution-wizard.install-flavor.WebHome]].53 +Moved to [[Install the Flavor Using the Distribution Wizard>>documentation.xs.admin.distribution-wizard.install-flavor.WebHome]]. 185 185 186 186 == Upgrading == 187 187 188 - {{id name="HUpgrading"/}}57 +Moved to [[Upgrade XWiki Installed from the Debian Packages>>documentation.xs.admin.upgrade.distribution.upgrade-debian-package.WebHome]]. 189 189 190 -See [[Upgrade XWiki Installed from the Debian Packages>>documentation.xs.admin.upgrade.distribution.upgrade-debian-package.WebHome]]. 191 - 192 192 == Uninstallation == 193 193 194 - Ifyouwant to removeXWikifrom your system,youonly havetouninstallthe packages you'veinstalledat thebeginning of thisdocumentation.Forexample:61 +Moved to [[Uninstall the XWiki Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.uninstall.WebHome]]. 195 195 196 -{{code language="bash"}} 197 -sudo apt-get --purge remove xwiki-common 198 -{{/code}} 199 - 200 -Attention, these commands do not remove MySQL/PostgreSQL nor Tomcat from your system. To do so, if you don't use these applications for another purpose, you can make some cleaning with 201 - 202 -{{code language="bash"}} 203 -sudo apt-get --purge autoremove 204 -{{/code}} 205 - 206 206 == Troubleshooting == 207 207 65 +Moved to [[Debian Package Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]. 66 + 208 208 === No package can be found for Java === 209 209 210 - XWiki requireatleastJava17sinceXWiki 16.0andJava21 sinceXWiki18.0.0.69 +Moved to [[Debian Package Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]. 211 211 212 -If your Debian based distribution does not provide any package for the Java version you need you can try with: 213 - 214 -* Adoptium provides a Debian repository to install Temurin (OpenJDK), see https://adoptium.net/installation/linux/#_deb_installation_on_debian_or_ubuntu 215 - 216 216 === Tomcat === 217 217 218 - See[[Tomcattroubleshootings>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.troubleshooting.WebHome]]for generic Tomcat related issues.73 +Moved to [[Tomcat Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-war.configure-servlet-container.configure-tomcat.troubleshooting.WebHome]]. 219 219 220 220 === MySQL === 221 221 222 - See[[Configure MySQL>>documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-mysql.WebHome]]for generic MySQL related issues.77 +Moved to [[Configure MySQL>>documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-mysql.WebHome]]. 223 223 224 224 === PostgreSQL === 225 225 226 - See[[PostgreSQLInstallation>>Documentation.AdminGuide.Installation.InstallationWAR.InstallationPostgreSQL||anchor="HTroubleshooting"]]forgeneric PostgreSQL related issues.81 +Moved to [[Configure PostgreSQL Manually>>documentation.xs.admin.installation.methods.install-xwiki-war.install-relational-database.configure-postgresql-manually.WebHome]]. 227 227 228 228 === Log file location === 229 229 230 - Thisinstallationmanualshouldguideyouall theway to a freshandcleanXWiki platform. If onthe other handissuesmay arise,it isimportanttoinspectthe XWiki log file for any WARNING messagesthat may have been brought up. Belowyou can findthelocationofthis log fileforthe respectiveapplication servers.85 +Moved to [[Debian Package Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]. 231 231 232 232 ==== XJetty ==== 233 233 234 -{{code language="none"}} 235 -/var/log/xwiki/[date].jetty.log 236 -{{/code}} 89 +Moved to [[Debian Package Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]. 237 237 238 238 ==== Tomcat ==== 239 239 240 - There areseveral possibilitiesdependingonthedistributionand Tomcatversion:93 +Moved to [[Debian Package Troubleshooting>>documentation.xs.admin.installation.methods.install-xwiki-debian.troubleshooting.WebHome]]. 241 241 242 -{{code language="none"}} 243 -/var/log/tomcat10/catalina.out 244 -/var/log/tomcat10/catalina.[date].log 245 -{{/code}} 246 - 247 -You can find a generic Troubleshooting section on [[Troubleshooting>>documentation.xs.admin.installation.troubleshooting.WebHome]]. 248 - 249 249 == Other useful info == 250 250 97 +Moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]], whose More section lists the pages below. 98 + 251 251 === XWiki as root webapp (short URLs) === 252 252 253 - Note that this sectionis only thepartofShort URL specificto the Debiansetup.To fully configuretheURL toyourliking, see[[full documentation onshort URLs>>doc:documentation.xs.admin.configuration.short-urls.WebHome]].101 +Moved to [[Deploy XWiki as the Root Web Application on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.deploy-root-webapp.WebHome]]. 254 254 255 255 ==== For Tomcat 10+ ==== 256 256 257 -{{warning}} 258 -When doing it make sure to check after upgrade if all is OK in /etc/tomcat10/Catalina/localhost folder (xwiki.xml might be restored). 259 -{{/warning}} 105 +Moved to [[Deploy XWiki as the Root Web Application on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.deploy-root-webapp.WebHome]]. 260 260 261 -* Rename file ##/etc/tomcat10/Catalina/localhost/xwiki.xml## into ##/etc/tomcat10/Catalina/localhost/ROOT.xml## 262 -* Edit file ##/etc/xwiki/xwiki-tomcat10.xml## and modify ##Context## XML element path from ##/xwiki## to ##/## as in moving from((( 263 -{{code language="xml"}} 264 -<Context path="/xwiki" docBase="/usr/lib/xwiki" 265 - containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer"> 266 -{{/code}} 267 - 268 -to 269 - 270 -{{code language="xml"}} 271 -<Context path="" docBase="/usr/lib/xwiki" 272 - containerSciFilter="org.apache.tomcat.websocket.server.WsSci|org.apache.jasper.servlet.JasperInitializer"> 273 -{{/code}} 274 -))) 275 -* Edit file ##/etc/xwiki/xwiki.cfg## and uncomment {{code language="properties"}}xwiki.webapppath={{/code}} 276 -* Restart Tomcat. 277 - 278 278 ==== For Jetty ==== 279 279 280 -{{version since="16.7.0"}} 281 -You have to modify the ##xjetty-web.xml## file 109 +Moved to [[Deploy XWiki as the Root Web Application on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.deploy-root-webapp.WebHome]]. 282 282 283 -The WebAppContext from the xwiki-jetty configuration has to be modified so that Jetty actually serves the XWiki application from the root-path. For this you have to modify the ##/etc/xwiki/xjetty-web.xml## and add the following directive. 284 - 285 -{{code language="xml"}} 286 -<Set name="contextPath">/</Set> 287 -{{/code}} 288 -{{/version}} 289 - 290 -You have to modify the ##xjetty-web.xml## file 291 - 292 -The WebAppContext from the xwiki-jetty configuration has to be modified so that Jetty actually serves the XWiki application from the root-path. For this you have to modify the ##/etc/xwiki/xjetty-web.xml## and add the following directive. 293 - 294 -{{code language="xml"}} 295 -<Set name="contextPath">/</Set> 296 -{{/code}} 297 - 298 -{{version since="17.0.0"}} 299 -You have to modify the ##jetty-web.xml## file 300 - 301 -The WebAppContext from the xwiki-jetty configuration has to be modified so that Jetty actually serves the XWiki application from the root-path. For this you have to modify the ##/etc/xwiki/jetty-web.xml## and add the following directive. 302 - 303 -{{code language="xml"}} 304 -<Set name="contextPath">/</Set> 305 -{{/code}} 306 -{{/version}} 307 - 308 -(% data-xwikiorg-product="XWiki" data-xwikiorg-versions-range="3" data-xwikiorg-versions-since="17.0.0" %)You have to modify the ##jetty-web.xml## file 309 - 310 -(% data-xwikiorg-product="XWiki" data-xwikiorg-versions-range="3" data-xwikiorg-versions-since="17.0.0" %)The WebAppContext from the xwiki-jetty configuration has to be modified so that Jetty actually serves the XWiki application from the root-path. For this you have to modify the ##/etc/xwiki/jetty-web.xml## and add the following directive. 311 - 312 -(% data-xwikiorg-product="XWiki" data-xwikiorg-versions-range="3" data-xwikiorg-versions-since="17.0.0" %){{code language="xml"}}<Set name="contextPath">/</Set>{{/code}} 313 - 314 -{{{<Set name="contextPath">/</Set>}}} 315 - 316 316 === Integrate with LibreOffice === 317 317 318 -In stalllibreofficewith{{code language="none"}}sudoapt-getinstalllibreoffice{{/code}}.113 +Moved to [[Connect to an Internal Office Server>>documentation.xs.admin.exports.office-server-properties.connect-internal-office-server.WebHome]]; on a Debian installation the properties file to edit is ##/etc/xwiki/xwiki.properties##, as [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]] explains. 319 319 320 -And setup XWiki to automatically start and access libreoffice in ##/etc/xwiki/xwiki.properties##: 321 - 322 -{{code language="properties"}} 323 -openoffice.autoStart=true 324 -openoffice.homePath=/usr/lib/libreoffice/ 325 -{{/code}} 326 - 327 -See [[Office Server Properties>>xwiki:documentation.xs.admin.exports.office-server-properties.WebHome]] for more details. 328 - 329 329 === Standalone Solr setup === 330 330 331 - Take a lookat [[Solr documentation>>https://solr.apache.org/guide/solr/latest/deployment-guide/taking-solr-to-production.html]] toinstall Solritself.117 +Moved to [[Set Up a Standalone Solr Server on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.standalone-solr.WebHome]]. 332 332 333 -Then you will need to add the XWiki schema configuration: you should install the package ##xwiki-solr-all## for Solr 8 or {{version since="XWiki 16.2.0"}}##xwiki-solr9-all## for Solr 9{{/version}} to automatically register the Solr cores needed by XWiki Standard in the Solr server (provided the standard Solr setup was used). 334 - 335 335 === Access a file from XWiki === 336 336 337 - SystemD is configured topreventXWikifromaccessingan arbitrary file onthe file system,evenifthesystemuser which runsXWikiwouldnormally be allowed toaccessit.You can control this in thefile:121 +Moved to [[Allow XWiki to Access Files outside Its Data Directory>>documentation.xs.admin.installation.methods.install-xwiki-debian.allow-file-access.WebHome]]. 338 338 339 -* ##/etc/systemd/system/tomcat10.service.d/xwiki-tomcat10-systemd.conf## when using a ##xwiki-tomcat10-*## package 340 -* ##/lib/systemd/system/xwiki.service## when using a ##xwiki-xjetty-*## package 341 - 342 -By default XWiki is allowed and write ##/var/lib/xwiki/data##. Note that once you modified one of those files, you will need to execute ##sudo systemctl daemon-reload## and restart the service. 343 - 344 344 == Overview of the important files == 345 345 346 - Hereis a listofa differenttree.Thepointis tohelpyou finduseful files easily. This listis showing a few filesanddirectories,to keep itsimpleandclear.The '->'isusedto showalinktoanotherfile/directory.125 +Moved to [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 347 347 348 348 === XWiki === 349 349 350 - Theconfiguration: **/etc/xwiki/**129 +Moved to [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 351 351 352 -* hibernate.cfg.xml //Hibernate configuration, helping to configure the database resources// 353 -* xwiki.cfg 354 -* xwiki.properties 355 -* xwiki-tomcat10-systemd.conf // Injected trough ##/etc/systemd/system/tomcat10.service.d/xwiki-tomcat-systemd.conf##// in the tomcat10 service configuration 356 -* xwiki-tomcat<version> // The Tomcat integration linked from ##/etc/tomcat<version>/Catalina/localhost##// 357 - 358 -The permanent directory: **/var/lib/xwiki/data** 359 - 360 -The home directory: **/usr/lib/xwiki/** 361 - 362 -* META-INF 363 -* resources 364 -* skins 365 -* templates 366 -* WEB-INF 367 -** hibernate.cfg.xml -> /etc/xwiki/hibernate.cfg.xml 368 -** xwiki.cfg -> /etc/xwiki/xwiki.cfg 369 -** xwiki.properties -> /etc/xwiki/xwiki.properties 370 - 371 371 === XJetty === 372 372 373 - **/lib/systemd/system/xwiki.service**is theconfigurationinchargeofcontrolling the ##xwiki##service,it'salso where you can customizeitsjavastartup configuration133 +Moved to [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 374 374 375 375 === Tomcat === 376 376 377 - **/etc/tomcat##<version>##/**137 +Moved to [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 378 378 379 -* context.xml 380 -* logging.properties 381 -* server.xml 382 -* tomcat-users.xml 383 -* web.xml 384 - 385 -**/etc/default/** 386 - 387 -* tomcat##<version>## //This file helps configuring the Tomcat daemon. Every change needs a restart to be effective// 388 - 389 -**/var/lib/tomcat##<version>##/** 390 - 391 -* common 392 -* conf -> /etc/tomcat##<version>## 393 -* logs -> ../../log/tomcat##<version> //Note that starting Debian 10 and Ubuntu 18.04 systemd service log is used//## 394 -* server 395 -* shared 396 -* webapps 397 - 398 -**/var/log/tomcat##<version>##/** 399 - 400 -* catalina.out //First logging file. Check this one if you're experiencing troubles with Tomcat/XWiki.// 401 -* localhost.<date>.log // "Container Log file": Start of each filter and failures thereof are listed.// 402 - 403 403 === MariaDB/MySQL === 404 404 405 - **/etc/mysql/**141 +Moved to [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]]. 406 406 407 -* debian.cnf 408 -* my.cnf //Database configuration. Max_allowed_packet is the parameter you need to change to improve upload data size.// permitted. 409 - 410 -**/var/lib/mysql/** 411 - 412 -* mysql 413 -* xwiki //This is the xwiki database. You may want to backup this directory from time to time.// 414 - 415 -**/var/log/** 416 - 417 -* syslog 418 -* mysql 419 -** error.log 420 - 421 421 === PostgreSQL === 422 422 423 -**/etc/postgresql/** 424 - 425 -* ##<version>## 426 -** main 427 -*** postgresql.conf 428 -*** pg_hba.conf 429 - 430 -**/var/lib/postgresql/##<version>##/main/** 431 - 432 -* base 145 +Moved to [[Files Installed by the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.file-locations.WebHome]].
Summary
-
Page properties (4 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +InstallationViaAPT - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. XWikiGuest1 +XWiki.elenicojocariu - Default language
-
... ... @@ -1,0 +1,1 @@ 1 +en - Content
-
... ... @@ -1,0 +1,1 @@ 1 +This page has moved to [[Install XWiki from the Debian Packages>>documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]].
- XWiki.RedirectClass[0]
-
- Location
-
... ... @@ -1,1 +1,1 @@ 1 - xwiki:Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome1 +documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. ThomasMortagne1 +XWiki.elenicojocariu - Content
-
... ... @@ -16,7 +16,7 @@ 16 16 17 17 Here are some potential locations you can check, depending on the [[installation method>>documentation.xs.admin.installation.methods.WebHome]] you've chosen:: 18 18 19 -* If you use the [[XWiki Debian packag ing>>xwiki:Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome]], and thus using Tomcat, it's in ##/var/log/tomcat*/catalina.out##19 +* If you use the [[XWiki Debian packages>>xwiki:documentation.xs.admin.installation.methods.install-xwiki-debian.WebHome]], and thus using Tomcat, it's in ##/var/log/tomcat*/catalina.out## 20 20 ** Recent Tomcat packages use service logs, visible using the command ##journalctl -u tomcat9.service## 21 21 * If you use the [[XWiki Docker packaging>>https://github.com/xwiki-contrib/docker-xwiki/blob/master/README.md]] there are 2 locations where the XWiki logs are (see [[the Docker logs section>>https://github.com/xwiki/xwiki-docker/blob/master/README.md#logs]] for more details): 22 22 ** In the console that started Tomcat, or if you started it in background, you can get them with ##docker logs <container id>##.
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -8,7 +8,7 @@ 8 8 9 9 === When using the XWiki Debian Package === 10 10 11 -The Debian packages have their own root-webapp procedure: see [[ InstallationusingDebian/Ubuntu (.DEB) packages>>doc:Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome||anchor="HXWikiasrootwebapp28shortURLs29"]].11 +The Debian packages have their own root-webapp procedure: see [[Deploy XWiki as the Root Web Application on Debian>>documentation.xs.admin.installation.methods.install-xwiki-debian.deploy-root-webapp.WebHome]]. 12 12 13 13 == II. Servlet mapping name == 14 14