nextcloud/external

Name: external

Owner: Nextcloud

Description: ? Embed external sites in your Nextcloud

Created: 2017-03-09 13:29:13.0

Updated: 2018-05-23 00:24:38.0

Pushed: 2018-05-23 00:24:46.0

Homepage: https://apps.nextcloud.com/apps/external

Size: 1128

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

External sites

This application allows an admin to add a link in the Nextcloud web interface Apps menu that points to an external website. By simply entering the URL and the name for the external site, an icon appears. When this icon is clicked by a user, the external website appears in the Nextcloud frame. For the user, this external site appears as if it is part of Nextcloud but, in fact, this can be any external URL.

OCS API

It is also possible to get the sites via an OCS endpoint. The request must be authenticated. Only sites for the user´s language are returned:

  -H "OCS-APIRequest: true" \
tps://admin:admin@localhost/ocs/v2.php/apps/external/api/v1

Response

l version="1.0"?>
>
ta>
tatus>ok</status>
tatuscode>200</statuscode>
essage>OK</message>
eta>
ta>
lement>
id>23</id>
name>Homepage</name>
url>https://localhost/index.php</url>
type>link</type>
icon>https://localhost/external.svg</icon>
element>
ata>
s>

Explanation

| Field | Type | Description | | —– | —— | —————————————- | | id | int | Numeric identifier of the site | | name | string | Name of the site, ready to use | | url | string | URL that should be framed/linked to | | type | string | Can be one of link, settings or quota; see this issue for details | | icon | string | Full URL of the icon that should be shown next to the name of the link |

ETag / If-None-Match

The API provides an ETag for the sites array. In case the ETag matches the given value, a 304 Not Modified is delivered together with an empty response body.

Capability

The app registers a capability, so clients can check that before making the actual OCS request:

l version="1.0"?>
>

ta>
apabilities>
..
external>
<v1>
 <element>sites</element>
 <element>device</element>
 <element>groups</element>
 <element>redirect</element>
</v1>
/external>
..