Getting Started with Sulu CMS on Vagrant The Right Way™

This tutorial guides you through deploying a Sulu "Hello World" instance using Homestead Improved, addressing performance and configuration. Prior Homestead Improved experience is recommended. We'll cover common Sulu/Vagrant pitfalls and setting up your Sulu project, including database creation, project building, and administrator login. A FAQ section addresses common Sulu questions.

Key Concepts:

• Comprehensive Sulu "Hello World" deployment guide using Homestead Improved.
• Focus on performance optimization and configuration best practices.
• Addresses common issues encountered when using Sulu CMS within a Vagrant environment.
• Detailed steps for project setup, including database creation, build process, and administrator login.
• FAQ section covering Sulu suitability for news sites, polyfill usage, and Symfony 4/Flex compatibility.

Let's begin building your Sulu foundation. This tutorial focuses on a robust setup for future Sulu projects. Please comment with any questions. Many thanks to Daniel Rotter and Patrik Karisch for their assistance!

(Note: Familiarity with Homestead Improved is strongly recommended. Consider our PHP Environment Basics book if you need to brush up.)

---

Project Name Input

This tutorial uses placeholders replaced with your project name. Enter your project name below:

Project name:

Generated slug: my_sulu_project

---

OS X Vagrant Folder Sharing:

For OS X users employing NFS folder sharing, the vagrant-bindfs plugin is essential. Install it via vagrant plugin install vagrant-bindfs. This prevents future headaches. Homestead Improved handles the rest automatically.

Vagrant Setup:

1. Clone the Homestead Improved repository:

   git clone https://github.com/swader/homestead_improved my_sulu_project
   cd my_sulu_project

2. Configure shared folders:

   bin/folderfix.sh

   This shares your working directory with the VM's /Code directory.

3. Modify Homestead.yaml:

   Add NFS folder sharing (OS X/Windows 10) and the Sulu project type, adjusting the document root to web:

   ...
   
   folders:
       - map: /Users/swader/vagrant_boxes/homestead/my_sulu_project
         to: /home/vagrant/Code
         type: nfs
   
   sites:
       - map: my_sulu_project.app
         to: /home/vagrant/Code/my_sulu_project/web
         type: sulu
   

4. Start the VM:

   vagrant up; vagrant ssh

   Pro Tip: Create aliases for easier future use:

   alias vh='vagrant halt; cd ..'
   alias vush='vagrant up; vagrant ssh'

Sulu Project Setup:

Project Creation

Install the Sulu minimal edition (now the standard edition):

cd Code
composer create-project sulu/sulu-minimal my_sulu_project

The installer prompts for database, email, and other settings. You primarily need database details; you can adjust app/config/parameters.yml later.

Webspaces

Rename app/Resources/webspaces/example.com.xml to app/Resources/webspaces/my_sulu_project.xml and update the <name></name> and <key></key> elements to match your project:

git clone https://github.com/swader/homestead_improved my_sulu_project
cd my_sulu_project

(The filename and <key></key> don't need to match, but consistency is recommended. Changing the <key></key> later is complex.)

Database Creation

Create the database (Homestead Improved uses homestead user with secret password).

Build Process

Run the build command:

bin/folderfix.sh

Confirm the options (explained in detail in the original article).

Login

Access the frontend at my_sulu_project.app/. Login to the backend at my_sulu_project.app/admin/ using admin/admin.

Pitfalls and FAQ:

Sulu for News Websites?

Not ideally by default. The SuluArticleBundle (under development) is better suited for frequent article publishing.

Polyfills?

Symfony's polyfills for older PHP versions slow down installation. Discussions are underway to improve this.

Symfony 4 and Flex Compatibility?

Yes, Sulu is adapting. You can test with Sulu 1.6.0-RC1 (using Symfony 3.3) via:

...

folders:
    - map: /Users/swader/vagrant_boxes/homestead/my_sulu_project
      to: /home/vagrant/Code
      type: nfs

sites:
    - map: my_sulu_project.app
      to: /home/vagrant/Code/my_sulu_project/web
      type: sulu

Conclusion:

Sulu is maturing and becoming more developer-friendly. This tutorial aims to help you understand its capabilities and use it effectively. Please leave comments with any questions or issues.

The above is the detailed content of Getting Started with Sulu CMS on Vagrant The Right Way™. For more information, please follow other related articles on the PHP Chinese website!