From b71f70c985ac6f409dd1fa500922e3b9495b839a Mon Sep 17 00:00:00 2001 From: Jan Lehnardt Date: Sat, 31 Jul 2010 14:49:01 +0200 Subject: [PATCH] add io --- io/index.html | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 io/index.html diff --git a/io/index.html b/io/index.html new file mode 100644 index 0000000..b1bede7 --- /dev/null +++ b/io/index.html @@ -0,0 +1,113 @@ + + + + +io — Personal URL Shortening + +

io — Personal URL Shortening

+ +

+ io is a little piece of code that lets you run your own URL +shortening service. It is free and open source and fun to use. + +

+ The only requirement is Apache + CouchDB. Probably the easiest way to get your own instance is to + sign up for a free account at Couchio + +

Getting Started

+ +

+ If you haven’t already, set up an Admin user for your CouchDB. You can do so + by clicking on the Fix This link in the lower right corner of + Futon, the admin interface. + +

+ There are two ways to get io installed: + +

+ 1. Use CouchApp: + + + $ git clone git://github.com/janl/io.git + $ cd io + $ couchapp push . http://username:password@yourname.couchone.com/io + + +

2. Replicate it: + + + $ curl -X POST \ + http://username:password@yourname.couchone.com/_replicate -d \ + '{"source":"http://shorts.couchone.com/io", "target":"io", \ + "create_target":true}' + + +

+ (this all wants to be on one line, but should be copy-and-pastable) + +

First Run

+ +

+ Now go to + http://yourname.couchone.com/io/_design/io/_rewrite and enjoy a simple + interface to create short URLs. + +

+ Your first short look something like this: + + + http://yourname.couchone.com/io/_design/io/_rewrite/xKcD + + +

+ This isn’t very short. — Do not dispair, CouchDB’s vhosts to the + rescue! + +

+ For simplicity, we assume you are using Couchio’s hosting, but the same is + possible with every other CouchDB installation, there might be more manual + steps involved like setting DNS entries and whatnot. + +

+ First, create a new vhost or virtual host in your CouchDB + configuration. You can do this in Futon or through a simple + curl command: + + + $ curl -X PUT \ + http://username:password@yourname.couchone.com/_config/vhosts/s.yourname.couchone.com \ + -d '"/io/_design/io/_rewrite/"' + + +

+ Now go to s.yourname.couchone.com + and enjoy shorter short URLs. + +

+ Granted, this is still not as short as possible, but if you have your own + domain you want to use, just CNAME it to yourname.couchone.com, + add another vhost just like before and you are good to go. + +

Contact & License

+ +

(c) 2009–2010 Jan Lehnardt <jan@apache.org>, +MIT License. + +

❧ \ No newline at end of file