Publishing a Website on Bitbucket Cloud

Static sites hosted on Bitbucket Cloud can now be accessed at bitbucket.io. They will remain available at bitbucket.org until March 1, 2017. No action is required for static site owners beyond updating your links to point to https://<yoursitename>.bitbucket.io. Please note that HTTPS is required for bitbucket.io for your security.

You can use Bitbucket to host a static website. A static website contains coded HTML pages with fixed content. Websites hosted in this way have the bitbucket.io domain in their URL, for example, https://tortoisehg.bitbucket.io.

Publishing a static website on Bitbucket Cloud requires you to combine your account's name with the bitbucket.io domain suffix. So, your account's name must be acceptable to your DNS service. Upper case characters and special characters are typically not acceptable. For example, if your account's name is happy_cat, you would need to create a new account with a username of happycat to use this feature because underscores are not allowed in DNS hostnames. Your repository name would be happycat.bitbucket.io and the published static website is reached by this URL: https://happycat.bitbucket.io

The following topics appear on this page: 

Configure a Website for Hosting

To use this feature, do the following:

  1. Log into your Bitbucket account.
    Create a repository and making sure to Name it using the following format: accountname.bitbucket.org.

    The repository name needs to include the trailing bitbucket.org. For example, if your accountname (which can be your individual account or teamname) is tutorials  your repository Name should be this tutorials.bitbucket.org.

  2. Clone your repository to your local system.
  3. Create  an index.html file in the repository root.
    Keep in mind the names are case sensitive; Bitbucket treats index.html and Index.html as different file names. Make sure your file is named index.html – all lowercase.
  4. Add index.html file to your repository, commit the change, and push the result to Bitbucket.
  5. Navigate to the  https://accountname.bitbucket.io site.
    For example, if your username is is tutorials you would navigate to https://tutorials.bitbucket.io. The system displays the HTML in the site's index.html.  

Technical Features and Limitations of this Feature

Static websites on Bitbucket support the following features:

  • Embedding images and other media. 
  • Inclusion of JavaScript in your HTML pages.
  • Blog comments by embedding Disqus in your site.

This feature turns a repository into a plain static webserver that uses the repository's root as the web root. The system does not issue cookies for these domains. Server-side scripts or code are not supported. You cannot use PHP or other server-side scripting languages on the site.

Finally, Atlassian injects a rum.js script into each Bitbucket website. This script captures internal web analytics and statistics.

Hosting Multiple Projects Under a Single Website

You may have multiple projects that you want to host from the same Bitbucket websites, you can do this by placing each project in a repository subdirectory. In this example, you would want to organize things such that you can point users to:

  • https://accountname.bitbucket.org/subdir1forproject1
  • https://accountname.bitbucket.org/subdir2forproject2
  • https://accountname.bitbucket.org/subdir3forproject3

Each project sub-directory would act as a self-contained website with its own index.html.

Bitbucket is forgiving with regard to trailing slashes: a request to https://accountname.bitbucket.io/projectX/ with result in projectX/index.html being served (if such a file exists), regardless of whether the trailing slash is included in the URL.

Public and Private Repositories and Static Websites

The static website you create with this feature is just like any other website on the Internet — anyone with the URL (address) can visit and view your static website.  The underlying Bitbucket repository can be a public repository or a private repository.  This means if your Bitbucket repository is private, users can still visit and view the static website.  The same is true if the underlying repository is public.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport