Deploy on an Apache web server (httpd)

Skip To Article

Once you have built a static version of your MyST project via myst build --html, it can be served on an Apache web server (httpd) instance.

For example, let’s assume your web server’s base URL is http://www.example.com and it uses /var/www/html as its DocumentRoot. If you copy the _build/html/ directory to /var/www/html/my-project using

cp -r _build/html /var/www/html/my-project

then the resulting URL would be http://www.example.com/my-project.

Enable automatic .html file suffixes

myst build --html will produce HTML-formatted files that have .html as their suffix for .md and (if you choose to execute Jupyter notebooks) .ipynb files that you list in your project’s table of contents.

However, the links that are generated will not have .html as part of their HREFs. You will need to enable the MultiViews option in your Apache httpd configuration file to make these links work properly.

For example, assuming your httpd configuration file lives in /etc/httpd/conf/httpd.conf, add the following stanza, and then reload/restart your Apache web server:

<Directory "/var/www/html/">
    Options MultiViews
</Directory>

Tip

You may also need to add the line:

LoadModule negotiation_module modules/mod_negotiation.so

to your httpd configuration. In RHEL-like Linux distributions, this line is already included in the httpd RPM package, in /etc/httpd/conf.modules.d/00-base.conf.

Community-driven tools for the future of technical communication and publication, part of Jupyter.

Our Team Compass Blog

Code of Conduct