Skip to content

Commit f836e34

Browse files
committed
Update README.md
1 parent 5b58625 commit f836e34

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,17 @@ Shorten is an add-on app for ownCloud that enables one-click URL shortening. It'
77

88
## Installation
99

10-
**Step 1: Install the add-on**
10+
### Step 1: Install the add-on
1111

1212
- Place this app in *owncloud/apps/shorten* (Rename the extracted ZIP to "shorten" or you will receive errors)
1313
- Re-login to owncloud and run the update
1414

15-
**Step 2: Setup the shortening server**
15+
### Step 2: Setup the shortening server
16+
17+
#### *Step 2 - Option A: goo.gl*
18+
To use http://goo.gl, all you need to do is aquire an API key to use in the admin settings. You can aquire a key using these instructions from Google: *https://developers.google.com/url-shortener/v1/getting_started#APIKey*
19+
20+
#### *Step 2 - Option B: Internal shortener and privacy filter*
1621

1722
Next, you must setup your shortening server. This can be the same webserver you are running ownCloud on, or a completely different server to enable a privacy filter for your owncloud installation. For the purpose of this guide, we will assume your setup is:
1823
- Your owncloud server is at *https://mylongdomain.ext:port/owncloud*
@@ -44,10 +49,12 @@ $enabled = true;
4449
#$enabled = false;
4550
```
4651

47-
**Step 3: Configure the app**
52+
### Step 3: Configure the app
4853

49-
Lastly, visit the administration page for ownCloud and in the *Shorten* configuration include your shortening server's URL, which is everything before *?SHORTCODE*. In this case:
54+
Lastly, visit the administration page for ownCloud and in the *Shorten* configuration include your shortening server's URL, which is everything before *?SHORTCODE* if you are using the internal shortener. In this case:
5055
```
5156
https://mydomain.ext/s
5257
```
58+
If you're using http://goo.gl, you would need to include your API key in the provided settings box.
59+
5360
At this point, when you check the box to share a file publically, the app will replace the public share link displayed in the ownCloud web interface.

0 commit comments

Comments
 (0)