#31 Apache Server Configuration and the workings of the .htaccess file

Apache HTTP Server (commonly called "Apache") is one of the world's most popular web server software solutions, powering approximately 30% of all websites on the internet. This article will explain how Apache works, its basic configuration, and focus particularly on the role and structure of .htaccess files in Apache environments.

What is the Apache HTTP Server?

Apache is an open-source web server application that plays a critical role in delivering web content to users. Developed and maintained by the Apache Software Foundation, it can run on various operating systems including Unix/Linux, Windows, and macOS.

How Apache Works

At its core, Apache functions through a request-processing cycle:

1. Connection Acceptance: Apache listens for incoming HTTP requests on designated ports (typically port 80 for HTTP or 443 for HTTPS).

2. Request Processing: When a request arrives, Apache parses the HTTP headers and determines how to handle it based on its configuration.

3. Content Delivery: The server locates the requested resource (HTML files, images, etc.) and sends it back to the client with appropriate HTTP headers.

4. Connection Handling: Apache can handle multiple simultaneous connections using different processing models (prefork, worker, or event MPM).

Apache Server Configuration

Apache's primary configuration is controlled through several key files, typically located in /etc/apache2/ or /etc/httpd/ depending on your operating system:

• httpd.conf: The main configuration file containing global settings
• apache2.conf: Alternative main configuration file name on some distributions
• conf.d/: Directory containing modular configuration files
• sites-available/: Directory containing configuration for virtual hosts
• sites-enabled/: Symbolic links to enabled virtual host configurations

Key Configuration Directives

Apache uses directives to configure its behavior. Some important ones include:

• ServerRoot: Base directory for the server
• DocumentRoot: Directory where website files are stored
• Listen: IP addresses and ports Apache listens on
• ServerName: Domain name of the server
• VirtualHost: Configuration for hosting multiple websites on a single server
• Directory: Configuration for specific directories

Understanding .htaccess Files

The .htaccess (hypertext access) file is a directory-level configuration file that allows for decentralized management of web server configuration. It's particularly useful in shared hosting environments where users don't have access to the main server configuration files.

Purpose of .htaccess Files

.htaccess files can be used for:

1. URL Rewriting and Redirection: Modifying URLs for better usability or SEO
2. Access Control: Restricting access to certain pages or directories
3. Custom Error Pages: Defining specific pages for HTTP errors
4. MIME Type Handling: Determining how to serve different file types
5. Performance Settings: Configuring caching and compression

Where to Place .htaccess Files

The location of .htaccess files is crucial for understanding their scope and effect:

• Document Root: When placed in the server's document root directory, the .htaccess file affects the entire website.
• Subdirectories: When placed in subdirectories, the file's rules apply only to that directory and all its subdirectories.
• Cascading Effect: Multiple .htaccess files can exist in a directory hierarchy, with each one applying its rules in addition to (or overriding) the rules from parent directories.

For instance, if you have a website with this structure:

/var/www/html/           # Document root with a .htaccess file
/var/www/html/blog/      # Blog directory with its own .htaccess file
/var/www/html/shop/      # Shop directory with its own .htaccess file

When a user requests /blog/post1.html:

1. Apache first processes the .htaccess in the document root
2. Then it processes the .htaccess in the /blog/ directory
3. Rules in the /blog/.htaccess file can override similar rules in the root .htaccess

This hierarchical processing allows for very granular control over different sections of your website.

How .htaccess Works

When a client requests a resource, Apache checks for .htaccess files in each directory from the document root to the directory containing the requested file. The configurations are applied cumulatively, with more specific (deeper) directory settings overriding earlier ones.

Analyzing Our Example .htaccess File

Let's break down the sample .htaccess file provided:

# .htaccess file

RewriteEngine on

This first line enables Apache's rewrite engine, which is necessary for all the URL manipulation rules that follow.

# Redirect non-www to www for example-domain.com
RewriteCond %{HTTP_HOST} ^example-domain\.com$
RewriteRule (.*) http://www.example-domain.com/$1 [R=301,L]

This section creates a canonical URL structure by redirecting requests from example-domain.com to www.example-domain.com. The [R=301,L] flags indicate that this is a permanent redirect (HTTP 301) and that this is the last rule to be processed if the conditions match.

# Map www.example-domain.com to gambio-example subfolder
RewriteCond %{HTTP_HOST} ^www\.example-domain\.com$
RewriteCond %{REQUEST_URI} !^/gambio-example/
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ /gambio-example/$1 [L]

This more complex section implements URL mapping for content separation. It checks if:

1. The host is www.example-domain.com
2. The request URI doesn't already start with /gambio-example/
3. The requested file doesn't exist (!-f)
4. The requested directory doesn't exist (!-d)

If all these conditions are met, it internally rewrites the request to the gambio-example subdirectory. This allows for serving content from a subdirectory while presenting it as if it were at the root of the domain.

# Handle root domain case for example-domain.com
RewriteCond %{HTTP_HOST} ^www\.example-domain\.com$
RewriteRule ^$ /gambio-example/index.php [L]

This rule handles requests to the root of www.example-domain.com by directing them to /gambio-example/index.php, ensuring the homepage works correctly.

The file continues with similar rules for another domain (example2.com), showing how multiple websites can be configured within a single .htaccess file:

# Map example2.com to its subfolder (add more domains as needed)
RewriteCond %{HTTP_HOST} ^(www\.)?example2\.com$
RewriteCond %{REQUEST_URI} !^/example2-subfolder/
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ /example2-subfolder/$1 [L]

# Handle root domain case for example2.com
RewriteCond %{HTTP_HOST} ^(www\.)?example2\.com$
RewriteRule ^$ /example2-subfolder/index.php [L]

Note that the example2.com rules handle both the www and non-www versions with a single condition using the (www\.)? pattern, which is a more concise approach than used for the first domain.

# Any other domains will be served from the document root as normal
# No additional rules needed for domains that should go to the root

The final comment indicates that any domains not explicitly handled by the previous rules will be served content from the document root directory as normal.

Effects of .htaccess Placement in This Configuration

In our example file, the location of the .htaccess file has significant implications:

1. Document Root Placement:

- This .htaccess file should be placed in the document root of the server.
- From this position, it can intercept and process all incoming requests to any domain hosted on this server.
- It can then route these requests to the appropriate subdirectories based on domain names.

1. Subdirectory Impact:

- If this exact .htaccess were placed in a subdirectory (e.g., `/gambio-example/`), the domain-level rewrites would not work correctly because the rules would only be applied after Apache has already determined which directory to use.
- Domain-level routing decisions must be made at the document root level.

1. Multiple .htaccess Approach:
   • A more modular approach would be to have a simpler .htaccess in the document root handling only the domain routing, and then separate .htaccess files in each subdirectory handling specific rules for each website.
   • This would make maintenance easier, especially with multiple websites.

For example:

• Document root .htaccess: Handles routing requests to the correct subdirectories
• /gambio-example/.htaccess: Contains rules specific to the example-domain.com website
• /example2-subfolder/.htaccess: Contains rules specific to the example2.com website

Key Concepts in This .htaccess Configuration

1. Multi-domain Hosting: This configuration shows how a single Apache server can host multiple websites (example-domain.com and example2.com).

2. Domain Canonicalization: Enforcing a consistent URL structure (www vs. non-www).

3. Directory Mapping: Serving content from subdirectories while presenting them as if they were at the root.

4. Conditional Processing: Using multiple RewriteCond directives to create complex, specific matching patterns.

5. Flag Usage: The [L] flag stops processing rules when a match is found, and [R=301] creates permanent redirects for SEO benefits.

Best Practices for .htaccess Files

1. Performance Considerations: .htaccess files are read on every request, so use them judiciously in high-traffic environments.

2. Security: Protect .htaccess files from being directly accessed by setting appropriate file permissions (typically 644).

3. Backup: Always back up working .htaccess files before making changes.

4. Testing: Test modifications thoroughly in a development environment before deploying to production.

5. Documentation: Comment your .htaccess rules to explain their purpose and function.

6. Scope Appropriately: Place rules at the appropriate level in the directory hierarchy - only use document root level for rules that need to apply site-wide.

Conclusion

Apache HTTP Server provides a powerful and flexible platform for serving web content. The .htaccess file offers a convenient way to implement specific configurations at the directory level, especially for URL manipulation, access control, and multi-domain hosting.

The example .htaccess file we analyzed demonstrates how to manage multiple websites from a single Apache installation, implementing common patterns like domain canonicalization and subdirectory mapping. Understanding the crucial relationship between .htaccess file placement and its scope of effect is essential for effectively managing and optimizing Apache web servers in various hosting environments.

Read this article and more on fzeba.com.