Skip to content

Commit d0267ab

Browse files
Updated README
1 parent aac94b4 commit d0267ab

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# Speedfony Bundle
22

3+
![GitHub Issues](https://img.shields.io/github/issues/PHPFastCGI/SpeedfonyBundle.svg)
4+
![GitHub Stars](https://img.shields.io/github/stars/PHPFastCGI/SpeedfonyBundle.svg)
5+
![GitHub License](https://img.shields.io/badge/license-GPLv2-blue.svg)
6+
[![Build Status](https://travis-ci.org/PHPFastCGI/SpeedfonyBundle.svg?branch=master)](https://travis-ci.org/PHPFastCGI/FastCGIDaemon)
7+
[![Coverage Status](https://coveralls.io/repos/PHPFastCGI/SpeedfonyBundle/badge.svg?branch=master)](https://coveralls.io/r/PHPFastCGI/SpeedfonyBundle?branch=master)
8+
39
A symfony2 bundle which allows applications to reduce overheads by exposing symfony's Request-Response structure to a Fast CGI daemon.
10+
11+
## Introduction
12+
13+
Using this bundle, symfony2 applications can stay alive between HTTP requests whilst operating behind the protection of a FastCGI enabled web server.
14+
15+
## Running the Daemon
16+
17+
To start a the daemon listening on port 5000 use the command below. Production mode is selected here for the purposes of generating accurate benchmarks. We do not recommend that you use this package in production mode as it is not yet stable.
18+
19+
Check the FastCGI documentation for your chosen web server to find out how to configure it to use this daemon as a FastCGI application.
20+
21+
```sh
22+
php app/console speedfony:daemon:run --target="tcp://localhost:5000" --env="prod"
23+
```
24+
25+
If you are using apache, you can configure the FastCGI module to launch and manage the daemon itself. For this to work you must omit the "--target" parameter from the command and the daemon will instead listen for incoming connections on FCGI_LISTENSOCK_FILENO (STDIN).
26+
27+
## Current Status
28+
29+
This daemon is currently in early development stages and not considered stable. A
30+
stable release is expected by September 2015.
31+
32+
Contributions and suggestions are welcome.

0 commit comments

Comments
 (0)