Overview - Pages for Bitbucket

Owned by Gabriela Costa
Last updated: Sept 14, 2023 by Jeff Gleeson
2 min read

Pages for Bitbucket provides a simple way to publish web pages in Bitbucket for any existing branch or tag. View HTML files of this branch or tag files directly in Bitbucket. Using relative links, you can also link to other HTML files or resources like CSS, JavaScript, or images.

Pages for Bitbucket allows you to host HTML pages right on your Bitbucket instance and supports Javascript and serves unique pages on a repository basis.

Feature Highlights

  • Simple web hosting - Host simple websites directly in Bitbucket

  • Commit and Publish - Edit and push, and your changes are live

  • Version control - Automatic version control by Git

  • Static web pages for every branch - Enable serving of static web pages per branch or tag

  • Access control - Access control is based on repository permissions

  • Relative links - Supports relative links and files stored in Git LFS

  • Configurable navigation button - Select a branch you want to be accessible in the left navigation bar

How it works

You can enable the serving of static web pages for any existing branch or tag in the repository settings screen. Once enabled, the base URL for pages in this branch or tag is displayed next to the branch or tag name.

Web pages are available under the following URL: /pages/<PROJECT>/<REPOSITORY>/<BRANCH-OR-TAG>

If there is no index.html file available in the root level of a branch or tag, link to the page directly by appending the file path to the URL. Example: /pages/<PROJECT>/<REPOSITORY>/<BRANCH-OR-TAG>/browse/<PATH>/<TO>/<FILE>.html

Once pages have been enabled for a branch or a tag, you can view HTML files of this branch or tag directly in Bitbucket. Click Open in the file browser of this branch or tag to render the page full screen, without the Bitbucket layout. It's also possible to link to other HTML files or resources like CSS, JavaScript, or images using relative links. You can even link to files stored in Git LFS.

Hosting your web pages directly in Bitbucket also gives you automatic version control by Git.

Security

Access to web pages is based on repository permissions. Users need at least read access to the repository to view web pages in Bitbucket. For security reasons, by default, pages are unavailable for branches or tags in personal repositories. But in the plugin settings, you can configure which groups can enable pages in personal repositories.

XSS Attacks

We've added an option to disable JavaScript on rendered pages to reduce the risk of allowing potentially malicious content in git repositories. You can disable JavaScript either on a global level or a repository level.

Another method for reducing the risk of XSS vulnerability is to configure an external domain.