supertweet.net

Stand-alone Server

We have created a distribution to make it easy for you to run your own stand-alone instance of the SuperTweet proxy on your own local machine for use by your own local Twitter clients.

This allows you to use applications that have not yet been updated to support OAuth safely and simply, or to use in your own scripts, for example, to post status updates using cURL.

Note: The proxy requires Java (Java 5 or better recommended). To install java, visit: www.java.com.

Installation and setup instructions

These instructions are written for Linux or UNIX-type systems - they will also work on Max OS X in a Terminal window. Since the proxy is Java based, it should work on other platforms as well. For Windows, @TheDarkNighty has graciously put together an installer EXE to automtate the entire process. You can download it here.

Follow the instructions below to download, install, and configure the stand-alone SuperTweet proxy manually.

  1. Download
    Download the distribution from the following link: supertweet-local-dist.tar.gz
  2. Extract the tar archive:
    mkdir supertweet-local
    cd supertweet-local
    tar xzvf $HOME/supertweet-local-dist.tar.gz

  3. Initial Setup
    In the extracted directory, run the following command:
    sh setup.sh
    This will create and initialize the $HOME/.supertweet directory and contents
  4. Create an App on Twitter

    You can register a new application on the Twitter Application Platform. Pay attention to following four settings:

    • Application Name: "INSERT ANY NAME HERE", please make sure it is unique. This will be shown in the streams for users on Twitter.com (i.e. "sent via MyAuth API Proxy"). Also insert at least a 4 words description,
    • Application Website: "INSERT ANY PAGE HERE", it can be your facebook profile, or your company website,
    • Callback url: Must leave this blank
    • Default Access type: Must select “Read & Write”.
  5. Configure the Consumer key and Consumer secret

    After registration, you will get a Consumer key and a Consumer secret on a new window.

    Edit the $HOME/.supertweet/App.properties file with the Consumer key and Consumer secret

    consumer_key = INSERT_CONSUMER_KEY_HERE
    consumer_secret = INSERT_CONSUMER_SECRET_HERE
  6. Start the proxy
    sh run.sh

    This will start the proxy running on the local machine, listening on port 8080. Note: Java is required. To install Java, visit: http://www.java.com/.

  7. Setup your access token

    Open the following page in your browser: http://localhost:8080/setup/access.

    You will be prompted for a username and password. The default is admin/admin - you can change this by editing the $HOME/.supertweet/adminusers file and restarting the proxy.

  8. Authenticate on Twitter.com

    The http://localhost:8080/setup/access page will display a link to Twitter to sign in, along with a form where you enter a PIN and Password.

    The link should open in a new window. Compete the sign-in and Twitter will return a PIN code. Enter this code into the form. Also enter the password that you want to use with the proxy (NOT your actual Twitter password - can be anything). This is the password your apps will use with Basic Auth.

    Click "Submit" and the proxy should indicate that the credentials have been saved.

That completes the one-time installation and setup. In the future, all you need to do to use the proxy is to use the sh run.sh script.

Using the proxy

To use the proxy, simply point your scripts to http://localhost:8080 instead of api.twitter.com. for example:

curl -u user:password -d "status=playing with cURL and the SuperTweet stand-alone proxy" http://localhost:8080/1.1/statuses/update.json

or

curl -u user:password http://localhost:8080/1.1/statuses/home_timeline.json

Source Code

The full source to the standalone proxy is available on Github: https://github.com/mrblog/supertweet-twitter-api-oauth-proxy

The stand-alone proxy is derived from the same code running on the http://supertweet.net site. If you are interested in working on the code, contact the administrator to request update-access to the Github repo. Fixes and updates to the stand-alone proxy will be pushed into the http://supertweet.net code, as appropriate.

Solutions & Use CasesSecurity CenterPhilosophyBlog