https://github.com/fmstrat/shorten
A URL Shortening and Privacy Tool for ownCloud
https://github.com/fmstrat/shorten
Last synced: about 1 year ago
JSON representation
A URL Shortening and Privacy Tool for ownCloud
- Host: GitHub
- URL: https://github.com/fmstrat/shorten
- Owner: Fmstrat
- Created: 2015-01-15T21:39:22.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-01-21T22:09:23.000Z (over 9 years ago)
- Last Synced: 2025-04-05T18:52:03.374Z (about 1 year ago)
- Language: PHP
- Size: 60.5 KB
- Stars: 31
- Watchers: 8
- Forks: 14
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shorten
Shorten is an add-on app for ownCloud that enables one-click URL shortening. It's features include:
- Automatic replacement of the public share URL with the shortened URL
- No need to create a seperate "Shorten" URL
- Internal shortner or goo.gl support
- Ability to completely hide the ownCloud server with the internal shortener by proxying shortened requests through another server
- Note: While normal shares will never expose the ownCloud URL, password protected files will as the password display screen must be supplied to the user.
## Installation
### Step 1: Install the add-on
- Place this app in *owncloud/apps/shorten* (Rename the extracted ZIP to "shorten" or you will receive errors)
- Re-login to owncloud and run the update
### Step 2: Setup the shortening server
#### *Step 2 - Option A: goo.gl*
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*
#### *Step 2 - Option B: Internal shortener and privacy filter*
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:
- Your owncloud server is at *https://mylongdomain.ext:port/owncloud*
- Your other, "shortening" server, is at *https://mydomain.ext*
- You want your short URLs to be *https://mydomain.ext/s?SHORTCODE*
To accomplish this, you should copy the *REMOTE-HOST/index.php* to the remote host, however you wish. In this example we use scp:
```
mylongdomain ~# scp /var/www/owncloud/apps/shorten/REMOTE-HOST/index.php root@mydomain.ext:/var/www/s/index.php
```
Next, on the shortening server, edit the file to include your ownCloud server URL and set enabled to true:
```
mydomain ~# vi /var/www/s/index.php
```
```