Note: What is the difference between stable and preview installers?
stableinstaller is the latest version of Docable Notebooks which was released, andpreviewinstaller includes the latest unrelease changes from master branch.
Typically you should install the stable version, unless you need a feature that was recently added to Docable Notebooks and is still not published in one of the releases.
Download the Windows installer [stable - preview] and run it.
To allow Windows smartscreen to continue with the installation, click on "More info". Then, proceed to the installation by selecting "Run anyway".
You will be presented with the installer, we recommend to continue with the default setting which installs Docable Tray only for your user.
After the installation is completed, continue to Components and Usage sections below.
Download and open macOS [stable - preview] dmg.
After the dmg image has been mounted, simply drag and drop docable-tray to your "Applications" folder.
Depending on your system settings, macOS may show a prompt similar below that prevents you from starting the application.
In this case, right click on the docable-tray application and open the file.
You will be presented with a prompt which now gives you an option to open the application. Select "Open" again. Note, you only need to do this the first time you start Docable Tray.
If it is the first time you are running Docable tray and /usr/local/bin permissions on your system are not updated to allow write permission to your user, Docable tray will automatically fix this permissions for you, but to this, it needs privilege escalation as shown below. Enter password to continue:
After the installation is completed, continue to Components and Usage sections below.
Download and run the .deb installer (stable - preview)
Use dpkg to install the .deb file.
sudo dpkg -i docable-tray.debNote: when installing
.deb, you may get adependency problems prevent configuration of docable-tray.apperror. To resolve this, simply runsudo apt-get -f installto automatically install the needed dependencies.
After the installation is completed, continue to Components and Usage sections below.
To better understand and correctly use Docable Tray app, it is good to know how Docable Tray app works in the background. There are two main components that you should know about:
This is the GUI component, which handles running Docable Notebooks server in the background automatically and showing the Docable icon in the Menu bar which gives you options for stopping and starting the Docable Notebook server.
docable-server is the cli components of the application, which provides similar functionality found in ottomatica/docable-notebooks. When installing Docable Tray app, this cli component is added to your system's PATH environment variable and can be executed by running docable-server.
For example, you can import notebooks from cli by running:
$ docable-server import https://github.com/ottomatica/docable-notebooksOr you can even start Docable Notebooks server, without using the GUI component. [Note: if Docable Tray app (GUI component) is started, server is already running in the background, so this command will fail.]
$ docable-server -d ~/docableTo use Docable Notebooks, start the docable-tray app from your operating system's applications list. This will also start the Docable Notebooks server in the background.
You can confirm the Docable Notebook has started successfully, by righ-clicking on the Docable icon in Windows Taskbar and clicking on "Open Docable...".
Then, your default browser should now open http://localhost:3000/.
To update the docable-tray app, download latest version of Docable Tray and re-run the installer as explained in installation section above.