Frequently Asked Questions

Getting Started

What is a repository?

A repository is simply a place where you can store and share your files and folders securely, using Ouisync. You can think of it as a root folder, or even a safe, that will contain other folders and files that you want to share with your peers.

Where can I see my repositories?

When you open the Ouisync app, after the onboarding screens you will see the main screen listing all the repositories you have created. Initially this screen will be empty, but as you begin creating repositories, they will be listed here.

Ouisync home page listing your repositories
How can I create new repositories?

To create a new repository, tap the + button:

Tap the Plus button

Then select 'Create Repository':

Select 'Create repository'

…and give it a name:

Give your repository a nice name.

You also have the option here to protect your repository with a local password or your biometrics (if you've got them set up on your device).

See What is a 'local password'? to learn more about them.

Do I have to set up a password (or biometrics) to protect my repositories?

There is no requirement to protect your repositories either by password or by biometrics. Whether you decide to do it depends on the sensitivity of data that you store in Ouisync repositories and habitual usage of your devices. For storing and sharing photos of your cat, maybe a password is not necessary. But for storing more sensitive personal data, we recommend passwords (or biometrics) be set up.

Adding a local password

After that you will see this dialog box and you can either set up a local password or select the biometrics protection (if you have it set up on your device):

Setting a local password or biometrics authentication

You can have a different password for each repository. It is also possible to have a mixture of password (or biometrics) protected Ouisync repositories and ones without protection.

If you do not set up the password or biometric protection when creating a repository, you can do it later by going to the Repository settings (the three vertical dots next to the repository name) and to the Security options for that repository.

Change repository security options in Settings
Why is it called 'local password' and not simply 'password'?

A local password is a password set up only for your own device. You don't need to share it with your peers. They can set up their own passwords to protect the shared Ouisync repositories on their own devices.

How can I add files and folders to my repository?

That's easy. Tap on the repository name. This will take you to the repository contents screen where you will see a Plus button:

Tap the Plus button

This will open a small window where you can choose whether to create a folder for your files within that repository or add files to it from your device or external storage (such as a USB stick or SD card):

Add folders or files

There you can decide to create a new folder:

Create a new folder

Or you can import files into one of the existing folders.

What does it mean to 'import' a repository?

To import a repository means that you want to recreate on your device a repository that a peer has shared with you.
You start with the same + button and then select 'Import':

Select to import a repository

Tapping on the Import repository button will bring you to this screen:

Select to import a repository

Here you have two options - you can scan a QR code generated by your peer or import a link your peer has sent you (by email, any messaging app etc). [TODO: fix this sentence] The link looks like this:

Shared repository link

After you copy and paste the link you received from your peers into the provided field, or after you scan the QR code of the repository you wish to import, the imported repository will appear on your screen and after a short while all its content will be imported into your device. You now have on your device a replica of the repository that your peer shared with you.

How can I use my repository as a secure backup?

Create Secure Backups

You can create a secure backup repository on a spare device of your own or even on a friend's device. To do that you first need to generate the Write token link for the repository that you want to store blind. Please keep the Write token link somewhere safe, as you will need it for retrieving the data from your blind copy later on.

Then you create a Blind link and import this blind repository into the backup device.

Retrieving Information from Blind Repositories

If you accidentally delete a repository from your primary device, what you can do is go to 'Import Repository', copy and paste the WRITE link (which you kept somewhere safe!*) into the provided field, and that's it. Once your primary device connects with your backup device, they will sync - i.e.: the primary repository will automatically sync with your backup repository and receive all the files that repository contains.

Note:

If you add files to your primary repository, that addition will be propagated to your backup repository too (if your backup device is connected/online. That means that your backup repository will automatically receive all updates from your primary repository. However, if you delete any files in your primary repository, then that deletion will be propagated too, and you won't be able to retrieve those files. Ouisync is currently primarily a synchronization tool and not a secure backup tool. The selective syncing, and creating snapshots in time that will allow you to go back to the previous version of your repository is planned for development in future Ouisync releases.

Sharing

How can I share my repository with my peers (or my other devices)?

You can do this by tapping the three vertical dots next to the repository name which will open the Settings screen for that repository, and then tapping the Share symbol:

Select to import a repository

If the peer (or device) with whom you want to share a repository is nearby, they can tap on 'Import repository' on their device and then scan the QR code displayed on your screen:

Repository settings menu

This action will import a copy of your repository onto your peer's device, including all the files and folders within it.

Import a repository with a QR code

If your peer is not nearby, you can share your repositories by generating a link to send to your peer (or your other device):

Generate a shortlink to share a repository

You can copy the link and paste it into an email or any messaging application, or you can tap the Share link button which will open one of the apps you can use to send it. Your peers will need to copy and paste that link into the field provided when they tap 'Import Repository' on their device.

Import repository, then paste the link

PS: To paste a link to the input field, you tap and hold your finger on it, until a small Paste button appears to tap:

Tap and hold to paste the link
How do I decide which permissions to select when sharing a repository?

Write

If you want your peers to be able to add files, delete them, rename or move them within the repository that you shared with them, then you need to share your repository with Write permission.

A repository with Write permissions

An example use case for this level of permissions: sharing photos with friends and family, or working collaboratively on a project.

Read

If you want your peers to only be able to read the repository contents, then select Read permissions. This means they will be able to open the files and read them, but they won't be able to add new files to your shared repository, nor move or delete any files from it.

A repository with Read permissions

An example use case would be when you want to share the information regarding an event or news items, or maybe regarding certain products, or perhaps you are a teacher sharing some content with your students, etc. In all these you want the recipients to be able to read the contents but not change them.

Blind

A repository with Blind permissions

This level of permissions can be useful when you want to securely store your repository as a backup. This means that the person or device with whom you shared your repository as 'blind' won't be able to open the files to read them, nor make any changes to them. This way you can store your data securely on a friend's computer, for example.

Can my peers re-share my token links?

Yes. They can generate the token links with the same permissions they had in the original token link that they received from you, or lower.

This means that if a person has received a token link to import a repository with Write permissions they are able to generate the same kind of link to share the same repository with other people, or they can also generate links for the same repository but with lower permissions (Read or Blind).

If they imported a repository with Read permissions only, then they can share it with others as Read or Blind. If they imported your repository as Blind, they can only share it as Blind.

What happens if me and my peers upload the same file into Ouisync?

Ouisync is capable of handling two different scenarios.

Peers who are online at the same time

If you and one or more peers upload the same file (for example Billy.jpg) to the same Ouisync repository that another peer has already uploaded, Ouisync will detect this situation and ask if you want to keep both files or replace one of them:

Synchronous edits file handling

If you decide to keep both of them, the new one will have (1) added to the name and you will see both files on your Ouisync screen. If you decide to replace the existing one, then the new ones will overwrite it and the old one will no longer exist

Asynchronous sync file handling

Peers who are offline at the time of uploading the files

File Management

What happens if I delete files in my repository?

File deletion is propagated to all replicas in existence -which means the same file that you deleted will be automatically deleted in the repositories of all the peers with whom you have shared it.

Equally, if your peers delete any files in any of the repositories that they have imported from you, their file deletions will be propagated to your device too. It works both ways -i.e.: repositories shared with Write permissions will sync with each other, including file edits, additions or deletions.

What happens if I rename files in my repository?

If you rename files in your repository, the new file name will be propagated to the repositories of all the peers that you shared your repository with.

Can I move my files from one repository to another?

No. At the moment you can only move files from one folder to another within the same repository. Moving files from one repository to another is planned for future releases of Ouisync.

Privacy and Security

Are my files stored on a server? Why?

Yes. They are stored fully encrypted in transport as well as at rest and are not readable by the server.

The purpose of the server storage is to facilitate file syncing when peers are not online at the same time. If you want to share a repository with a peer who is not online at the moment, your repository data will be stored encrypted on the server and when your peer comes online and connects either to the server (or to your device) the files from the stored repository will sync with the files in your peer's repository.

How can I connect to the server?

This happens automatically when you share a repository with a peer - you don't need to perform any additional actions.

Where is this server and who runs it?

The Ouisync servers are physically located in Canada and are managed by eQualitie.

What private data does Ouisync use/store?

Ouisync uses the IP addresses of your devices to be able to connect you with your peers in the peer-to-peer network. We don't store those IP addresses anywhere on our systems. We don't keep any other user data.

How can I lock my repositories when I'm not actively using them?

To lock your repositories when not actively working on them, tap on the Lock button: TODO (insert screenshot).

Other FAQs

What are the advantages of using Ouisync over Dropbox, Google, or other similar solutions?

Free to use

To be able to share files using Dropbox, you need to create a Dropbox account. This requires your name, email, and credit card. It also requires payment.

Ouisync is entirely free and open source software. To share files using Ouisync, you only need to install the app. That's it. No payment is required.

Anonymity

Ouisync does not require the creation of user accounts. With Ouisync, it is simply a matter of installing the app and using it. All users are completely anonymous.

Ouisync is a P2P solution

This means that using Ouisync successfully does not depend on any central server anywhere. Ouisync makes use of decentralized peer-to-peer networking, which makes it an effective file-sharing app even in situations where well-known file-sharing servers (such as Dropbox or Google Drive) are unavailable.

How can I sync files with my peers or with my other devices without internet?

In situations with limited internet availability, you will need to make sure some means of connecting to other devices still exists.

This could be a WiFi signal available to all devices that want to share Ouisync repositories, or it could be intranet, a local network or similar technologies.

Currently repositories cannot be shared via Bluetooth. This feature is planned for future releases.