1-installation.md

Installation

Download and install

Run the following command to install:

composer require sulu/community-bundle:^2.0@dev --no-scripts

Enable Bundle

Enable the required bundles in the config/bundles.php of your project:

+    Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true],
+    Sulu\Bundle\CommunityBundle\SuluCommunityBundle::class => ['all' => true],
-    Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true, 'admin' => true], 

To avoid the:

Trying to register two bundles with the same name "SecurityBundle"

Register Routes

Register the website routes:

# config/routes/sulu_community_website.yaml

sulu_community:
    type: portal
    resource: "@SuluCommunityBundle/Resources/config/routing_website.yaml"

Register the admin routes:

# config/routes/sulu_community_admin.yaml

sulu_community_api:
    type: rest
    resource: "@SuluCommunityBundle/Resources/config/routing_api.yaml"
    prefix: /admin/api

Configure security

Enable and configure the security for the website in the security_website.yaml:

# config/packages/security_website.yml

security:
    encoders:
        Sulu\Bundle\SecurityBundle\Entity\User: bcrypt

    providers:
        sulu:
            id: sulu_security.user_provider

    access_control:
        # needed when firewall on ^/ is not anonymous
        # - { path: '/login', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        # - { path: '/registration', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        # - { path: '/password-reset', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        # - { path: '/password-forget', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        # - { path: '/_fragment', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: '/profile', roles: ROLE_USER }
        - { path: '/completion', roles: ROLE_USER }

    firewalls:
        <webspace_key>: # Replace <webspace_key> with the key of your webspace
            pattern: ^/
            anonymous: lazy
            form_login:
                login_path: sulu_community.login
                check_path: sulu_community.login
            logout:
                path: sulu_community.logout
                target: /
            remember_me:
                secret:   "%kernel.secret%"
                lifetime: 604800 # 1 week in seconds
                path:     /

sulu_security:
    checker:
        enabled: true

When implementing functional tests, website security needs to enabled in the test environment:

# config/packages/test/security_website.yml

security:
    providers:
        sulu:
            id: test_user_provider

    firewalls:
        <webspace_key>: # Replace <webspace_key> with the key of your webspace
            http_basic: ~

sulu_test:
    enable_test_user_provider: true

Clear cache

In order to use the new configuration, the caches need to be cleared:

php bin/adminconsole cache:clear
php bin/websiteconsole cache:clear

Create database tables

Execute the following command to get the sqls to update your database.

php bin/adminconsole doctrine:schema:update --dump-sql

You can use --force to run the sqls but be carefully which other sql statements are maybe executed.

It's recommended to use DoctrineMigrationsBundle for this kind of database migrations.

The next required step is to Setup your Webspace