Project

Profile

Help

Synchronize Files using Planio Storage » History » Sprint/Milestone 3

Ema Raven, 04/16/2024 11:24 AM

1 1 Ema Raven
# Synchronize Files using Planio Storage
2
3 3 Ema Raven
[Planio Storage](https://plan.io/file-management/) lets you set up a dedicated folder within any Planio project that will be synchronized across your team. All team members can access files using the web or directly on their devices using the Planio Storage Sync Client.
4 1 Ema Raven
5
{{>toc}}
6
7
## Install Planio Storage
8
9
Within any project, install Planio Storage by navigating to the **Apps** tab. Depending on your current Planio plan, you might have to add Planio Storage for a small monthly fee. Of course, you'll be able to try Planio Storage for free until your next plan renewal.
10
11
{{figure(Install Planio Storage)
12
![](planio-storage-app@2x.png)
13
}}
14
15
## Install the Sync Client
16
17
To sync your project's files and folders with your computer, download the appropriate client app first.
18
19
20
<table>
21
<tbody>
22
<tr>
23
<td><a href="https://support.plan.io/attachments/download/1198975/PlanioStorage-2.6.3.pkg"><img src="https://support.plan.io/attachments/download/679092/macos-logo@2x.png" alt="" /></a></td>
24
<td><a href="https://support.plan.io/attachments/download/1124490/PlanioStorage-2.6.3.exe"><img src="https://support.plan.io/attachments/download/679093/windows-logo@2x.png" alt="" /></a></td>
25
<td><a href="https://support.plan.io/attachments/download/679091/PlanioStorage-2.3.4-x86_64.AppImage"><img src="https://support.plan.io/attachments/download/679095/linux-logo@2x.png" alt="" /></a></td>
26
</tr>
27
<tr>
28
<td><a href="https://support.plan.io/attachments/download/1198975/PlanioStorage-2.6.3.pkg"><strong>macOS Download</strong></a><br />
29
(Version 2.6.3)</td>
30
<td><a href="https://support.plan.io/attachments/download/1124490/PlanioStorage-2.6.3.exe"><strong>Windows Download</strong></a><br />
31
(Version 2.6.3)</td>
32
<td><a href="https://support.plan.io/attachments/download/679091/PlanioStorage-2.3.4-x86_64.AppImage"><strong>Linux Download</strong></a><br />
33
(Version 2.3.4)</td>
34
</tr>
35
</tbody>
36
</table>
37
38
Next, run the installer and enter your **Planio domain**, **login** and **password**. Planio Storage will allow you to sync everything from your Planio account or just the projects you select.
39
40
You can also specify the local folder where Planio Storage files should be placed.
41
42
{{figure(Setting up the Planio Storage client app)
43
![](planio-storage-client-app@2x.png)
44
}}
45
46
Handling files and folders inside the synced folders works like you're used to and every change will be synced with Planio. Should you be offline during a change, the sync will happen the next time your device is connected to the Internet.
47
48
In case you and a colleague edit the same file while offline or during syncs, Planio Storage will create a copy of the file and you'll be able to merge your changes.
49
50
## Browser access
51
52
You can manage files and folders right in Planio as well. Within your project, navigate to the **Storage** tab. Inside, you'll be able to upload any number of files from your computer by clicking on the **Upload files** button or simply by dragging them from your desktop into the browser window.
53
54
You can also create folders as you would on your computer by clicking **New folder**.
55
56
To visualize the files and folders in Planio Storage, you can either select **Tree** or **Grid** from the options menu at the top right.
57
58
{{figure(Planio Storage tree view)
59
![](planio-storage-file-listing@2x.png)
60
}}
61
62
## WebDAV access
63
64
In case you don't wish to synchronize everything but access Planio Storage directly while online, you can use WebDAV.
65
66
You can find a project's **WebDAV URL** in the Storage section's sidebar on the right. To connect, simply use your Planio **login** and **password**.
67
68
{{figure(Accessing Planio Storage using WebDAV)
69
![](planio-storage-webdav@2x.png)
70
}}
71
72
## Configure roles and permissions
73
74
To configure who among your colleagues and clients should be able to view and edit files, head to *your avatar* -\> **Administration** -\> **Roles and Permissions**. Then, select a role. Within **Permissions** -\> **Storage**, you'll be able to set permissions for the selected role.
75
76
{{figure(Managing Planio Storage permissions)
77
![](planio-storage-permissions%402x.png)
78
}}
79
80
The following permissions are available:
81
82
<table>
83
<tbody>
84
<tr><td>View files and folders</td><td>Enables users to access the <strong>Storage</strong> tab and browse files.</td></tr>
85
<tr><td>Edit files and folders</td><td>Lets users upload, edit, and delete files.</td></tr>
86
<tr><td> Edit protected files and folders </td><td> Enables users to <strong>protect</strong> files and folders. Protected items are hidden from other users unless they have the <strong>View protected files and folders</strong> permission. </td></tr>
87
<tr><td> View protected files and folders </td><td> Allows users to view and download <strong>protected</strong> files. They cannot edit, delete, or set files to unprotected. </td></tr>
88
<tr><td> Share files </td><td> Allows users to generate a sharing link for any file. </td></tr>
89
<tr><td> View shared files </td><td> Allows users to download files shared using a sharing link. </td></tr>
90
</tbody>
91
</table>
92
93
## Protecting files and folders
94
95
Files and folders can be protected and thus hidden from other users. To protect a folder or file, click on the **...** menu or right click the item. Then, select **Protect**.
96
97
{{figure(Protect a folder in Planio Storage)
98
![](protect-folder-in-planio-storage@2x.png)
99
}}
100
101
Protected files and folders are hidden from users who do not have the **View protected files and folders** permission. Users who do have the permission can view and download protected items, but they cannot edit or delete them.
102
103
To edit, delete, or unprotect protected files and folders, users need the **Edit protected files and folders** permission.
104
105
## Sharing files
106
107
Single files can be shared with people outside of the project by generating a **Sharing link**. This is useful if you'd like to link to the file publicly or send a link to it in an email.
108
109
To share a file, click on the **...** menu or right click the item. Then, select Share. You'll be able to copy the sharing link in the next step.
110
111
{{figure(Sharing link information in Planio Storage sidebar)
112
![](sharing-links-in-planio-storage@2x.png)
113
}}
114
115
The link will always point to the latest version of the file–even if it has been updated after it was shared.
116
117
Sharing links can be accessed by anyone who has the **View shared files** permission. By configuring your *Non-member* and *Anonymous* roles, you can define if that extends to everyone who has an account in your Planio or even to people who are not logged in. Our guide [[Make Redmine Projects Public on Planio]] has more information about this.
118
119
## Linking files
120
121
You can create links in Planio Storage which point to files in different folders or even projects of your Planio account.
122
123
To create a link, click on the **...** menu or right click the item. Then, select **Create link**. In the popup that appears, select the project and folder where the link should be created.
124
125
{{figure(Creating a link in Planio Storage)
126
![](creating-a-link-in-planio-storage@2x.png)
127
}}
128
129
Links will always point to the latest version of the source file. If a source file is deleted, all links will disappear as well.
130
131
Users will always require permissions to view the source file as well in order to be able to view the link.
132
133
## Handling conflicts
134
135
The Planio Storage desktop client uploads local changes and downloads remote changes. When a file has changed both in your local folder and on the Planio server between two synchronization runs, the client will be unable to resolve the situation on its own. Therefore, it will create a *conflict file* which contains your local version, download the remote version from Planio, and notify you that a conflict has occurred which needs attention.
136
137
### Example
138
139
Imagine there is a file called `hello.txt` in your synchronized folder. It has not changed for a while and contains the text "hello" both on your PC and remotely, on the Planio server. Now, nearly at the same time you update this file to say "local hello", the file on the Planio server gets updated to contain "planio hello" by someone else.
140
141
When attempting to upload your local changes, the desktop client will notice that the server version also has changed. It therefore stops the upload (since it would potentially overwrite somebody elses changes) and instead creates a conflict file holding your local changes. You will now have two files on your local machine:
142
143
- `hello.txt` containing "planio hello"
144
- `hello (conflicted copy 2020-06-03 012755).txt` containing "local hello"
145
146
As you can see, the file `hello.txt` represents the file as it is currently on the Planio server - it has the remote changes (and will continue to be updated with further remote changes when they happen), but your local adjustments have not been uploaded to the server. Instead, the **conflicted copy** file holds your local adjustments now.
147
 
148
The desktop client notifies you about this situation via system notifications, the system tray icon and a yellow **unresolved conflicts** badge in the account settings window. Clicking this badge shows a list that includes the unresolved conflicts and clicking any one of them opens an explorer window pointing at the relevant file.
149
150
To resolve such a conflict, open both files, compare the differences and copy your local changes from the **conflicted copy** file into the original file where applicable. In this example you might change `hello.txt` to say "local and planio hello" and delete the file with **conflicted copy** in its name. With that, the conflict is resolved.