Bolt 5 standard project skeleton
Bolt CMS is an open source, adaptable platform for building and running modern websites. Built on PHP, Symfony and more. Read the site for more info.
To check out Bolt and set up your first Bolt installation, read Installing Bolt 5.
Installing Bolt CMS
with Composer
Note: Installing with composer and running the site on your local machine using the method described below is the preferred method of the Bolt core development team.
You can set up a new Bolt 5 project, using the following command, replacing myprojectname with your desired project's name.
composer create-project bolt/project myprojectname
Navigate into the newly created folder, and configure the database in .env (The configuration is intended to work with the database SQLite).
# Configure database for doctrine/doctrine-bundle
# SQLite (note: _three_ slashes)
DATABASE_URL=sqlite:///%kernel.project_dir%/var/data/bolt.sqlite
# MYSQL / MariaDB
#DATABASE_URL=mysql://db_user:"db_password"@127.0.0.1:3306/db_name?serverVersion=5.7
# Postgres
#DATABASE_URL=postgresql://db_user:"db_password"@127.0.0.1:5432/db_name?serverVersion=11&charset=utf8
Set up the database, create the first user and add fixtures (dummy content):
bin/console doctrine:database:create # Create database
bin/console doctrine:schema:create # Create schema in database
bin/console doctrine:fixtures:load --no-interaction # Load fixtures in databse (step not compulsory)
bin/console bolt:add-user --admin # Follow the creation steps in the console (warning: fixtures already created an admin user)
composer run post-create-project-cmd # Duplicate themes in the appropriate folder
bin/console bolt:info # Verify Bolt installation
Run Bolt using the built-in webserver, Symfony CLI or your own preferred webserver:
bin/console server:start
or…
symfony server:start -d
symfony open:local
Finally, open the new installation in a browser. If you've used one of the commands above, you'll find the frontpage at http://127.0.0.1:8000/
The Bolt admin panel can be found at http://127.0.0.1:8000/bolt
Log in using the credentials you created when setting up the first user.
Note: If you don't want to use Docker, don't forget to remove what isn't necessary:
- remove.dockerignorefile
- removedocker-composer.ymlfile
- removeDockerfilefile
- removedockerfolder
with Docker
Disclaimer: Docker is not used by the Bolt core development team. Bolt can be run using docker, but you are advised to only attempt this if you have enough experience with Docker yourself to understand what is going on in the Dockerfile and in docker-compose.yml. The included setup might not be a good fit for your Dockerized setup. When in doubt, follow general advice on running Symfony projects in docker, as Bolt is built using Symfony. The Bolt team doesn't provide pre-built containers.
Start by downloading the Bolt project distribution .tar.gz file, or generate a GitHub repository from the template we provide. Once you have extracted its content, the resulting directory contains the Bolt project structure. You will add your own code and configuration inside it.
Note: Try to avoid using the .zip file, as it may cause potential permission issues.
Bolt is shipped with a Docker setup that makes it easy to get a containerized development environment up and running. If you do not already have Docker on your computer, it's the right time to install it.
On Mac, only Docker for Mac is supported. Similarly, on Windows, only Docker for Windows is supported. Docker Machine is not supported out of the box.
Open a terminal, and navigate to the directory containing your project skeleton.
Navigate into the newly created folder, and configure environment variables in the .env file for Docker & the database MySQL version 5.7.
###> symfony/framework-bundle ###
APP_ENV=dev
APP_DEBUG=1
APP_SECRET=!ChangeMe!
TRUSTED_PROXIES=127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16
TRUSTED_HOSTS='^(localhost|nginx)$'
###< symfony/framework-bundle ###
###> doctrine/doctrine-bundle ###
DATABASE_URL=mysql://bolt:!ChangeMe!@db:3306/bolt?serverVersion=5.7
###< doctrine/doctrine-bundle ###
###> symfony/mailer ###
MAILER_DSN=smtp://mailcatcher:1025
###< symfony/mailer ###
Run the following command to start all services using Docker Compose:
docker-compose up -d # Running in detached mode
docker-compose exec php bin/console doctrine:schema:create # Create schema in database
docker-compose exec php bin/console doctrine:fixtures:load --no-interaction # Load fixtures in databse (step not compulsory)
docker-compose exec php bin/console bolt:add-user --admin # Follow the creation steps in the console (warning: fixtures already created an admin user)
This starts the following services:
| Name | Description | Port(s) | Environment(s) |
|---|---|---|---|
| db | A MySQL 5.7 database server | 3306 | all (prefer using a managed service in prod) |
| php | The Bolt project with PHP, PHP-FPM 7.4, Composer and sensitive configs | n/a | all |
| nginx | The HTTP server for the Bolt project (NGINX) | 8080 | all |
| h2-proxy | A HTTP/2 and HTTPS development proxy for all apps | 8443 | dev (configure properly your web server in prod) |
| mailcatcher | MailCatcher runs a super simple SMTP server delivered with a web interface | 1025 for smtp port 1080 for interface |
only for dev |
To see the status of the containers, run:
docker-compose ps
To execute commands in a container, run:
docker-compose exec <container name> <command>
docker-compose exec php sh # To enter the container directly, you will be placed at the root of the project
docker-compose exec php bin/console bolt:add-user # Follow the creation steps in the console (warning: fixtures already created an admin user)
To see the container's logs, run:
docker-compose logs # Display the logs of all containers
docker-compose logs -f # Same but follow the logs
docker-compose logs -f php # Follow the logs for one container
Finally, open the new installation in a browser. If you've used one of the commands above, you'll find the frontpage at http://localhost:8080/ or https://localhost:8443/
The Bolt admin panel can be found at http://localhost:8080/bolt or https://localhost:8443/bolt
The tests
Static analysis
The ecs.php configuration file is located at the root of the cms project
# With Composer
composer lint # Launch ECS in dry run mode (command to launch in a Continuous Integration)
composer lint:fix # Launch ECS in fix mode
# With Docker
docker-compose exec php composer lint # Launch ECS by the php container
The phpstan.neon configuration file is located at the root of the cms project
# With Composer
composer phpstan # Launch PHPStan (command to launch in a Continuous Integration)
# With Docker
docker-compose exec php composer phpstan # Launch PHPStan by the php container
Contributing
If you'd like to contribute, please check Bolt's core repository and read the "Contributing to Bolt" documentation page.
5 Aug 15, 2022
1.6k Jan 5, 2023
600 Jan 4, 2023
1.1k Jan 3, 2023
524 Dec 30, 2022
132 Nov 27, 2022
71 Dec 18, 2022
96 Sep 6, 2022
2 Aug 9, 2022
6 Oct 3, 2022
412 Dec 27, 2022
858 Jan 6, 2023
3k Jan 6, 2023
4 Oct 28, 2022
118 Dec 14, 2022
623 Nov 12, 2022
272 Dec 30, 2022
804 Jan 3, 2023