How do I add a userscript installation button to my web page?

Question

I need to host a userscript on an internal company website. How do I build the href so that Greasemonkey will install the userscript when the link is clicked?

I tried a simple <a href="user.js">Install Userscript</a> but Chrome and Firefox simply show the file source instead of installing the userscript.

Answer 1

Your link should look like:

<a href="https://example.com/your_script.user.js">Click to install script X</a>
<small>(A userscript engine, like Tampermonkey, is required.)</small>

---

In order for your install link to work, the following conditions must be met:

1. The filename must end in .user.js. Example: stack_exchange_edit_reasoner.user.js
2. The browser must be running a compatible userscript extension. For example, Tampermonkey or Greasemonkey.
3. The file must NOT be served with text/html content type. (You would have to tamper with your server's default settings for this to be an issue.)

Also, if you wish for automatic updates to work, the script should be served via an https link (or it gets complicated).