diff --git a/apps/restconf/README.md b/apps/restconf/README.md index 7c5cc03e..06ec90bb 100644 --- a/apps/restconf/README.md +++ b/apps/restconf/README.md @@ -2,6 +2,11 @@ ### Installation using Nginx +Ensure www-data is member of the CLICON_SOCK_GROUP (default clicon). If not, add it: +``` + sudo usermod -a -G clicon www-data +``` + Define nginx config file: /etc/nginx/sites-available/default ``` server { diff --git a/doc/FAQ.md b/doc/FAQ.md index 1884a246..880e34dc 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -1,4 +1,4 @@ -i# Clixon FAQ +# Clixon FAQ ## What is Clixon? @@ -41,14 +41,25 @@ The example: sudo make install ``` -## Do I need to setup anything? +## Do I need to setup anything? (IMPORTANT) The config demon requires a valid group to create a server UNIX socket. Define a valid CLICON_SOCK_GROUP in the config file or via the -g option or create the group and add the user to it. The default group is 'clicon'. +Add yourself and www-data, if you intend to use restconf. + On linux: +``` sudo groupadd clicon - sudo usermod -a -G clicon user + sudo usermod -a -G clicon + sudo usermod -a -G clicon www-data +``` + +Verify: +``` +grep clicon /etc/group +clicon:x:1001:,www-data +``` ## What about reference documentation? Clixon uses Doxygen for reference documentation.