symfttpd is a set of tools to run a web server in your php project, aimed at lazy developers and sysadmins.
This version of symfttpd is under development, this documentation can be outdated and contains some errors.
spawn will setup and start a lighttpd server with a minimal
configuration to serve one PHP project. The server will not be run as
a separate user, which is ideal for developers; also, the server logs
will be written in the project's "log" directory and will include PHP errors.
genconf will generate all the rules necessary to setup a vhost in lighttpd.
It leverages the include_shell directive which means no endless
copy/pasting and easy updates (only restarting lighttpd is necessary).
Once configured (which is straightforward), it will take only one command to create all the symlinks.
Download the .phar file.
Clone this repository and checkout the latest tag.
benjamin:~/dev benjamin $ git clone git://github.com/benja-M-1/symfttpd.git
benjamin:~/dev benjamin $ cd symfttpd
benjamin:~/dev/symfttpd benjamin $ git checkout v2.0.0-dev
Install the vendors with composer
benjamin:~/dev/symfttpd benjamin $ curl -s http://getcomposer.org/installer | php
benjamin:~/dev/symfttpd benjamin $ php composer.phar install
Then compile symfttpd in your project to create an executable .phar file
In order to compile you have to set the phar.readonly setting to Off in you php.ini file.
benjamin:~/dev/project benjamin $ php ../symfttpd/bin/compile
benjamin:~/dev/project benjamin $ php symfttpd.phar --help
Usage:
help [--xml] [command_name]
Arguments:
command The command to execute
command_name The command name (default: 'help')
Options:
--xml To output help as XML
--help (-h) Display this help message.
--quiet (-q) Do not output any message.
--verbose (-v) Increase verbosity of messages.
--version (-V) Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
--no-interaction (-n) Do not ask any interactive question.
Help:
The help command displays help for a given command:
php symfttpd.phar help list
You can also output the help as XML by using the --xml option:
php symfttpd.phar help --xml list
First of all you need to configure symfttpd with a symfttpd.conf.php file. Symfttpd looks for the configuration file:
- in you home directory, this file must be named
.symfttpd.conf.php - in the root directory of your project (or in config/ for a symfony 1.x project)
By default symfttpd read the configuration from it's own symfttpd.conf.php file.
The minimal information symfttpd needs is a project type and a project version.
<?php
// symfttpd.conf.php of a Symfony 2 project
$options['project_type'] = "symfony";
$options['project_version'] = "2";
You can check the reference for more options to configure.
If you don't want to configure a full-blown webserver, edit your host file, edit the configuration, have a web server running even when you don't need it, or deal with permissions, then this tool is for you.
After configuring symfttpd you only have to run the following:
benjamin:~/dev/project benjamin $ php symfttpd.phar spawn -t
It will display something like that:
Symfttpd - version v2.0.0-dev
lighttpd started on 127.0.0.1, port 4042.
Available applications:
http://127.0.0.1:4042/app.php
http://127.0.0.1:4042/app_dev.php
http://127.0.0.1:4042/config.php
http://127.0.0.1:4042/index.php
Press Ctrl+C to stop serving.
error: 2012-05-26 20:19:25: (log.c.166) server started
You can alter the default lighttpd.conf template and the default paths,
by using the symfttpd.conf.php mechanism. Check the reference for more options to configure.
--port=<port>or-p<port>: Use a different port (default is4042) (useful for running multiple projects at the same time)--allor-A: Listen on all interfaces (overrides--bind)--bind=<port>or-b<ip>: Listen on a specific IP (default is127.0.0.1)--tailor-t: Display server logs in the console (like the UNIXtailcommand would do)--single-processor-s: Do not try to run lighttpd in another process (not recommended, you will lose auto-reloading of the rewriting rules)
If you don't want to copy/paste lighttpd configs, handle regular expressions
when you add files, or fight rewriting issues (which can often happen
considering that most available examples are badly written),
then this tool is for you. It is also used internally by spawn.
Typical lighttpd config:
$HTTP["host"] == "example.com" {
include_shell "php /path/to/symfttpd.phar genconf -p /path/to/example.com/web"
}
or if you want a different default application:
$HTTP["host"] == "mobile.example.com" {
include_shell "php /path/to/symfttpd.phar genconf -p /path/to/example.com/web -d mobile"
}
If symfttpd is running in single-process mode, or you only running an independent
lighttpd, you have to restart it each time you add a file in the web/ root.
Hopefully, it doesn't happen often.
Also, in a symfony project, don't forget to run php symfony plugin:publish-assets.
typeThe config file type (config, rules, all). (default: 'rules')--path (-p)Path of the web directory (default: current directory)--output (-o)Directly output the generated configuration.--portThe port to listen (default: 4042)--bindThe address to bind (default: '127.0.0.1')
lighttpd being pronounced lighty, I recommend symfy.
No, and it probably never will be.
Yes. I'd say you should, since the command line options of genconf are
thought for that particular use. genconf does not run symfony or any other
external files, nor writes anything anywhere, so it is very little risk.
Yes.
No!
Yes, just add & after your command.
php /path/to/symfttpd.phar spawn &
To stop a running symfttpd (backgrounding or not), just run:
php path/to/symfttpd.phar spawn --kill