Skip to content

Commit

Permalink
Add 'Activation' section to README.
Browse files Browse the repository at this point in the history
Add 'Removing an accepted invitation' section to user manual.
Update a user manual img.
  • Loading branch information
redblom committed May 13, 2024
1 parent 5cd927e commit a3e5046
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ Use one of the [official releases](/sara-nl/oc-invitation/releases) or build you
Deploy the app by copying the extracted `invitation` folder of the official release or your own custom build to the Owncloud `apps` folder.<br>
Finally the admin should activate the app. It should than be present as a menu entrance for all users.

#### Activation
To activate enhanced federated sharing (search and display invited remote users in the share dialog) the following configuration must be added to the `config.php` file of the Owncloud instance:
```
sharing.remoteShareesSearch' => '\\OCA\\Invitation\\Service\\RemoteUserService
```

---
### Configuration
To be able to send invitations between Owncloud instances the app must be installed on each one of them.<br>
Expand Down
7 changes: 7 additions & 0 deletions USER-MANUAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,14 @@ This goes for Jimmie in his Research Drive environment as well.

![Display the accepted invitation](img/rd-2-display-accepted-invitation.png "Display the accepted invitation")<br>
Fig.13 - Display the accepted invitation.<br>
#### Removing an accepted invitation
<p>
Both sender and receiver can remove an accepted invitation by clicking the 'remove' button, however, an accepted invitation exists on both sender and receiver Research Drive environments and removing it on one environment does not affect the invitation on the other. If eg. the sender removes the accepted invitation this removes the cloud ID and information of the remote user (the receiver) from the Research Drive environment of the sender and for the sender account. The consequence is that the sender cannot search for the receiver anymore when creating a share. A federated share for the receiver can still be created by the sender but only by filling in the cloud ID 'by hand'.<br>
Since the invitation also exists on the receiver's environment the receiver still sees an accepted invitation and still can search for the sender when creating shares. Also removing the invitation makes cloud ID and receiver information unavailable for the sender but not for any other users on the sender's environment that may possibly have their own accepted invitations with that same receiver.<br>
Removing an accepted invitation by the receiver has exactly the same consequences but then the sender is the remote user that cannot be found anymore by the receiver.<br>
<br>
Please note that <b>no existing shares between the two users are affected when removing an invitation!</b><br>
</p>

### Successfull exchange of cloud IDs and enhanced federated sharing support
<p>
Expand Down
Binary file modified img/rd-2-display-accepted-invitation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a3e5046

Please sign in to comment.