|
|
@@ -13,4 +13,24 @@ The `POST` method is called with the `-p` option and is used to add a log to the
|
|
|
The `UPDATE` method is called with the `-u` option and is used to regenerate the internal server database. It should only be called if a log file is added by hand, or if some of the log files get renamed or corrupted. It assumes that all the log files are correctly formatted.
|
|
|
|
|
|
## Configuration file
|
|
|
-To choose the server to communicate with, ssh uses a config file located in `~/.config/lcmlog`. The configuration file is named `config` and is a ssh config file: so, for more help, refer to ssh\_config manuals (i.e. run `man ssh_config` on your terminal). The script always checks if the config file exist: if false, it asks you if you want to generate it. You can't use this program until the config file is generated in `~/.config/lcmlog`.
|
|
|
+To choose the server to communicate with, ssh uses a config file located in `~/.config/lcmlog`. The configuration file is named `config` and is a ssh config file: so, for more help, refer to ssh\_config manuals (i.e. run `man ssh_config` on your terminal).
|
|
|
+
|
|
|
+The script always checks if the config file exist: if false, it asks you if you want to generate it. Here the config file template generated by the program (`~/.config/lcmlog/config`):
|
|
|
+
|
|
|
+```
|
|
|
+# lcmlog config file
|
|
|
+
|
|
|
+# Write this file as a ssh_config file.
|
|
|
+# For more info, run the command 'man ssh_config'.
|
|
|
+
|
|
|
+# Host is 'server': do not change the name.
|
|
|
+Host server
|
|
|
+ HostName
|
|
|
+ # User and Port parameters should be used only out of the lcm cluster.
|
|
|
+ #User
|
|
|
+ #Port
|
|
|
+```
|
|
|
+
|
|
|
+After the generation, you should edit the file and add the correct HostName (and eventually also User and Port). This script automatically open the config file after its generation using `nano` editor.
|
|
|
+
|
|
|
+You can't use this program until the config file is generated in the default folder (`~/.config/lcmlog`).
|
