Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.54 KB

compatibility.md

File metadata and controls

66 lines (43 loc) · 2.54 KB

Compatibility

OS

You should be able to compile and run Rod seamlessly on all main platforms that Golang supports. This docker way is recommended to run Rod on a server. On some platforms, you might need to install the browser manually, Rod can't guarantee the auto-downloaded browser will always work. If you want Rod to support a platform, please raise an issue for it.

It's very easy to google how to install the browser on your system, for example, on Ubuntu or Debian you will find something like this to install the browser:

wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
apt install ./google-chrome-stable_current_amd64.deb

On CentOS:

wget https://dl.google.com/linux/direct/google-chrome-stable_current_x86_64.rpm
yum localinstall -y google-chrome-stable_current_x86_64.rpm

On Alpine:

apk add chromium

Supported browsers

Rod should work with any browser that supports DevTools Protocol.

  • Microsoft Edge is supported.
  • Firefox is supporting this protocol.
  • Safari doesn't have any plan to support it yet.
  • IE won't support it.

Browser and cdp protocol versioning

The cdp protocol is always the same as launcher.DefaultRevision. If Rod can't find your local browser, it will download the browser version of the launcher.DefaultRevision.

Each version of Rod only guarantees to work with its launcher.DefaultRevision of the browser.

API Versioning

Semver is used.

Before v1.0.0 whenever the second section changed, such as v0.1.0 to v0.2.0, there must be some public API changes, such as changes of function names or parameter types. If only the last section changed, no public API will be changed.

You can use Github's release comparison to see the automated changelog, for example, compare v0.75.2 with v0.76.0.

API reference versioning

Go to here.

Doc site versioning

We use github to manage the doc, it's easy to view any version of the doc:

  1. Clone the doc repo
  2. Git checkout to the commit that is near the release date of the Rod version you want
  3. Install docsify-cli
  4. On the root of the repo run docsify serve -o