Added note about using sudo

aerokube · Sep 11, 2021 · 8a3ee87 · 8a3ee87
1 parent 6fcee0c
commit 8a3ee87
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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
+----
 
 ====