diff --git a/docs/index.adoc b/docs/index.adoc index 66ce281..fe159af 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -9,11 +9,13 @@ :icons: font :source-highlighter: coderay :docinfo: shared +:title: CM - A tool to automate installation of Aerokube products +:description: CM allows you to install Selenoid and related products with a single command in minutes. :favicon: img/favicon.png This reference covers version: _{revnumber}_. -Configuration manager is a small application used to automatically configure http://aerokube.com[Aerokube] products. +Configuration manager is a small application used to automatically configure https://aerokube.com[Aerokube] products. include::selenoid-commands.adoc[leveloffset=+1] include::selenoid-ui-commands.adoc[leveloffset=+1] diff --git a/docs/selenoid-commands.adoc b/docs/selenoid-commands.adoc index 86bdb39..a350327 100644 --- a/docs/selenoid-commands.adoc +++ b/docs/selenoid-commands.adoc @@ -12,6 +12,15 @@ To start Selenoid: $ ./cm selenoid start --vnc ---- + +[WARNING] +==== +Running this command with `sudo` can lead to broken installation. Recommended way is running Selenoid as regular user. On Linux to have permissions to access Docker you may need to add your user to `docker` group: +[source,bash] +---- +$ sudo usermod -aG docker $USER +---- +==== ++ .On Windows [source,powershell] ---- diff --git a/docs/selenoid-ui-commands.adoc b/docs/selenoid-ui-commands.adoc index 0e09bb1..3f6a2fb 100644 --- a/docs/selenoid-ui-commands.adoc +++ b/docs/selenoid-ui-commands.adoc @@ -5,7 +5,10 @@ This section describes supported ways of automatic https://github.com/aerokube/s ==== To quickly run Selenoid UI type: - $ ./cm selenoid-ui start +[source,bash] +---- +$ ./cm selenoid-ui start +---- ====