Skip to main content

The PreTeXt Guide

Robert A. Beezer, David Farmer, Alex Jordan, Mitchel T. Keller

Chapter 39 Hosting Your Online Version

You have HTML output, and now where do you put it? A fundamental design decision is that you only need to simply upload your HTML files to a hosting service and since all the links are relative, readers should be able to read your whole book with no more effort than that from you. By design, no extraordinary configuration or privileges are necessary on the server.
Users of the PreTeXt-CLI (Section 5.2) have access to pretext deploy, which walks users through the process of deploying their document to the free GitHub Pages
 1 
pages.github.com/
service, even if they don’t manually manage their Git revision history.
Otherwise, for the choice of a hosting service you may have a fundamental decision to make. Mostly this applies to authors who are employees of an institution, yet have the freedom to control the copyright on their scholarly work. But there is information here for independent scholars and for other employees.
  • You love your institution, and plan to stay for a good long time. They have implicitly (or explicitly) supported your project with time and/or money. A URL with the insitution’s domain name on a freely-accessible project is good advertising for the institution. Bandwidth is huge, IT is super reliable and helpful, all this is no-cost to you. Read the next scenario, but you have a good situation, so you might as well use it.
  • You are not really attached to your institution, and five years from now you may be somewhere else. Consider hosting your project externally, so it is not tied to your institution.
    Or maybe policy on faculty web pages, or crummy content management systems, make it difficult or impossible to host your project. Or it is buried five levels deep with an impossible URL. Point out the situation to your Provost or Dean, with examples of how other institutions do it right. Remember that your colleagues may be writing monographs and textbooks for commercial publishers, likely with institutional support, and selling their copyright. Your institution should be proud to host your project prominently. If a reasoned, rational approach does not improve the situation, then consider hosting your work elsewhere.
If you are hosting at your institution, that is a great outcome. There is no cost to you, and everybody is happy. Lobby for a great URL, like platypus.mammal-institute.org and the rest should take care of itself. The rest of this section is about the second situation.
To arrange hosting yourself,
  1. Purchase a domain name, it should not be a real big annual expense. Choose something professional, rather than just your name (though your name does have a natural appeal). And maybe something general enough that you can host your next book under that same domain name. The idea here is to own the domain name, so your book can move anywhere, but that domain name will always point to the book. This name should be owned and controlled by you, not your institution, not GitHub, not 5GBFree.com.
  2. Sign up for, and perhaps pay for, a hosting service that lets you point your domain name at the site.
    • Oscar Levin explains that GitHub Pages
       2 
      pages.github.com/
      is free, super-easy to use if you already use git, and makes using your domain name (“custom URL”) nearly trivial. (2017-09-08)
    • Mitch Keller likes the “Swift” plan at A2 Hosting
       3 
      www.a2hosting.com/web-hosting
      at about $60 annually. (2017-07-05)
Now you are set, and control distribution of your scholarly publication. If you are bothered by the thought of having expenses while you make your work freely available to the world, then consider generating some modest income. For example, sell Google ads against your pages. (Why should this disturb anybody? I don’t get it.) Or roll a small royalty into the print-on-demand version, see Chapter 43.
There are a few practical details to think about. Eventually others will link to your book, and you will also release updates. First, think about creating a simple high-level directory that will be stable, short, easy to type, and easy to remember. Controlling your domain name (above) is the first step. Then consider that you may also distribute a PDF version, and you may someday write a second book. So, for example, your URL might look like:
https://platypus.mammal-institute.org/aota/html
https://platypus.mammal-institute.org/aota/aota.pdf
For the first URL, the html directory would contain all of the PreTeXt HTML output, and especially, an index.html file which most any web server will serve up when the URL ends with a directory. PreTeXt has tools to help you with creating the index.html file.
An improvement on the above is to have stable generic URLs for the current version, and dated, or versioned, URLs for older versions you may wish to keep in place (as a record, or for instructors who want to stick with an old version). It is a bit more work to maintain, but will lessen the frequency that an old version of your work is promoted as the last word.
https://platypus.mammal-institute.org/aota/latest
https://platypus.mammal-institute.org/aota/aota.pdf
https://platypus.mammal-institute.org/aota/html-2017-08-15
https://platypus.mammal-institute.org/aota/aota-2017-08-15.pdf
PrevTopNext