Skip to content

Commit

Permalink
docs: add role ibridges
Browse files Browse the repository at this point in the history
  • Loading branch information
dometto committed Jun 18, 2024
1 parent d5019ae commit 9d27d47
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 8 deletions.
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ status should be indicated in the description field of the catalog plugin item.
- [aptly](playbooks/aptly.md) serve apt repositories on the workspace
- [ibridges](playbooks/ibridges.md) userfriendly commandline client for iRODS
- [icommands](playbooks/icommands.md) commandline tools for iRODS data grid
- [irods_tools](playbooks/irods_tools.md) sync folders from iRODS or Yoda to the workspace at creation time
- [irods_sync](playbooks/irods_sync.md) install both iBridges and icommands command line tools
- [irods_tools](playbooks/irods_tools.md) install both iBridges and icommands command line tools
- [irods_sync](playbooks/irods_sync.md) sync folders from iRODS or Yoda to the workspace at creation time
- [miniconda](playbooks/miniconda.md) Python development
- [python-workbench](playbooks/python-workbench.md) Python development
- [security_updates](playbooks/security_updates.md) automatic updates for Ubuntu
Expand Down Expand Up @@ -61,6 +61,7 @@ The status of a role is either Experimental or Supported. Supported roles are su
- [default_group](roles/default_group.md) set desired groups as default for regular users
- [fact_regular_users](roles/fact_regular_users.md) facts about users on the system
- [fact_workspace_info](roles/fact_workspace_info.md) facts about the workspace, and groups and users from the CO (SRAM)
- [ibridges](roles/ibridges.md) installs [iBridges](https://github.com/UtrechtUniversity/iBridges), a userfriendly commandline client for iRODS (GUI and/or CLI)
- [install_role](roles/install_role.md)
- [keycloak](roles/keycloak.md)
- [miniconda](roles/miniconda.md)
Expand Down
10 changes: 4 additions & 6 deletions docs/playbooks/ibridges.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@
[back to index](../index.md#Playbooks)

## Summary
Installs the [iBridges](https://github.com/UtrechtUniversity/iBridges) pip library and command line tool
for all users. After installation, the command `ibridges` is available for all users with a login shell.
Installs [iBridges](https://github.com/UtrechtUniversity/iBridges), the userfriendly client for iRODS (and Yoda). Installs the command line client, and also the GUI application on desktop workspaces. After installation, the command `ibridges` is available for all users with a login shell.

## Requires

- Linux operating system
- pip

## Description

Expand All @@ -17,12 +15,12 @@ The playbook:
* installs the latest iBridges version from pip, in a common location for all users (see the `pip_install_systemwide` role).
* adds this common location to `$PYTHONPATH` for all users
* adds the iBridges command line utility to each user's `$PATH`

## Variables
See [irods_iselect](../roles/irods_iselect.md) for options to configure a list of zones.
* on Desktop workspaces, installs the GUI application as well (Desktop item is places in the applications menu and on the desktop).

## See also
- Role [ibridges](../roles/ibridges.md)
- Role [pip_install_systemwide](../roles/pip_install_systemwide.md)
- Playbook [irods_tools](./irods_tools.md)


## History
Expand Down
28 changes: 28 additions & 0 deletions docs/roles/ibridges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Role iBridges
[back to index](../index.md#Roles)

## Summary
Installs [iBridges](https://github.com/UtrechtUniversity/iBridges), the userfriendly client for iRODS (and Yoda). Installs the command line client, and also the GUI application on desktop workspaces.

## Requires

- Linux operating system

## Description

* installs the latest iBridges version from pip, in a common location for all users (see the `pip_install_systemwide` role).
* adds this common location to `$PYTHONPATH` for all users
* adds the iBridges command line utility to each user's `$PATH`
* on Desktop workspaces, installs the GUI application as well (Desktop item is places in the applications menu and on the desktop).


## See also
- Role [ibridges](../roles/ibridges.md)
- Role [pip_install_systemwide](../roles/pip_install_systemwide.md)
- Playbook [irods_tools](../playbooks/irods_tools.md)


## History
2024 Written by Dawa Ometto (Utrecht University)

[back to index](../index.md#Playbooks)

0 comments on commit 9d27d47

Please sign in to comment.