XeNote/posts/Licenses & add-on services/Obsidian Publish.md

Obsidian Publish™ is a paid hosting service for your notes.

For instructions on how to publish your notes from within the Obsidian app, refer to the Publish.

Privacy

You have total control over what to publish via the Publish - either your entire vault or just selected notes within your vault. As for any notes you choose not to publish, you can be confident that those notes remain completely private, and Obsidian Publish has no knowledge of them.

Backing up

Please note that Obsidian Publish is not to be used as a backup for your content. Make sure you always have a personal backup copy of your site using your preferred backup method. Our efforts on Obsidian Publish will be more focused on functionality, ease of use, and site availability.

Demo

There's a good chance that you're already viewing this article on our official site powered by Obsidian Publish.

If not, you can visit it here: https://publish.obsidian.md/help.

What's included

The Obsidian Publish service lets you create your site directly from within the Obsidian app by choosing the notes you want to publish.

To customize your site, you can choose between light and dark mode, and also toggle between readable line length and full page length.

There are several components which can be turned on or off from the Publish. Changes to these options will be reflected on your published site once the cache clears, typically within 5 minutes.

Navigation

Enabling this option adds a navigation sidebar displaying all published pages and the folders that contain them. Viewers will see the current open note highlighted, and can click on any other note to navigate.

Search bar

Adds a search bar to page. This bar can be used to search for pages, aliases, and headings within pages. It does not currently search through the full text content of the site.

Graph view

Displays a local graph of the page currently open. This uses the same rendering engine as the Graph view plugin in Obsidian.

Table of contents

Displays a table of contents for the page currently open. The list is generated from headings within the page, similar to the Outline plugin. Viewers navigating the note will see the corresponding heading highlighted as they scroll, and can click on another heading to immediately navigate to it.

Backlinks

Displays a section at the end of each page called "Linked to this page", containing backlinks from other pages. If there are no backlinks, the section will not be displayed.

Tags

When the reader clicks on a tag, they can see a list of other pages that includes the same tag.

Hover preview

When hovering over links, their content is displayed within a popup box. This works similarly to the Page preview plugin in Obsidian.

Custom CSS

To customize the styling of your site, you can upload a publish.css. This file must be stored in the root folder of your site. You can use your existing theme and add some extra tweaks for publish in publish.css.

Favicon

To change the favicon of your site, you can upload png icons of any size in the format of favicon-32.png or favicon-32x32.png. You can also upload the file favicon.ico. These files can be stored in any folder. The current recommendation (as of 2020) is to provide sizes 32×32, 128x128, 152×152, 167x167, 180x180, 192x192, and 196x196.

Custom JS

If you wish to execute your own JavaScript code to change the visitor experience, or add various integrations like Discus!, Discourse, etc. you can do so by uploading publish.js inside the root of your vault. Note that these scripts will only run for visitors to your custom domain.

Disallow search engine indexing

This option adds a meta noindex tag to all your pages so search engines like Google does not index your site. Note that search engines won't be able to index your site anyway if it's password protected.

Google Analytics

If you wish to setup Google Analytics for your site, first make sure your local laws and regulations allows. Then, you just need to put the tracking code, in the form of UA-XXXXX-Y into the text box and your site will automatically track page views. Note that Google Analytics is only available to visitors from your custom domain.

When testing Google Analytics, please make sure to disable any ad-blocking browser extensions like uBlock Origin which blocks Google Analytics scripts from running.

Also, Obsidian Publish isn't directly compatible with Google Tag Manager at the moment - you can set it up using custom javascript if you wish to use Google Tag Manager instead of Google Analytics.

Custom domain

You can setup a custom domain or subdomain for your Obsidian Publish site. Currently, we don't yet have a way to provision SSL certificate on your behalf, so you need to resort to either an SSL-enabled server of your own, or to setup your site on CloudFlare, which provides SSL for free.

You can also setup Obsidian Publish as a sub-URL of a site you own. For example, https://mysite.com/my-notes/. To achieve this, you must host your own server and proxy all requests to our server at https://publish.obsidian.md/.

Continue reading for setup details.

CloudFlare setup

The easiest way to setup a custom domain or subdomain is by making an account with CloudFlare and letting CloudFlare manage your domain. This allows you to add SSL to your site for free, as well as ensure your site is fast wherever in the world it's accessed from. Typically users will host their Obsidian Publish content on a root domain (e.g. mysite.com) or an immediate subdomain (e.g. notes.mysite.com). These instructions work for both cases.

1. Open Cloudflare to the domain you wish to add Publish to (e.g. mysite.com, even if you want a subdomain like notes.mysite.com).
2. Go to DNS and click Add Record. Select CNAME, and in 'name' enter the domain or subdomain you wish (e.g. notes.mysite.com). In 'target', enter the value publish-main.obsidian.md. Do not include your personal sub-URL in this value, as Obsidian Publish handles this from your configuration.
3. Go to SSL/TLS and set the SSL/TLS encryption mode to Full. This will configure the SSL/TLS certificate automatically.

Once you are done with configuring CloudFlare, you can head to your site options in Obsidian, and set the URL to your domain or subdomain. This allows our server to associate the domain to your site.

Troubleshooting: If your custom domain setup ends up in a redirect loop, it's likely that the encryption mode in CloudFlare to Flexible instead of Full.

If you wish to configure both mysite.com and www.mysite.com to Obsidian Publish, you will need to create a Page Rule as follows:

• URL match: www.mysite.com/*
• Foward URL - 301 Permanent Redirect
• Redirect URL: https://mysite.com/$1

Once you create the page rule, you should also create a CNAME record for www.mysite.com just like you created for mysite.com

Proxy/redirect setup

If you wish to host your own web server and setup your own SSL encryption, you can choose this option. If you are already hosting a website under your domain or subdomain, you can also use this option and setup your website to load your Obsidian Publish site under a specific URL path, instead of hosting the full site.

Simply proxy all requests under that URL path to https://publish.obsidian.md/serve?url=mysite.com/my-notes/... and configure the site options in Obsidian to the same URL path by setting Custom URL to mysite.com/my-notes.

NGINX

location /my-notes {
  proxy_pass https://publish.obsidian.md/serve?url=mysite.com/my-notes/;
  proxy_ssl_server_name on;
}

Apache

Add to .htaccess:

RewriteEngine  on
RewriteRule    "^my-notes/(.*)$"  "https://publish.obsidian.md/serve?url=mysite.com/my-notes/$1"  [L,P]

Note: mod_rewrite must be enabled, and you may also need to configure SSLProxyEngine

Netlify

[[redirects]]
  from = "https://mysite.com/my-notes/*"
  to = "https://publish.obsidian.md/serve?url=mysite.com/my-notes/:splat"
  status = 200
  force = true

Vercel

In vercel.json configure rewrites:

{
  ...

  "rewrites": [
    {
      "source": "/my-notes/",
      "destination": "https://publish.obsidian.md/serve?url=mysite.com/my-notes"
    },
    {
      "source": "/my-notes/:path*",
      "destination": "https://publish.obsidian.md/serve?url=mysite.com/my-notes/:path*"
    }
  ]
}

Supported HTTP X-Headers

Alternatively, if your proxy service does not allow query paths, you can use https://publish.obsidian.md/ with a custom header x-obsidian-custom-domain set to your site url mysite.com/my-subpath.

Custom domain post-setup issues

Once you setup your custom domain, if you've visited your site from your previous https://publish.obsidian.md/slug link, you may have to clear your browser cache for certain things (like fonts, graphs, or password access) to work properly. This is due to the cross-domain security restrictions that are imposed by modern browsers. The good news is that readers of your site should never run into issue this if you only let visitors use your custom domain.

Redirect old site to custom domain

If you'd like to redirect your visitors from the old publish.obsidian.md site to your new custom domain, there is an option you can enable in the custom domain settings page which will do just that.

Coming up

Obsidian Publish is still in its early days. Here are some features we plan to add:

• Full custom domain support (with SSL certificate provisioning).
• Full text search.
• More built-in themes.

Please let us know if you have any Obsidian Publish feature requests by submitting a forum request here.

Pricing

For the pricing of Obsidian Publish, please visit our pricing page.

Technical details

Obsidian Publish uses Cloudflare as the CDN (content delivery network) to distribute your site across the globe for a faster access. This involves caching copies of the files of your site on some of the 200+ data centers to ensure the lowest latency for your readers and the site remain speedy and loads fast even if your viewer lives far away from our primary servers.

However, this does mean that when you change site settings, publish new content, or unpublish content, visitors might not see the latest version for a short while. Currently, our cache is configured to persist for an hour before it has to be "re-validated" to ensure the content hasn't changed.

If you've just published items but you are still seeing an older version, you can typically perform a "hard refresh" by holding the reload button and choosing "Hard reload" in the dropdown menu. Failing that, you can try clearing the browser cache or disabling cache using the developer tools in the network tab.

Hosting media files

While Obsidian Publish allows you to upload video clips, it is not optimized for video delivery. As such, your visitors may find that the videos on your site may not deliver a great experience.

We recommend using a proper video hosting service like YouTube or Vimeo to host your videos for Obsidian Publish. The advantages of using a proper video hosting site includes:

• Automatic re-encoding ensures that your videos can be played on all mobile devices regardless of what encoding format you used in your original file.
• Dynamic quality adjustment based on bandwidth availability and ensures that videos can be played smoothly without constantly pausing for "buffering".
• High efficiency video compression to ensure that visitors don't blow through their data cap when viewing your site.
• Global CDN allowing your videos to be loaded fast regardless of where your visitor is located in the world.

---

Related

Refer to the Publish for details on publishing your notes.