Skip to content

Commit 1c47cf8

Browse files
rasdaniErikBjare
andauthored
docs: add autostart instructions for Ubuntu, add instruction tab per OS (#124)
Co-authored-by: Erik Bjäreholt <[email protected]>
1 parent f593eb2 commit 1c47cf8

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

src/getting-started.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,28 @@ If you want more advanced ways to run ActivityWatch (including running it withou
5454
Autostart
5555
=========
5656

57-
.. note::
58-
Autostart is set up automatically by the Windows installer and for Arch Linux by the AUR package (if your desktop environment supports `XDG Autostart <https://wiki.archlinux.org/index.php/XDG_Autostart>`_).
57+
.. tabs::
58+
59+
.. group-tab:: Windows
60+
61+
.. note::
62+
Autostart is set up automatically by the Windows installer.
63+
64+
.. group-tab:: macOS
65+
You can automatically start ActivityWatch when you log in by [adding it to your Login Items](https://support.apple.com/guide/mac-help/open-items-automatically-when-you-log-in-mh15189/mac).
66+
67+
.. group-tab:: Arch Linux
68+
69+
.. note::
70+
Autostart is set up automatically for Arch Linux by the AUR package, if your desktop environment supports `XDG Autostart <https://wiki.archlinux.org/index.php/XDG_Autostart>`_.
71+
72+
You can set up autostart in other environments by adding [`dex`](https://archlinux.org/packages/extra/any/dex/) (to enable XDG autostart) or simply `aw-qt` to whatever place you put your startup applications (i3 config, etc).
73+
74+
.. group-tab:: Ubuntu
75+
76+
Go to "Activities" or click the "Show Applications" button, search for "Startup Applications". Click "Add" and enter a name and optionally a comment. For the command, enter the path to the ``aw-qt`` executable in the application directory. For example, ``/home/<your username>/.local/opt/activitywatch/aw-qt``.
77+
78+
.. group-tab:: Other
5979

60-
You probably want to make ActivityWatch start automatically on login using your operating system's autostart settings.
61-
For some installation methods (Windows installer, AUR package) this is done automatically, but if you don't use those methods you'll have to do it yourself. Searching the web for "autostart application <your operating system>" should get you some good results that don't take long. You want to start the ``aw-qt`` executable in the application directory, or the `ActivityWatch.app` on macOS.
80+
You probably want to make ActivityWatch start automatically on login using your operating system's autostart settings.
81+
Searching the web for "autostart application <your operating system>" should get you some good results that don't take long. You want to start the ``aw-qt`` executable in the application directory.

0 commit comments

Comments
 (0)