Skip to content

Commit c7c378f

Browse files
committed
2 parents 9293c40 + efbdd73 commit c7c378f

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

+34-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# php-proxy-app
2-
Web Proxy Application built on php-proxy library ready to be installed on your server
2+
Web Proxy Application built on [**php-proxy library**](https://github.com/Athlon1600/php-proxy) ready to be installed on your server
3+
4+
![alt text](http://i.imgur.com/KrtU5KE.png?1 "This is how PHP-Proxy looks when installed")
5+
6+
## Installation
7+
8+
Keep in mind that this is a **project** and not a library. Installing this via *require* would do you not good.
9+
A project such as this, should be installed straight into the public directory of your web server.
10+
11+
```bash
12+
composer create-project athlon1600/php-proxy-app:dev-master /var/www/
13+
```
14+
15+
If you do not have composer or trying to host this application on a **shared hosting**, then download a pre-installed version of this app as a ZIP archive from [**www.php-proxy.com**](https://www.php-proxy.com/)
16+
17+
## Keep it up-to-date
18+
19+
Application itself rarely will change, vast majority of changes will be done to its requirement packages like php-proxy. Simply call this command once in a while to make sure your proxy is always using the latest versions.
20+
21+
```
22+
composer update
23+
```
24+
25+
#### config.php
26+
27+
This file will be loaded into the global Config class.
28+
29+
#### /templates/
30+
31+
This should have been named "views", but for historic purposes we keep it as templates. What this is...
32+
33+
#### /plugins/
34+
35+
PHP-Proxy has many of its native plugins, but users are free to write their own which could then be loaded from this very folder. See /plugins/TestPlugin.php for an example.

0 commit comments

Comments
 (0)