Skip to content

Commit

Permalink
[book][installation] Changing setfacl commands per @1ed
Browse files Browse the repository at this point in the history 
I'm really unsure about all of this, but we're listening to the recommendations of the community, and hopefully getting closer.
  • Loading branch information
@weaverryan
weaverryan committed Jun 15, 2011
1 parent a8fbcab commit 1f87a05
Showing 1 changed file with 34 additions and 190 deletions.
224 changes: 34 additions & 190 deletions book/installation.rst
View file
@@ -1,209 +1,53 @@
.. index::
single: Installation
Setting up Permissions
----------------------

Installing and Configuring Symfony
==================================
One common issue is that the ``app/cache`` and ``app/logs`` directories
must be writable both by the web server and the command line user. On
a UNIX system, if your web server user is different from your command
line user, you can run the following commands just once in your project
to ensure that permissions will be setup properly. Change ``www-data``
to the web server user and ``yourname`` to your command line user:

The goal of this chapter is to get you up and running with a working application
built on top of Symfony. Fortunately, Symfony offers "distributions", which
are functional Symfony "starter" projects that you can download and begin
developing in immediately.

Downloading a Symfony2 Distribution
-----------------------------------

.. tip::

First, check that you have installed and configured a Web server (such
as Apache) with PHP 5.3.2 or higher. For more information on Symfony2
requirements, see the :doc:`requirements reference</reference/requirements>`.

Symfony2 packages "distributions", which are fully-functional applications
that include the Symfony2 core libraries, a selection of useful bundles, a
sensible directory structure and some default configuration. When you download
a Symfony2 distribution, you're downloading a functional application skeleton
that can be used immediately to begin developing your application.

Start by visiting the Symfony2 download page at `http://symfony.com/download`_.
On this page, you'll see the *Symfony Standard Edition*, which is the main
Symfony2 distribution. Here, you'll need to make two choices:

* Download either a ``.tgz`` or ``.zip`` archive - both are equivalent, download
whatever you're more comfortable using;

* Download the distribution with or without vendors. If you have `Git`_ installed
on your computer, you should download Symfony2 "without vendors", as it
adds a bit more flexibility when including third-party/vendor libraries.

Download one of the archives somewhere under your local web server's root
directory and unpack it. From a UNIX command line, this can be done with
one of the following commands (replacing ``###`` with your actual filename):

.. code-block:: bash
# for .tgz file
tar zxvf Symfony_Standard_Vendors_2.0.###.tgz
# for a .zip file
unzip Symfony_Standard_Vendors_2.0.###.tgz
When you're finished, you should have a ``Symfony/`` directory that looks
something like this:

.. code-block:: text
www/ <- your web root directory
Symfony/ <- the unpacked archive
app/
cache/
config/
logs/
src/
...
vendor/
...
web/
app.php
...
Updating Vendors
~~~~~~~~~~~~~~~~

Finally, if you downloaded the archive "without vendors", install the vendors
by running the following command from the command line:
**1. Using ACL on a system that supports chmod +a**

.. code-block:: bash
php bin/vendors install
This command downloads all of the necessary vendor libraries - including
Symfony itself - into the ``vendor/`` directory.

Configuration and Setup
~~~~~~~~~~~~~~~~~~~~~~~

At this point, all of the needed third-party libraries now live in the ``vendor/``
directory. You also have a default application setup in ``app/`` and some
sample code inside the ``src/`` directory.

Symfony2 comes with a visual server configuration tester to help make sure
your Web server and PHP are configured to use Symfony. Use the following URL
to check your configuration:

.. code-block:: text
http://localhost/Symfony/web/config.php
If there are any issues, correct them now before moving on.

.. sidebar:: Setting up Permissions

One common issue is that the ``app/cache`` and ``app/logs`` directories
must be writable both by the web server and the command line user. On
a UNIX system, if your web server user is different from your command
line user, you can run the following commands just once in your project
to ensure that permissions will be setup properly. Change ``www-data``
to the web server user and ``yourname`` to your command line user:

**1. Using ACL on a system that supports chmod +a**

.. code-block:: bash
Many systems allow you to use the ``chmod +a`` command. Try this first,
and if you get an error - try the next method:
rm -rf app/cache/*
rm -rf app/logs/*
sudo chmod +a "www-data allow delete,write,append,file_inherit,directory_inherit" app/cache app/logs
sudo chmod +a "yourname allow delete,write,append,file_inherit,directory_inherit" app/cache app/logs
**2. Using Acl on a system that does not support chmod +a**
Some systems, like Ubuntu, don't support ``chmod +a``, but do support
another utility called ``setfacl``. On some systems, this will need to
be installed before using it:
.. code-block:: bash
setfacl -m u:www-data:rw -R app/cache app/logs
setfacl -m u:yourname:rw -R app/cache app/logs
**3. Without using ACL**
If you don't have access to changing the ACL of the directories, you will
need to change the umask so that the cache and log directories will
be group-writable or world-writable (depending if the web server user
and the command line user are in the same group or not). To achieve
this, put the following line at the beginning of the ``app/console``,
``web/app.php`` and ``web/app_dev.php`` files:
.. code-block:: php
umask(0002); // This will let the permissions be 0775
// or
umask(0000); // This will let the permissions be 0777
Note that using the ACL is recommended when you have access to them
on your server because changing the umask is not thread-safe.
When everything is fine, click on "Go to the Welcome page" to request your
first "real" Symfony2 webpage:
.. code-block:: text
http://localhost/Symfony/web/app_dev.php/
Symfony2 should welcome and congratulate you for your hard work so far!
.. image:: /images/quick_tour/welcome.jpg
Beginning Development
---------------------
Many systems allow you to use the ``chmod +a`` command. Try this first,
and if you get an error - try the next method:

This comment has been minimized.

Sign in to view

Copy link
@stof

stof Jun 15, 2011

Member

This sentence should not be in the code_block directive
Now that you have a fully-functional Symfony2 application, you can begin
development! Your distribution may contain some sample code - check the
``README.rst`` file included with the distribution (open it as a text file)
to learn about what sample code was included with your distribution and how
you can remove it later.
rm -rf app/cache/*
rm -rf app/logs/*
If you're new to Symfony, join us in the ":doc:`page_creation`", where you'll
learn how to create pages, change configuration, and do everything else you'll
need in your new application.
sudo chmod +a "www-data allow delete,write,append,file_inherit,directory_inherit" app/cache app/logs
sudo chmod +a "yourname allow delete,write,append,file_inherit,directory_inherit" app/cache app/logs
Using Source Control
--------------------
**2. Using Acl on a system that does not support chmod +a**
If you're using a version control system like ``Git`` or ``Subversion``, you
can setup your version control system and begin committing your project to
it as normal. For ``Git``, this can be done easily with the following command:
Some systems, like Ubuntu, don't support ``chmod +a``, but do support
another utility called ``setfacl``. On some systems, this will need to
be installed before using it:
.. code-block:: bash
git init
sudo setfacl -R -m u:www-data:rwx -m u:yourname:rwx app/cache app/logs
sudo setfacl -dR -m u:www-data:rwx -m u:yourname:rwx app/cache app/logs
For more information on setting up and using Git, check out the `GitHub Bootcamp`_
tutorials.
**3. Without using ACL**
Ignoring the ``vendor/`` Directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you don't have access to changing the ACL of the directories, you will
need to change the umask so that the cache and log directories will
be group-writable or world-writable (depending if the web server user
and the command line user are in the same group or not). To achieve
this, put the following line at the beginning of the ``app/console``,
``web/app.php`` and ``web/app_dev.php`` files:
If you've downloaded the archive *without vendors*, you can safely ignore
the entire ``vendors/`` directory and not commit it to source control. With
``Git``, this is done by creating and adding the following to a ``.gitignore``
file:
.. code-block:: php
.. code-block:: text
umask(0002); // This will let the permissions be 0775
vendor/
// or
Now, the vendor directory won't be committed to source control. This is fine
(actually, it's great!) because when someone else clones or checks out the
project, he/she can simply run the ``php bin/vendors install`` script to
download all the necessary vendor libraries.
umask(0000); // This will let the permissions be 0777
.. _`http://symfony.com/download`: http://symfony.com/download
.. _`Git`: http://git-scm.com/
.. _`GitHub Bootcamp`: http://help.github.com/set-up-git-redirect
Note that using the ACL is recommended when you have access to them
on your server because changing the umask is not thread-safe.

2 comments on commit 1f87a05

@stof
Copy link
Member

@stof stof commented on 1f87a05 Jun 15, 2011

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this file should be renamed as it does not describe the installation anymore but only the handling of permissions

@weaverryan
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, I totally foobared this commit - I've fixed it now - it was meant to just change the commands - thanks for noticing this :)

Please sign in to comment.