Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 2.98 KB

URL_REWRITE.md

File metadata and controls

79 lines (54 loc) · 2.98 KB
Raw

URL REWRITING

The Bug Genie uses URL rewriting to make URLs look more readable. URL rewriting is what makes it possible to, instead of using URLs such as:

viewissue.php?project_key=projectname&issue_id=123

use URLs such as:

/projectname/issue/123.

It is important that The Bug Genie and your web server is correctly set up with url rewriting enabled for this to work.

You can read more about setting up URL rewriting, here:

We also provide documentation for setting up rewriting on other web servers at https://issues.thebuggenie.com/wiki/Category:TheBugGenie:HowTo

For Apache, it is enough that the rewrite module (mod_rewrite) is installed and enabled, and that the virtual host setup has set AllowOverride All for the folder The Bug Genie is located. With this setup, Apache should use the .htaccess file located inside the public/ folder.

If you for any reason cannot turn on AllowOverride All for that folder, look at the .htaccess file The Bug Genie bundles (located inside the public/ folder), and copy the necessary lines to your virtual host definition.

EXAMPLES

EXAMPLE 1: Virtualhost config

The Bug Genie is installed in /var/www/thebuggenie, and I want to set up a virtual host for The Bug Genie.

Apache setup

Set up the virtual host as usual, but point the DocumentRoot for The Bug Genie to the public/ subfolder inside the main folder. Make sure the apache virtual host setup has AllowOverride All for the folder where The Bug Genie is located, and make sure the .htaccess file inside the public/ folder is accessible to Apache.

If this is a permanent setup, you may also want to copy the .htaccess directives into the virtual host setup after verifying the installation works as expected.

The Bug Genie setup

Set the hostname to the public hostname where you plan to access The Bug Genie. With this setup, The Bug Genie will be located at the top level, so set the URL subdirectory to /, which means "top level".

EXAMPLE 2: Subfolder config

The Bug Genie is installed in /var/www/thebuggenie, and I want to access it as a subfolder of the DocumentRoot, which is /var/www

Apache setup

Make sure the apache host setup has AllowOverride All for the folder thebuggenie is located, and make sure the .htaccess file inside the public/ folder is accessible to Apache. You may want to copy the main folder content to a folder one level up (extract the main content of the top thebuggenie/ folder directly to /var/www), so that the public/ folder inside the main folder is accessible as /var/www/public.

The Bug Genie setup

Set the hostname to the public hostname where you plan to access The Bug Genie. With this setup, The Bug Genie will be located at either http://hostname/thebuggenie/public/ or http://hostname/public/ (see above), so set the URL subdirectory to /, which means "top level".