Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
rdms:access:linux:icommands [2023/10/27 14:42]
burcu distros-->distributions, On other ..--> icommands canbe installed... 		rdms:access:linux:icommands [2024/05/06 11:51] (current)
jelte [Installation on Ubuntu and Debian] A little text adjustment
Line 35: Line 35:
     "irods_encryption_num_hash_rounds": 16,     "irods_encryption_num_hash_rounds": 16,
     "irods_encryption_salt_size": 8,     "irods_encryption_salt_size": 8,
-    "irods_host": "rdms-prod-icat.data.rug.nl",+    "irods_host": "store.data.rug.nl",
     "irods_port": 1247,     "irods_port": 1247,
     "irods_ssl_verify_server": "cert",     "irods_ssl_verify_server": "cert",
-    "irods_user_name": "<username>@rug.nl",+    "irods_user_name": "<emailadress>",
     "irods_zone_name": "rug"     "irods_zone_name": "rug"
 } }
 </code></hidden>\\ </code></hidden>\\
 **Notes:**  **Notes:** 
-  * The iRODS username ''<username>@rug.nl'' should be replaced by your UG email address. +  * The iRODS username ''<emailadress>'' should be replaced by your UG email address. 
-  * Your username is case-sensitive, make sure to use all lower-case letters!+  * Your username is case-sensitive, make sure to use all lowercase letters!
  
 To see if everything was properly configures, you can now start the session by invoking the ''iinit'' command which will initialize your connection to the RDMS: To see if everything was properly configures, you can now start the session by invoking the ''iinit'' command which will initialize your connection to the RDMS:
Line 78: Line 78:
 </code> </code>
  
 +
 +**Additional Notes for Users of Ubuntu 20+ and Debian 11+**
 +
 +On Debian-based operating systems, the ''apt-key add'' feature was deprecated, and you might see the following message in the first step:
 +<code>
 +$ wget -qO - https://packages.irods.org/irods-signing-key.asc | sudo apt-key add -
 +Warning: apt-key is deprecated. Manage keyring files in trusted.gpg.d instead (see apt-key(8)).
 +OK
 +</code>
 +
 +As of now, the warning can be still ignored and the steps can be performed as described, but in the longer term it is highly advisable to add the repository signing key in another manner as described, for example, [[https://www.linuxuprising.com/2021/01/apt-key-is-deprecated-how-to-add.html|here]]. As of now, iRODS has not yet decided on the best way to handle this in the case of the iRODS package repository, and this information will be updated accordingly in the future.  
  
 ==== Installation on EL-based Distributions  ==== ==== Installation on EL-based Distributions  ====
Line 615: Line 626:
   * The bundling and extraction operations do not display a progress. For large folders/archives, it might take a longer time to finish while your terminal seems to be stuck.   * The bundling and extraction operations do not display a progress. For large folders/archives, it might take a longer time to finish while your terminal seems to be stuck.
   * If you want to overwrite, you can again use the additional ''-f'' flag.   * If you want to overwrite, you can again use the additional ''-f'' flag.
-  * The ''ibun'' command also allows to add content to an already existing archive. To do so, use the ''%%--%%add'' flag like ''ibun %%--%%add bundled_folder.tar <path_additional_directory>''. 
  
 **Assigning Data Permission**\\ **Assigning Data Permission**\\
Line 737: Line 747:
  
 === iCommands for Group Management === === iCommands for Group Management ===
-To manage RDMS Groups, the ''igroupadmin'' command is used. This command can be used to list group members (''igroupadmin lg <groupname>''), add/remove users from groups (''igroupadmin <atg/rfg> <groupname> <username>''), or even to create a new group (''igroupadmin mkgroup <groupname>'').+To manage RDMS Groups, the ''igroupadmin'' command is used. This command can be used to list group members (''igroupadmin lg <groupname>''), add/remove users from groups (''igroupadmin <atg/rfg> <groupname> <emailadress>''), or even to create a new group (''igroupadmin mkgroup <groupname>'').
    
 <hidden> <hidden>
Line 791: Line 801:
 | ''igroupadmin''  | Manage RDMS Groups (just for group admins)  | | ''igroupadmin''  | Manage RDMS Groups (just for group admins)  |
  
 +==== Further Tips and Tricks ====
 +
 +This section contains some additional tips and tricks that make working with ''iCommands'' more effective.
 +
 +=== Enable Bash Auto-Completion ===
 +
 +Most Linux distribution come by default with the so called [[https://en.wikipedia.org/wiki/Bash_(Unix_shell)|Bourne Again Shell (Bash)]] which has an internal auto-completion function via "tab key". This can be used to, for example, auto-complete certain paths when using the standard Linux commands (e.g., ''ls'', ''cd''). 
 +
 +This auto-completion does not work by default for the ''iCommands'' which means that for example using ''ils'' with the "tab key" to auto-complete an RDMS path will not work.  Luckily, the iRODS community provides a helpful ''irods_completion.bash'' shell script via its [[https://github.com/irods/contrib/tree/main|iRODS contrib Github]] page that can be used to enable this functionality. 
 +
 +**Temporarily enable Bash Auto-Completion**
 +
 +As a first step, you need to download the ''irods_completion.bash'' shell script from the mentioned Github repository. The Linux commands ''cURL'' or ''wget'' can be used for this directly from the terminal.
 +
 +In this example, we will assume that the auto-completion script will be downloaded and saved in your Linux home directory (abbreviated as ''~'').
 +
 +To download the shell script to your home location, open a terminal window and then execute:
 +
 +<code>
 +# Using wget
 +$ wget https://raw.githubusercontent.com/irods/contrib/main/irods_completion.bash  -P ~/
 +
 +# Using cURL
 +$ curl  https://raw.githubusercontent.com/irods/contrib/main/irods_completion.bash > ~/irods_completion.bash
 +</code>
 +
 +After successfully downloading the script, you can enable it temporarily (for your current shell session) by executing:
 +
 +<code>
 +$ source ~/irods_completion.bash
 +</code>
 +
 +Afterwards, the "tab key" can be used for auto-completion on the RDMS side. If you hit the "tab key" two times in a row, your terminal will display all available paths in the current location that fits your auto-completion criteria.  
 +
 +**Permanently enable Bash Auto-Completion**
 +
 +It is also possible to automatically "source" the ''auto_completion.bash'' script every time a new Bash shell is started.
 +
 +To do so, you have to first download the shell script as described above. Afterwards, we will edit the ''~/.bashrc'' file which is automatically loaded when a Bash session is started so that it automatically loads/sources the auto-completion script. 
 +
 +While you can use your favorite text editor for this, we will use ''nano'' in this example. In your Linux terminal, execute:
 +
 +<code>
 +$ nano ~/.bashrc
 +</code> 
 +
 +Now add ''source ~/irods_completion.bash'' to the end of the opened file, and then save (''nano'': Ctrl + o) the file and exit your text editor (''nano'': Ctrl + x). 
 +
 +From now on the auto-completion script will be loaded by default when you start a new shell session. If you also want to enable the auto-completion for your current session, you have to once execute:
 +
 +<code>
 +$ source ~/.bashrc
 +</code> 
 +
 +**Notes**
 +  * The auto-completion script that is described in this section is specific for the Bash shell. If you are unsure if you are using the correct shell, you can execute ''echo $SHELL'' in your terminal which will show you the default shell in your system.
 +  * If you want to disable the automated loading of the auto-completion script, you can edit the ''~/.bashrc'' file again. Either delete the part that contains ''source ~/irods_completion.bash'' or comment it out by adding a "#" in front of the line.