You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Nextcloud bot b5a279cf07
[tx-robot] updated from transifex
1 day ago
.github Add the issue template 2 years ago
.tx Fix tx config 1 year ago
appinfo Fix creation of the application class 2 weeks ago
css Make sure the white image also has 32px width 1 month ago
docs Update admin settings screenshot 2 years ago
img Add repair step to copy the icons on install and update 2 years ago
js Fix generation of the quota link in the files app 2 weeks ago
l10n [tx-robot] updated from transifex 1 day ago
lib Add line breaks 1 week ago
templates Merge pull request #54 from vorph1/master 1 month ago
.gitignore Update changelog 1 year ago
CHANGELOG.md Add changelog for 3.4.1 1 month ago
Makefile Move to compiled handlebars 1 year ago
README.md Publish the redirect parameter 1 year ago

README.md

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:

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

Response

<?xml version="1.0"?>
<ocs>
 <meta>
  <status>ok</status>
  <statuscode>200</statuscode>
  <message>OK</message>
 </meta>
 <data>
  <element>
   <id>23</id>
   <name>Homepage</name>
   <url>https://localhost/index.php</url>
   <type>link</type>
   <redirect>0</redirect>
   <icon>https://localhost/external.svg</icon>
  </element>
 </data>
</ocs>

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
redirect int Whether the link should be opened inline or in a new window
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:

<?xml version="1.0"?>
<ocs>
 ...
 <data>
  <capabilities>
   ...
   <external>
    <v1>
     <element>sites</element>
     <element>device</element>
     <element>groups</element>
     <element>redirect</element>
    </v1>
   </external>
   ...