What is MIME type "text/x-hcl"?

A MIME type is a string that tells browsers and other tools how to handle a particular kind of file.

text/x-hcl is the MIME type for files written in the HashiCorp Configuration Language.
It marks plain text files as configuration files used in infrastructure management and automation.
This language is popular with tools from HashiCorp. It is essential in creating and managing infrastructure definitions. Files written in this language can control cloud components and software setups.

Infrastructure as Code – Enables clear, text-based configuration for automating server and cloud setups.
Application Configuration – Simplifies defining settings for various software environments.
Tool Integration – Supports products like Terraform in orchestrating resource provisioning.

Files using this MIME type often have the configuration file formats indicated by the extensions TF and HCL.
Learn more about the language and its uses at HashiCorp and Terraform Docs.

Associated file extensions

.tf, .hcl

Usage Examples

HTTP Header

When serving content with this MIME type, set the Content-Type header:


    Content-Type: text/x-hcl

HTML

In HTML, you can specify the MIME type in various elements:


    <a href="file.dat" type="text/x-hcl">Download file</a>

Server-side (Node.js)

Setting the Content-Type header in Node.js:


    const http = require('http');    
    
    http.createServer((req, res) => {    
      res.setHeader('Content-Type', 'text/x-hcl');    
      res.end('Content here');    
    }).listen(3000);

Associated file extensions

.tf, .hcl

FAQs

What is the purpose of the text/x-hcl MIME type?

The MIME type text/x-hcl classifies files written in the HashiCorp Configuration Language (HCL). These are plain text configuration files, most commonly used with Terraform to define infrastructure as code (IaC) or with other tools like Vault and Consul.

Which file extensions are associated with text/x-hcl?

This MIME type is primarily associated with the .tf extension used by Terraform. It is also used for generic HCL configuration files ending in .hcl.

How do I open or edit a text/x-hcl file?

Since these are plain text files, you can open them with any standard text editor like Notepad or TextEdit. For the best experience, use a code editor like VS Code or Sublime Text with an HCL or Terraform plugin installed for syntax highlighting.

How do I configure Nginx to serve .tf and .hcl files correctly?

To serve these files with the correct MIME type, add the definition to your mime.types file or inside a server block. Use the directive: text/x-hcl tf hcl; to ensure browsers and clients interpret them as HCL configurations.

Are there security risks in serving text/x-hcl files publicly?

Yes. Terraform and HCL files describe your infrastructure architecture and may inadvertently contain sensitive configuration details. Unless you are hosting a public code repository or documentation, you should generally configure your web server to block access to .tf and .hcl files.

Why does my browser display the file as plain text?

The text/ prefix in text/x-hcl indicates to the browser that the content is human-readable text. Most browsers will render the raw code in the window rather than downloading it, similar to how they handle text/plain.

Is text/x-hcl a standard IANA MIME type?

No, the x- prefix indicates that it is a non-standard or experimental type. While not officially registered with IANA, it is the widely accepted convention for identifying HashiCorp configuration files on the web.

General FAQ

What is a MIME type?

A MIME (Multipurpose Internet Mail Extensions) type is a standard that indicates the nature and format of a document, file, or assortment of bytes. MIME types are defined and standardized in IETF's RFC 6838.

MIME types are important because they help browsers and servers understand how to process a file. When a browser receives a file from a server, it uses the MIME type to determine how to display or handle the content, whether it's an image to display, a PDF to open in a viewer, or a video to play.

MIME types consist of a type and a subtype, separated by a slash (e.g., text/html, image/jpeg, application/pdf). Some MIME types also include optional parameters.

How do I find the MIME type for a file?

You can check the file extension or use a file identification tool such as file --mime-type on the command line. Many programming languages also provide libraries to detect MIME types.

Why are multiple MIME types listed for one extension?

Different applications and historical conventions may use alternative MIME identifiers for the same kind of file. Showing them all helps ensure compatibility across systems.