|
| 1 | +# Collaborative Workspace |
| 2 | + |
| 3 | +The SBOM Workbench includes support for a collaborative workspace, a feature designed to enhance teamwork. |
| 4 | +This functionality allows multiple users to work on and review projects within the same workspace, |
| 5 | +eliminating the need for manual copying and transferring of workspace data among team members. |
| 6 | + |
| 7 | +## How does it Works |
| 8 | +The collaborative workspace in SBOM Workbench is achieved through a shared folder that is accessible to all team members. |
| 9 | +This setup allows one user to actively work on a project, while others can review the changes in READ_ONLY mode. |
| 10 | + |
| 11 | +## Requirements |
| 12 | +* A shared folder that is set up and accessible to all intended users. |
| 13 | +* All users must have the same version of SBOM Workbench installed. |
| 14 | + |
| 15 | +## Default Workspace |
| 16 | +By default, SBOM Workbench uses a private workspace located at $HOME/scanoss-workspace. |
| 17 | +When setting up a collaborative workspace, you must switch from this default private workspace to your newly created shared workspace |
| 18 | + |
| 19 | +## Preparing the Collaborative Workspace |
| 20 | +To utilize the collaborative workspace in SBOM Workbench, each team member needs to create a folder on their local machine and then mount |
| 21 | +the collaborative workspace residing on a Samba server in their local network. |
| 22 | + |
| 23 | +### Initial Steps |
| 24 | +* Local Folder Creation: Each user should create a folder on their local system where the shared workspace will be mounted. This folder will act as the access point to the collaborative workspace. |
| 25 | +* Workspace Mounting: Once the local folder is created, the next step is to mount the collaborative workspace located on the Samba server into this folder. Details for mounting this workspace on Linux and Windows systems are provided below. |
| 26 | + |
| 27 | +#### On Linux |
| 28 | + |
| 29 | +Ensure the `cifs-utils` package is installed on your machine. On Debian-based distributions, run `sudo apt install cifs-utils`. |
| 30 | + |
| 31 | +```bash |
| 32 | + sudo mount -t cifs -o \ |
| 33 | + noperm,iocharset=utf8,uid=1000,gid=1000,file_mode=0775,dir_mode=0775,nobrl,\ |
| 34 | + username=<samba_username>,\ |
| 35 | + password=<samba_password> \ |
| 36 | + //<server_samba>/<remote_workspace_folder> \ |
| 37 | + ~/<local_workspace_folder> |
| 38 | +``` |
| 39 | + |
| 40 | + |
| 41 | +#### On Windows |
| 42 | +```bash |
| 43 | +mklink /D %userprofile%\<local_workspace_folder> \\<samba_server_IP>\<remote_workspace_folder> |
| 44 | +``` |
| 45 | + |
| 46 | +## Changing the Workspace |
| 47 | +Once the collaborative workspace is mounted, change the default workspace in SBOM Workbench as follows: |
| 48 | + |
| 49 | + |
| 50 | +* Open SBOM Workbench. |
| 51 | +* Navigate to Home and look for the scanoss-workspace option in the top left corner. |
| 52 | +* Click on it and add a new workspace. Select the mounted shared folder as the new workspace. |
| 53 | + |
| 54 | +#### See picture: |
| 55 | + |
| 56 | + |
0 commit comments