diff --git a/docs.it4i/dice.md b/docs.it4i/dice.md index 8afa6e4117602116f22ae63f850a2ba6c8380b03..51f8b05b944d5a5a795ea4e04e1bfef9747c13b5 100644 --- a/docs.it4i/dice.md +++ b/docs.it4i/dice.md @@ -43,15 +43,15 @@ First, we need to verify your identity, this is done through the following steps 1. After successfull login to B2Access: - 1. **For Non IT4I Users** + 1. **For Non IT4I Users** - Sign in to our [AAI][f] through your B2Access account. - You have to set a new password for iRods access. + Sign in to our [AAI][f] through your B2Access account. + You have to set a new password for iRods access. - 1. **For IT4I Users** + 1. **For IT4I Users** - Sign in to our [AAI][f] through your B2Access account and link your B2ACCESS identity with your existing account. - The IRODS password will be the same as your IT4I LDAP password (i.e. code.it4i.cz password). + Sign in to our [AAI][f] through your B2Access account and link your B2ACCESS identity with your existing account. + The IRODS password will be the same as your IT4I LDAP password (i.e. code.it4i.cz password).   @@ -144,35 +144,38 @@ Enter your current PAM password: test.4 ``` -- upload `iput` , download `iget` - -- for more help, type `ihelp` +Use the command `iput` for upload, `iget` for download, or `ihelp` for help. ## ***Access to iRods Collection From Other Resource*** -- we suppose, you will upload your data from your local pc/vm -- password from [AAI][f] +!!! note + This guide assumes you are uploading your data from your local PC/VM. + +Use the password from [AAI][f]. ### You Need a Client to Connect to iRods Server -- There are many iRods clients, but we recommend theese: -- Cyberduck - for windows / mac, GUI . -- Fuse (irodsfs lite) - for linux, cli -- iCommands - for linux, cli . -- for access set PAM passwords at [AAI][f] +There are many iRods clients, but we recommend the following: +- Cyberduck - Windows/Mac, GUI +- Fuse (irodsfs lite) - Linux, CLI +- iCommands - Linux, CLI. + +For access, set PAM passwords at [AAI][f]. ### Cyberduck -- download [Cyberduck][i] -- download [connection profile][1] for IT4I irods server -- left doubleclick at this file opens connection +1. Download [Cyberduck][i]. +2. Download [connection profile][1] for IT4I iRods server. +3. Left doubleclick this file to open connection.  ### Fuse -- work with your irods collection like ordinary directory -- this is linux client only, basic knowledge of commandline is neccessary +!!!note "Linux client only" + This is Linux client only, basic knowledge of command line is neccessary. + +Fuse allows you to work with your iRods collection like an ordinary directory. ```console cd ~ @@ -183,9 +186,9 @@ wget https://pki.cesnet.cz/_media/certs/chain_geant_ov_rsa_ca_4_full.pem -P ~/.i sed -i 's,~,'"$HOME"',g' ~/irods/irods_environment.json ``` -- edit `~/.irods/config.yml` with username from [AAI][f] +Edit `~/.irods/config.yml` with username from [AAI][f]. -***How to mount your collection:*** +#### Mounting Your Collection ```console [some_user@local_pc ~]$ ./irodsfs -config ~/.irods/config.yml ~/IRODS @@ -200,7 +203,7 @@ time="2022-07-29 09:51:17.693772" level=info msg="Successfully sent configuratio time="2022-07-29 09:51:18.008166" level=info msg="Successfully started background process" function=parentRun package=main ``` -***How to put your data to iRODS*** +#### Putting Your Data to iRODS ```console [some_use@local_pc ~]$ cp test1G.txt ~/IRODS @@ -214,7 +217,9 @@ total 0 -rwx------ 1 some_user some_user 1073741824 Nov 4 2021 test1G.txt ``` -***How to stop - unmout your collection:*** +#### Unmounting Your Collection + +To stop/unmount your collection, use: ```console [some_user@local_pc ~]$ fusermount -u ~/IRODS @@ -222,10 +227,12 @@ total 0 ### iCommands -- this is linux client only, basic knowledge of commandline is neccessary -- we recommend Centos7, ubuntu 20 is optional +-!!!note "Linux client only" + This is Linux client only, basic knowledge of command line is neccessary. + +We recommend Centos7, Ubuntu 20 is optional. -***steps for Ubuntu20:*** +#### Steps for Ubuntu 20 ```console LSB_RELEASE="bionic" @@ -252,10 +259,9 @@ sudo apt install -y irods-icommands mkdir ~/.irods/ && cd "$_" && wget https://docs.it4i.cz/irods_environment.json wget https://pki.cesnet.cz/_media/certs/chain_geant_ov_rsa_ca_4_full.pem -P ~/.irods sed -i 's,~,'"$HOME"',g' ~/.irods/irods_environment.json - ``` -***Steps for centos*** +#### Steps for Centos ```console sudo rpm --import https://packages.irods.org/irods-signing-key.asc @@ -268,7 +274,7 @@ wget https://pki.cesnet.cz/_media/certs/chain_geant_ov_rsa_ca_4_full.pem -P ~/.i sed -i 's,~,'"$HOME"',g' ~/.irods/irods_environment.json ``` -- edit ***irods_user_name*** in `~/.irods/irods_environment.json` with username from [AAI][f] +Edit ***irods_user_name*** in `~/.irods/irods_environment.json` with the username from [AAI][f]. ```console [some_user@local_pc ~]$ pwd @@ -294,7 +300,7 @@ Enter your current PAM password: file.jpg ``` -***how to put your data to IRODS*** +**How to put your data to iRods** ```console [some_user@local_pc ~]$ iput cesnet.crt @@ -306,7 +312,7 @@ Enter your current PAM password: cesnet.crt ``` -***How to download data*** +**How to download data** ```console [some_user@local_pc ~]$ iget cesnet.crt