Wiki source code of Short URLs
Version 98.2 by Vincent Massol on 2024/10/18
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc start="2"/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This tutorial shows you how to tune your XWiki platform by replacing the default URL scheme with a shorter scheme. | ||
| 6 | |||
| 7 | {{info}} | ||
| 8 | A short URL is an URL without the ##xwiki/bin/view## parts. | ||
| 9 | {{/info}} | ||
| 10 | |||
| 11 | == I. Application name == | ||
| 12 | |||
| 13 | The ##/xwiki/## part of the URL is the application name. It identifies the application that should process the request, and it allows a container to host more than one application. To change it you must refer to your container's documentation and find how to map the context path of a web application. For example on Tomcat it's enough to simply deploy the XWiki webapp in the ##webapps## directory, in a sub directory named after the application name you wish to use (e.g. ##webapps/myappname##). | ||
| 14 | |||
| 15 | === Deploying as ROOT === | ||
| 16 | |||
| 17 | A special case is when deploying XWiki as the ROOT application, which actually allows the application name part to be empty, so an URL can take the form ##server.com/bin/view/Space/Document##. | ||
| 18 | |||
| 19 | Achieving this depends on the container, as there's no standard regarding the ROOT application (Refer to your container's documentation for more details). | ||
| 20 | |||
| 21 | Some examples: | ||
| 22 | |||
| 23 | * In Tomcat, with the default configuration, all it takes is to deploy the XWiki web application in ##webapps##, in a sub directory named ##ROOT## (i.e. ##webapps/ROOT##). | ||
| 24 | * In Jetty, with the default configuration, all it takes is to deploy the XWiki web application in ##webapps##, in a sub directory named ##root##. Note that if you're using the Standalone distribution (which packages Jetty and HSQLDB) then you'll also need to: | ||
| 25 | ** Remove the existing ##webapps/root## directory which contains a redirect Servlet that automatically redirects root URLs to the ##xwiki## context. You won't need that anymore. | ||
| 26 | ** Rename the existing ##webapps/xwiki## directory into ##webapps/root##. | ||
| 27 | ** Remove the ##jetty/contexts/xwiki.xml## file and thus keep only the ##jetty/contexts/root.xml## file. Otherwise you'll get a warning in the console. | ||
| 28 | |||
| 29 | {{version since="6.2.8, 6.4.3, 7.0"}} | ||
| 30 | You must tell XWiki that it's deployed as ROOT by setting the ##xwiki.webapppath## to empty in your ##xwiki.cfg## configuration file as in: | ||
| 31 | |||
| 32 | {{code language="none"}} | ||
| 33 | xwiki.webapppath= | ||
| 34 | {{/code}} | ||
| 35 | |||
| 36 | The reason is that XWiki cannot guess the webapp context from the URL in this case. This seemed to work on previous versions but it was actually leading to errors from time to time, depending on what URL was used when doing the first request on the XWiki instance. | ||
| 37 | {{/version}} | ||
| 38 | |||
| 39 | === When using the XWiki Debian Package === | ||
| 40 | |||
| 41 | See [[Installation using Debian (.DEB) packages>>Documentation.AdminGuide.Installation.InstallationViaAPT.WebHome||anchor="HXWikiasrootwebapp28shortURLs29"]]. | ||
| 42 | |||
| 43 | === When using Jetty from the XWiki Debian Package === | ||
| 44 | |||
| 45 | {{version since="16.7.0"}} | ||
| 46 | You have to modify the ##xjetty-web.xml## file | ||
| 47 | {{/version}} | ||
| 48 | |||
| 49 | 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. | ||
| 50 | |||
| 51 | {{code language="xml"}} | ||
| 52 | <Set name="contextPath">/</Set> | ||
| 53 | {{/code}} | ||
| 54 | |||
| 55 | == II. Servlet mapping name == | ||
| 56 | |||
| 57 | The second part is the hardest part to remove. It identifies the servlet that should process the page, which, for ##/bin/##, is the action servlet. Generically speaking, to get rid of ##/bin/##, you need to configure your system so that URLs matching ##/*## are mapped to the Action Servlet (by default only ##/bin/*## URLs are mapped to the Action Servlet). | ||
| 58 | |||
| 59 | However you need to be careful that the following prefixes do NOT go through the Action Servlet (see your ##web.xml## to check their current mappings): | ||
| 60 | |||
| 61 | * ##/resources/*## and ##/skins/*##: Statically served resources. These need to be served directly as static resources. | ||
| 62 | * ##/rest/*##: REST resources, served by the XWiki REST Servlet | ||
| 63 | * ##/redirect##: The XWiki Redirect Servlet used to redirect to the home page when no page is specified in the URL | ||
| 64 | |||
| 65 | There are various alternate to achieve this: | ||
| 66 | |||
| 67 | {{toc scope="local"/}} | ||
| 68 | |||
| 69 | {{info}} | ||
| 70 | You might be tempted to configure just your XWiki's ##web.xml## file [[but this won't work>>Documentation.AdminGuide.ShortURLs.ShortURLsInvalid.WebHome]]. | ||
| 71 | {{/info}} | ||
| 72 | |||
| 73 | === UrlRewriteFilter === | ||
| 74 | |||
| 75 | {{warning}} | ||
| 76 | This approach requires a specific workaround configuration with Tomcat 9.x+ (the workaround was not needed with Tomcat 8.x) since Tomcat performs very early mapping of incoming requests before the ##URLRewriteFilter## has a chance to add the ##/bin## prefix. Thus the mapping is [[wrongly associated to the default Servlet instead of the XWiki Action Servlet>>https://jira.xwiki.org/browse/XWIKI-19444?focusedCommentId=112420&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-112420]]. The workaround consists of the two actions below. | ||
| 77 | |||
| 78 | * Declare new Servlet mappings in ##web.xml##:((( | ||
| 79 | {{code language="xml"}} | ||
| 80 | <servlet-mapping> | ||
| 81 | <servlet-name>action</servlet-name> | ||
| 82 | <url-pattern>/upload/*</url-pattern> | ||
| 83 | </servlet-mapping> | ||
| 84 | |||
| 85 | <!-- This is for the file upload from CKEditor to work, since it sends a POST action to the current page using the "/get/" path --> | ||
| 86 | <servlet-mapping> | ||
| 87 | <servlet-name>action</servlet-name> | ||
| 88 | <url-pattern>/get/*</url-pattern> | ||
| 89 | </servlet-mapping> | ||
| 90 | {{/code}} | ||
| 91 | ))) | ||
| 92 | * Update the ##upload.js## content: | ||
| 93 | ** Do a backup of ##$XWIKI_WEBAPP/resources/uicomponents/widgets/upload.min.js##, then remove the original file | ||
| 94 | ** Edit the file ##$XWIKI_WEBAPP/resources/uicomponents/widgets/upload.js## and update the line {{code language="javascript"}}request.open('POST', this.formData.action);{{/code}} to:((( | ||
| 95 | {{code language="javascript"}} | ||
| 96 | request.open('POST', this.formData.action + '?form_token='+this.formData.additionalFields['form_token'] | ||
| 97 | + '&xredirect=' + escape(this.formData.additionalFields['xredirect'])); | ||
| 98 | {{/code}} | ||
| 99 | ))) | ||
| 100 | {{/warning}} | ||
| 101 | |||
| 102 | "UrlRewriteFilter" is a [[framework offering a Servlet Filter>>http://www.tuckey.org/urlrewrite/]] allowing to rewrite URLs. | ||
| 103 | |||
| 104 | Install steps: | ||
| 105 | |||
| 106 | 1. [[Download the JAR>>https://search.maven.org/artifact/org.tuckey/urlrewritefilter]] and put it in ##WEB-INF/lib## | ||
| 107 | 1. Edit your ##WEB-INF/web.xml## and add the ##<filter>## and ##<filter-mapping>## definitions [[as documented>>http://www.tuckey.org/urlrewrite/]]. Make sure to have them first so that they're executed before any other XWiki filter. | ||
| 108 | 1. Drop the following content below in a file at ##WEB-INF/urlrewrite.xml##:((( | ||
| 109 | Note that this is just an example and you should tune it depending on what you wish to achieve. Its principle is very simple: it takes some URL format you wish to have and convert those URLs into the format that XWiki expects in input, and, in output, it does the opposite and converts the XWiki format into the format you wish to have. | ||
| 110 | |||
| 111 | The example below expects URLs without a ##/bin## and thus adds it so that XWiki has it when it processes URLs and in output, removes the ##/bin## so that generated URLs are without ##/bin##. | ||
| 112 | |||
| 113 | {{code language="xml"}} | ||
| 114 | <?xml version="1.0" encoding="utf-8"?> | ||
| 115 | <!DOCTYPE urlrewrite PUBLIC "-//tuckey.org//DTD UrlRewrite 4.0//EN" | ||
| 116 | "http://www.tuckey.org/res/dtds/urlrewrite4.0.dtd"> | ||
| 117 | <urlrewrite decode-using="null"> | ||
| 118 | |||
| 119 | <rule> | ||
| 120 | <note> | ||
| 121 | Ensure that URLs that must not be served by the Action Servlet are not modified. | ||
| 122 | </note> | ||
| 123 | <from>^/((authenticate|bin|resources|skins|asyncrenderer|rest|wiki|jcaptcha|webjars|job)/(.*)|robots\.txt)$</from> | ||
| 124 | <to type="forward" last="true">-</to> | ||
| 125 | </rule> | ||
| 126 | |||
| 127 | <rule> | ||
| 128 | <note> | ||
| 129 | For all other URLs we prepend the "/bin/" prefix so that they get routed to the XWiki Action Servlet. | ||
| 130 | </note> | ||
| 131 | <from>^/(.*)$</from> | ||
| 132 | <to type="forward">/bin/$1</to> | ||
| 133 | </rule> | ||
| 134 | |||
| 135 | <outbound-rule> | ||
| 136 | <note> | ||
| 137 | Rewrite outbound URLs to remove the "/bin" part when there are two paths after it. | ||
| 138 | </note> | ||
| 139 | <from>/bin/(.*)/(.*)$</from> | ||
| 140 | <to>/$1/$2</to> | ||
| 141 | </outbound-rule> | ||
| 142 | |||
| 143 | <outbound-rule> | ||
| 144 | <note> | ||
| 145 | Rewrite outbound URLs to remove the "/bin" part when there's a single path after it. | ||
| 146 | </note> | ||
| 147 | <from>/bin/(.*)$</from> | ||
| 148 | <to>/$1</to> | ||
| 149 | </outbound-rule> | ||
| 150 | |||
| 151 | <outbound-rule> | ||
| 152 | <note> | ||
| 153 | Rewrite outbound URLs to remove the "/bin" part it's the last path. | ||
| 154 | </note> | ||
| 155 | <from>/bin$</from> | ||
| 156 | <to>/</to> | ||
| 157 | </outbound-rule> | ||
| 158 | |||
| 159 | </urlrewrite> | ||
| 160 | {{/code}} | ||
| 161 | ))) | ||
| 162 | |||
| 163 | **Note**: for debugging of URL Rewrite filter, set the ##logLevel## parameter as described in https://tuckey.org/urlrewrite/manual/5.1/index.html#filterparams (using the value ##sysout:DEBUG##, the logs can be read in tomcat logs). | ||
| 164 | |||
| 165 | === Apache === | ||
| 166 | |||
| 167 | Strategy: | ||
| 168 | |||
| 169 | * Tell Apache that ##/skins## and ##/resources## URLs are served statically so that they don't go through the Servlet container | ||
| 170 | * Configure ##web.xml## so that ##/*## URLs go through the Action Servlet | ||
| 171 | * Tell XWiki to not generate URLs with ##bin## in the path | ||
| 172 | |||
| 173 | Configuration steps: | ||
| 174 | |||
| 175 | * Setup the following Apache configuration:((( | ||
| 176 | {{code language="apache"}} | ||
| 177 | Alias /skins /usr/local/xwiki/skins | ||
| 178 | Alias /resources /usr/local/xwiki/resources | ||
| 179 | |||
| 180 | RewriteEngine on | ||
| 181 | |||
| 182 | RewriteRule ^/+skins - [L] | ||
| 183 | RewriteCond %{REQUEST_URI} !\.gwtrpc$ | ||
| 184 | RewriteRule ^/+resources($|/.*) - [L] | ||
| 185 | |||
| 186 | ## For some reason, the "/" end points does not work with tomcat, so the workaround is to rewrite it to /Main | ||
| 187 | RewriteRule ^/*$ http://localhost:8080/Main/ [P,L] | ||
| 188 | ## For all other URLs, we go to tomcat | ||
| 189 | RewriteRule .* http://localhost:8080%{REQUEST_URI} [P,L] | ||
| 190 | ProxyPassReverse / http://localhost:8080/ | ||
| 191 | {{/code}} | ||
| 192 | ))) | ||
| 193 | * Edit ##web.xml## and add:((( | ||
| 194 | {{code language="xml"}} | ||
| 195 | <servlet-mapping> | ||
| 196 | <servlet-name>action</servlet-name> | ||
| 197 | <url-pattern>/*</url-pattern> | ||
| 198 | </servlet-mapping> | ||
| 199 | {{/code}} | ||
| 200 | ))) | ||
| 201 | * Add the following in ##xwiki.cfg## (empty value after the equal sign):((( | ||
| 202 | {{code language="none"}} | ||
| 203 | xwiki.defaultservletpath= | ||
| 204 | {{/code}} | ||
| 205 | ))) | ||
| 206 | |||
| 207 | === Nginx === | ||
| 208 | |||
| 209 | The strategy is almost identical to the Apache strategy above, except of course for the first step which is the configuration file for Nginx. | ||
| 210 | |||
| 211 | Full Nginx configuration: | ||
| 212 | |||
| 213 | {{code language="nginx"}} | ||
| 214 | server { | ||
| 215 | listen 80; | ||
| 216 | server_name domain.tld; | ||
| 217 | return 301 $scheme://www.domain.tld$request_uri; | ||
| 218 | } | ||
| 219 | |||
| 220 | server { | ||
| 221 | listen 80; | ||
| 222 | server_name www.domain.tld; | ||
| 223 | |||
| 224 | charset utf-8; | ||
| 225 | |||
| 226 | # Configuration to avoid error 413: Request Entity too large. | ||
| 227 | client_max_body_size 0; | ||
| 228 | |||
| 229 | # Serve the following URLs statically instead of through the servlet container. | ||
| 230 | location /skins { | ||
| 231 | alias /usr/lib/xwiki/skins; | ||
| 232 | } | ||
| 233 | |||
| 234 | location /resources/uicomponents { | ||
| 235 | alias /usr/lib/xwiki/resources/uicomponents; | ||
| 236 | } | ||
| 237 | |||
| 238 | location /resources/js { | ||
| 239 | alias /usr/lib/xwiki/resources/js; | ||
| 240 | } | ||
| 241 | |||
| 242 | location /resources/css { | ||
| 243 | alias /usr/lib/xwiki/resources/css; | ||
| 244 | } | ||
| 245 | |||
| 246 | location /resources/icons { | ||
| 247 | alias /usr/lib/xwiki/resources/icons; | ||
| 248 | } | ||
| 249 | |||
| 250 | # Remove the "/bin" part from the URL by a rewrite. | ||
| 251 | location /bin { | ||
| 252 | rewrite ^/bin/(.*)$ /$1 permanent; | ||
| 253 | } | ||
| 254 | |||
| 255 | # Rewrite the empty ("/") endpoint to "/Main", so to accommodate Tomcat. | ||
| 256 | location = / { | ||
| 257 | return 301 $scheme://$server_name/Main; | ||
| 258 | } | ||
| 259 | |||
| 260 | # Passing requests to the proxied Tomcat Server. | ||
| 261 | location / { | ||
| 262 | # Redirect root and beyond to backend. | ||
| 263 | proxy_pass http://localhost:8080/; | ||
| 264 | proxy_set_header X-Real-IP $remote_addr; | ||
| 265 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; | ||
| 266 | proxy_set_header Host $http_host; | ||
| 267 | proxy_set_header X-Forwarded-Proto $scheme; | ||
| 268 | } | ||
| 269 | } | ||
| 270 | {{/code}} | ||
| 271 | |||
| 272 | == III. action name == | ||
| 273 | |||
| 274 | The third part, ##/view/##, identifies the action that should process a request. So this tells what we want to do with the document, ##/view/## it, ##/edit/## it or ##/delete/## it, for example. | ||
| 275 | |||
| 276 | It's possible to configure XWiki to allow omitting this action when you wish to imply ##view## and also to have XWiki generate URLs without the ##view## action. This is achieved by editing ##xwiki.cfg## and setting {{code language="none"}}xwiki.showviewaction=0{{/code}}. | ||
| 277 | |||
| 278 | {{info}} | ||
| 279 | Before XWiki 7.2 and Nested Pages, XWiki was supporting dropping ##view## in the URL without changing the configuration. However this was broken in 7.2 in order to support Nested Pages. | ||
| 280 | {{/info}} | ||
| 281 | |||
| 282 | == IV. Error Page == | ||
| 283 | |||
| 284 | At the ##WEB-INF/web.xml##, the ##location## of the 404 error code needs to be changed accordingly. For example: | ||
| 285 | |||
| 286 | {{code language="xml"}} | ||
| 287 | <error-page> | ||
| 288 | <error-code>404</error-code> | ||
| 289 | <!--<location>/xwiki/bin/view/Main/DocumentDoesNotExist</location>--> | ||
| 290 | <location>/bin/Main/DocumentDoesNotExist</location> | ||
| 291 | </error-page> | ||
| 292 | {{/code}} | ||
| 293 | |||
| 294 | == V. Conclusion == | ||
| 295 | |||
| 296 | After performing all these changes, you should be able to access documents with URLs like: | ||
| 297 | |||
| 298 | * server.com/Space/Document | ||
| 299 | * server.com/Space/ (pointing to Space.WebHome) | ||
| 300 | * server.com/Document (pointing to Main.Document) | ||
| 301 | * server.com/ will show Main.WebHome, without any redirect. | ||
| 302 | |||
| 303 | As a bonus, these changes are backwards compatible, meaning that any currently working URL will also work with these changes performed, so you won't have any broken bookmarks. | ||
| 304 | |||
| 305 | == Other solutions == | ||
| 306 | |||
| 307 | Some XWiki users have contributed other solutions but they've not been verified by a XWiki Development Team member at this stage so use at your own risk ;) | ||
| 308 | |||
| 309 | * [[Lighttpd + Jetty>>dev:Drafts.ShortURLsLighttpdJetty]] | ||
| 310 | * [[Apache + Tomcat>>http://odo.lv/Recipes/XWikiShortURLs?language=en]] |
