Tweetr - PHP Proxy
Requirements
- >= PHP 5
- CURL must be available to PHP
- Use of `.htaccess` / `ModRewrite` must be available/granted
Installation
- Put the `/proxy` wherever you need it on your server.
- Call the proxy in your webbrowser by directing it to the folder you just copied the proxy into (for example: `/proxy/install.php`)
- Follow the Installer Steps ;) !
Settings
The `index.php` file allows you to configure certain aspects of the Proxy. Syntax is always: `$tweetrOptions['NAME'] = VALUE;`
Options
| Name | Required | Description | Default value |
|---|---|---|---|
| baseURL | yes | Base URL of the Proxy | (string) `/proxy` |
| userAgent | no | User Agent Name | (string) `TweetrProxy/0.92` |
| userAgentLink | no | Link to your User Agent | (string) `http://tweetr.googlecode.com` |
| debugMode | no | Turns Debug Mode ON or OFF. | (boolean) `false` |
| ghostName | no | Ghost Authentication Name | (string) `ghost` |
| ghostPass | no | Ghost Authentication Password | (string) `ghost` |
| userName | no | Username to use instead of Ghost Auth | (null) |
| userPass | no | Password to use instead of Ghost Auth | (null) |
Details
baseURL
As the name says it's the base url where the proxy can find itself. See installation step 3 for more information.
userAgent
Allows you to set your own User Agent under which the Proxy will do requests to the twitter api
userAgentLink
Allows you to set a link to a website for your User Agent. When somebody hits `index.php` he will see the User Agent String which is linked to the website you define here. For an example see http://labs.swfjunkie.com/tweetr/proxy/
debugMode
`Tweetr.php` allows you to add your own Debugging Routine to it's code, you can enable debugMode by setting this value to true.
ghostName & ghostPass
This allows you to mask/hide the actual username you are going to use when you also define `userName` and `userPass`.
From your app you pass these ghost credentials and the proxy will recognize that and actually use the `userName` and `userPass` supplied instead of the ghost credentials.
userName & userPass
See `ghostName` & `ghostPass`