Nuša Pukšič
9 months ago
34 changed files with 140 additions and 1023 deletions
@ -1 +0,0 @@ |
|||||||
docker exec newsroom-php-1 php bin/console asset-map:compile |
|
||||||
@ -1,49 +0,0 @@ |
|||||||
fos_elastica: |
|
||||||
clients: |
|
||||||
default: |
|
||||||
host: '%env(ELASTICSEARCH_HOST)%' |
|
||||||
port: '%env(int:ELASTICSEARCH_PORT)%' |
|
||||||
username: '%env(ELASTICSEARCH_USERNAME)%' |
|
||||||
password: '%env(ELASTICSEARCH_PASSWORD)%' |
|
||||||
indexes: |
|
||||||
# create the index by running php bin/console fos:elastica:populate |
|
||||||
articles: |
|
||||||
settings: |
|
||||||
index: |
|
||||||
# Increase refresh interval for better write performance |
|
||||||
refresh_interval: "5s" |
|
||||||
# Optimize indexing |
|
||||||
number_of_shards: 1 |
|
||||||
number_of_replicas: 0 |
|
||||||
analysis: |
|
||||||
analyzer: |
|
||||||
custom_analyzer: |
|
||||||
type: custom |
|
||||||
tokenizer: standard |
|
||||||
filter: [ lowercase, snowball, asciifolding ] |
|
||||||
indexable_callback: [ 'App\Util\IndexableArticleChecker', 'isIndexable' ] |
|
||||||
properties: |
|
||||||
createdAt: |
|
||||||
type: keyword |
|
||||||
title: |
|
||||||
type: text |
|
||||||
analyzer: custom_analyzer |
|
||||||
content: |
|
||||||
type: text |
|
||||||
analyzer: custom_analyzer |
|
||||||
summary: |
|
||||||
type: text |
|
||||||
analyzer: custom_analyzer |
|
||||||
tags: |
|
||||||
type: keyword |
|
||||||
slug: |
|
||||||
type: keyword |
|
||||||
pubkey: |
|
||||||
type: keyword |
|
||||||
topics: ~ |
|
||||||
persistence: |
|
||||||
driver: orm |
|
||||||
model: App\Entity\Article |
|
||||||
provider: ~ |
|
||||||
listener: ~ |
|
||||||
finder: ~ |
|
||||||
@ -1,29 +0,0 @@ |
|||||||
# Using Alpine Linux Instead of Debian |
|
||||||
|
|
||||||
By default, Symfony Docker uses Debian-based FrankenPHP Docker images. |
|
||||||
This is the recommended solution. |
|
||||||
|
|
||||||
Alternatively, it's possible to use Alpine-based images, which are smaller but |
|
||||||
are known to be slower, and have several known issues. |
|
||||||
|
|
||||||
To switch to Alpine-based images, apply the following changes to the `Dockerfile`: |
|
||||||
|
|
||||||
```patch |
|
||||||
-FROM dunglas/frankenphp:1-php8.3 AS frankenphp_upstream |
|
||||||
+FROM dunglas/frankenphp:1-php8.3-alpine AS frankenphp_upstream |
|
||||||
|
|
||||||
-# hadolint ignore=DL3008 |
|
||||||
-RUN apt-get update && apt-get install -y --no-install-recommends \ |
|
||||||
- acl \ |
|
||||||
- file \ |
|
||||||
- gettext \ |
|
||||||
- git \ |
|
||||||
- && rm -rf /var/lib/apt/lists/* |
|
||||||
+# hadolint ignore=DL3018 |
|
||||||
+RUN apk add --no-cache \ |
|
||||||
+ acl \ |
|
||||||
+ file \ |
|
||||||
+ gettext \ |
|
||||||
+ git \ |
|
||||||
+ ; |
|
||||||
``` |
|
||||||
|
Before Width: | Height: | Size: 126 KiB |
|
Before Width: | Height: | Size: 159 KiB |
@ -1,44 +0,0 @@ |
|||||||
# Installing on an Existing Project |
|
||||||
|
|
||||||
It's also possible to use Symfony Docker with existing projects! |
|
||||||
|
|
||||||
First, [download this skeleton](https://github.com/dunglas/symfony-docker). |
|
||||||
|
|
||||||
If you cloned the Git repository, be sure to not copy the `.git` directory to prevent conflicts with the `.git` directory already in your existing project. |
|
||||||
You can copy the contents of the repository using git and tar. This will not contain `.git` or any uncommited changes. |
|
||||||
|
|
||||||
git archive --format=tar HEAD | tar -xC my-existing-project/ |
|
||||||
|
|
||||||
If you downloaded the skeleton as a zip you can just copy the extracted files: |
|
||||||
|
|
||||||
cp -Rp symfony-docker/. my-existing-project/ |
|
||||||
|
|
||||||
Enable the Docker support of Symfony Flex: |
|
||||||
|
|
||||||
composer config --json extra.symfony.docker 'true' |
|
||||||
|
|
||||||
Re-execute the recipes to update the Docker-related files according to the packages you use |
|
||||||
|
|
||||||
rm symfony.lock |
|
||||||
composer recipes:install --force --verbose |
|
||||||
|
|
||||||
Double-check the changes, revert the changes that you don't want to keep: |
|
||||||
|
|
||||||
git diff |
|
||||||
... |
|
||||||
|
|
||||||
Build the Docker images: |
|
||||||
|
|
||||||
docker compose build --no-cache --pull |
|
||||||
|
|
||||||
Start the project! |
|
||||||
|
|
||||||
docker compose up -d |
|
||||||
|
|
||||||
Browse `https://localhost`, your Docker configuration is ready! |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> If you want to use the worker mode of FrankenPHP, make sure you required the `runtime/frankenphp-symfony` package. |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> The worker mode of FrankenPHP is enabled by default in prod. To disabled it, add the env var FRANKENPHP_CONFIG as empty to the compose.prod.yaml file. |
|
||||||
@ -1,18 +0,0 @@ |
|||||||
# Support for Extra Services |
|
||||||
|
|
||||||
Symfony Docker is extensible. When you install a compatible Composer package using Symfony Flex, |
|
||||||
the recipe will automatically modify the `Dockerfile` and `compose.yaml` to fulfill the requirements of this package. |
|
||||||
|
|
||||||
The currently supported packages are: |
|
||||||
|
|
||||||
* `symfony/orm-pack`: install a PostgreSQL service |
|
||||||
* `symfony/mercure-bundle`: use the Mercure.rocks module shipped with Caddy |
|
||||||
* `symfony/panther`: install chromium and these drivers |
|
||||||
* `symfony/mailer`: install a Mailpit service |
|
||||||
* `blackfireio/blackfire-symfony-meta`: install a Blackfire service |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> If a recipe modifies the Dockerfile, the container needs to be rebuilt. |
|
||||||
|
|
||||||
> [!WARNING] |
|
||||||
> We recommend that you use the `composer require` command inside the container in development mode so that recipes can be applied correctly |
|
||||||
@ -0,0 +1,17 @@ |
|||||||
|
# Features |
||||||
|
|
||||||
|
## Search Functionality (REMOVED) |
||||||
|
- **Status**: Being removed as part of scaling down |
||||||
|
- **Previous implementation**: Used Elasticsearch via FOSElasticaBundle |
||||||
|
- **Replacement**: Will need basic database-based search for articles by title/content if search is still needed |
||||||
|
- **Components affected**: |
||||||
|
- SearchComponent (Twig component) |
||||||
|
- FeaturedList component |
||||||
|
- Article indexing commands |
||||||
|
- Controllers using Elasticsearch queries |
||||||
|
|
||||||
|
## Core Features to Preserve |
||||||
|
- Article management (CRUD operations) |
||||||
|
- Article display and listing |
||||||
|
- Author pages |
||||||
|
- Basic article filtering (should use database queries instead of Elasticsearch) |
||||||
@ -1,97 +0,0 @@ |
|||||||
# Makefile |
|
||||||
|
|
||||||
Here is a Makefile template. It provides some shortcuts for the most common tasks. |
|
||||||
To use it, create a new `Makefile` file at the root of your project. Copy/paste |
|
||||||
the content in the template section. To view all the available commands, run `make`. |
|
||||||
|
|
||||||
For example, in the [getting started section](/README.md#getting-started), the |
|
||||||
`docker compose` commands could be replaced by: |
|
||||||
|
|
||||||
1. Run `make build` to build fresh images |
|
||||||
2. Run `make up` (detached mode without logs) |
|
||||||
3. Run `make down` to stop the Docker containers |
|
||||||
|
|
||||||
Of course, this template is basic for now. But, as your application is growing, |
|
||||||
you will probably want to add some targets like running your tests as described |
|
||||||
in [the Symfony book](https://symfony.com/doc/current/the-fast-track/en/17-tests.html#automating-your-workflow-with-a-makefile). |
|
||||||
You can also find a more complete example in this [snippet](https://www.strangebuzz.com/en/snippets/the-perfect-makefile-for-symfony). |
|
||||||
|
|
||||||
If you want to run make from within the `php` container, in the [Dockerfile](/Dockerfile), |
|
||||||
add: |
|
||||||
|
|
||||||
```diff |
|
||||||
gettext \ |
|
||||||
git \ |
|
||||||
+make \ |
|
||||||
``` |
|
||||||
|
|
||||||
And rebuild the PHP image. |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> If you are using Windows, you have to install [chocolatey.org](https://chocolatey.org/) or [Cygwin](http://cygwin.com) to use the `make` command. Check out this [StackOverflow question](https://stackoverflow.com/q/2532234/633864) for more explanations. |
|
||||||
|
|
||||||
## The template |
|
||||||
|
|
||||||
```Makefile |
|
||||||
# Executables (local) |
|
||||||
DOCKER_COMP = docker compose |
|
||||||
|
|
||||||
# Docker containers |
|
||||||
PHP_CONT = $(DOCKER_COMP) exec php |
|
||||||
|
|
||||||
# Executables |
|
||||||
PHP = $(PHP_CONT) php |
|
||||||
COMPOSER = $(PHP_CONT) composer |
|
||||||
SYMFONY = $(PHP) bin/console |
|
||||||
|
|
||||||
# Misc |
|
||||||
.DEFAULT_GOAL = help |
|
||||||
.PHONY : help build up start down logs sh composer vendor sf cc test |
|
||||||
|
|
||||||
## —— 🎵 🐳 The Symfony Docker Makefile 🐳 🎵 —————————————————————————————————— |
|
||||||
help: ## Outputs this help screen |
|
||||||
@grep -E '(^[a-zA-Z0-9\./_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/' |
|
||||||
|
|
||||||
## —— Docker 🐳 ———————————————————————————————————————————————————————————————— |
|
||||||
build: ## Builds the Docker images |
|
||||||
@$(DOCKER_COMP) build --pull --no-cache |
|
||||||
|
|
||||||
up: ## Start the docker hub in detached mode (no logs) |
|
||||||
@$(DOCKER_COMP) up --detach |
|
||||||
|
|
||||||
start: build up ## Build and start the containers |
|
||||||
|
|
||||||
down: ## Stop the docker hub |
|
||||||
@$(DOCKER_COMP) down --remove-orphans |
|
||||||
|
|
||||||
logs: ## Show live logs |
|
||||||
@$(DOCKER_COMP) logs --tail=0 --follow |
|
||||||
|
|
||||||
sh: ## Connect to the FrankenPHP container |
|
||||||
@$(PHP_CONT) sh |
|
||||||
|
|
||||||
bash: ## Connect to the FrankenPHP container via bash so up and down arrows go to previous commands |
|
||||||
@$(PHP_CONT) bash |
|
||||||
|
|
||||||
test: ## Start tests with phpunit, pass the parameter "c=" to add options to phpunit, example: make test c="--group e2e --stop-on-failure" |
|
||||||
@$(eval c ?=) |
|
||||||
@$(DOCKER_COMP) exec -e APP_ENV=test php bin/phpunit $(c) |
|
||||||
|
|
||||||
|
|
||||||
## —— Composer 🧙 —————————————————————————————————————————————————————————————— |
|
||||||
composer: ## Run composer, pass the parameter "c=" to run a given command, example: make composer c='req symfony/orm-pack' |
|
||||||
@$(eval c ?=) |
|
||||||
@$(COMPOSER) $(c) |
|
||||||
|
|
||||||
vendor: ## Install vendors according to the current composer.lock file |
|
||||||
vendor: c=install --prefer-dist --no-dev --no-progress --no-scripts --no-interaction |
|
||||||
vendor: composer |
|
||||||
|
|
||||||
## —— Symfony 🎵 ——————————————————————————————————————————————————————————————— |
|
||||||
sf: ## List all Symfony commands or pass the parameter "c=" to run a given command, example: make sf c=about |
|
||||||
@$(eval c ?=) |
|
||||||
@$(SYMFONY) $(c) |
|
||||||
|
|
||||||
cc: c=c:c ## Clear the cache |
|
||||||
cc: sf |
|
||||||
``` |
|
||||||
@ -1,83 +0,0 @@ |
|||||||
# Using MySQL |
|
||||||
|
|
||||||
The Docker configuration of this repository is extensible thanks to Flex recipes. By default, the recipe installs PostgreSQL. |
|
||||||
If you prefer to work with MySQL, follow these steps: |
|
||||||
|
|
||||||
First, install the `symfony/orm-pack` package as described: `docker compose exec php composer req symfony/orm-pack` |
|
||||||
|
|
||||||
## Docker Configuration |
|
||||||
Change the database image to use MySQL instead of PostgreSQL in `compose.yaml`: |
|
||||||
|
|
||||||
```diff |
|
||||||
###> doctrine/doctrine-bundle ### |
|
||||||
- image: postgres:${POSTGRES_VERSION:-15}-alpine |
|
||||||
+ image: mysql:${MYSQL_VERSION:-8} |
|
||||||
environment: |
|
||||||
- POSTGRES_DB: ${POSTGRES_DB:-app} |
|
||||||
+ MYSQL_DATABASE: ${MYSQL_DATABASE:-app} |
|
||||||
# You should definitely change the password in production |
|
||||||
+ MYSQL_RANDOM_ROOT_PASSWORD: "true" |
|
||||||
- POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-!ChangeMe!} |
|
||||||
+ MYSQL_PASSWORD: ${MYSQL_PASSWORD:-!ChangeMe!} |
|
||||||
- POSTGRES_USER: ${POSTGRES_USER:-app} |
|
||||||
+ MYSQL_USER: ${MYSQL_USER:-app} |
|
||||||
healthcheck: |
|
||||||
- test: ["CMD", "pg_isready", "-d", "${POSTGRES_DB:-app}", "-U", "${POSTGRES_USER:-app}"] |
|
||||||
+ test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"] |
|
||||||
timeout: 5s |
|
||||||
retries: 5 |
|
||||||
start_period: 60s |
|
||||||
volumes: |
|
||||||
- - database_data:/var/lib/postgresql/data:rw |
|
||||||
+ - database_data:/var/lib/mysql:rw |
|
||||||
# You may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data! |
|
||||||
- # - ./docker/db/data:/var/lib/postgresql/data:rw |
|
||||||
+ # - ./docker/db/data:/var/lib/mysql:rw |
|
||||||
###< doctrine/doctrine-bundle ### |
|
||||||
``` |
|
||||||
|
|
||||||
Depending on the database configuration, modify the environment in the same file at `services.php.environment.DATABASE_URL` |
|
||||||
``` |
|
||||||
DATABASE_URL: mysql://${MYSQL_USER:-app}:${MYSQL_PASSWORD:-!ChangeMe!}@database:3306/${MYSQL_DATABASE:-app}?serverVersion=${MYSQL_VERSION:-8}&charset=${MYSQL_CHARSET:-utf8mb4} |
|
||||||
``` |
|
||||||
|
|
||||||
Since we changed the port, we also have to define this in the `compose.override.yaml`: |
|
||||||
```diff |
|
||||||
###> doctrine/doctrine-bundle ### |
|
||||||
database: |
|
||||||
ports: |
|
||||||
- - "5432" |
|
||||||
+ - "3306" |
|
||||||
###< doctrine/doctrine-bundle ### |
|
||||||
``` |
|
||||||
|
|
||||||
Last but not least, we need to install the MySQL driver in `Dockerfile`: |
|
||||||
```diff |
|
||||||
###> doctrine/doctrine-bundle ### |
|
||||||
-RUN install-php-extensions pdo_pgsql |
|
||||||
+RUN install-php-extensions pdo_mysql |
|
||||||
###< doctrine/doctrine-bundle ### |
|
||||||
``` |
|
||||||
|
|
||||||
## Change Environment |
|
||||||
Change the database configuration in `.env`: |
|
||||||
|
|
||||||
```dotenv |
|
||||||
DATABASE_URL=mysql://${MYSQL_USER:-app}:${MYSQL_PASSWORD:-!ChangeMe!}@database:3306/${MYSQL_DATABASE:-app}?serverVersion=${MYSQL_VERSION:-8}&charset=${MYSQL_CHARSET:-utf8mb4} |
|
||||||
``` |
|
||||||
|
|
||||||
## Final steps |
|
||||||
Rebuild the docker environment: |
|
||||||
```shell |
|
||||||
docker compose down --remove-orphans && docker compose build --pull --no-cache |
|
||||||
``` |
|
||||||
|
|
||||||
Start the services: |
|
||||||
```shell |
|
||||||
docker compose up -d |
|
||||||
``` |
|
||||||
|
|
||||||
Test your setup: |
|
||||||
```shell |
|
||||||
docker compose exec php bin/console dbal:run-sql -q "SELECT 1" && echo "OK" || echo "Connection is not working" |
|
||||||
``` |
|
||||||
@ -1,72 +0,0 @@ |
|||||||
# Docker Build Options |
|
||||||
|
|
||||||
You can customize the docker build process using these environment variables. |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> All Symfony-specific environment variables are used only if no `composer.json` file is found in the project directory. |
|
||||||
|
|
||||||
## Selecting a Specific Symfony Version |
|
||||||
|
|
||||||
Use the `SYMFONY_VERSION` environment variable to select a specific Symfony version. |
|
||||||
|
|
||||||
For instance, use the following command to install Symfony 6.4: |
|
||||||
|
|
||||||
On Linux: |
|
||||||
|
|
||||||
SYMFONY_VERSION=6.4.* docker compose up -d --wait |
|
||||||
On Windows: |
|
||||||
|
|
||||||
set SYMFONY_VERSION=6.4.* && docker compose up -d --wait&set SYMFONY_VERSION= |
|
||||||
|
|
||||||
## Installing Development Versions of Symfony |
|
||||||
|
|
||||||
To install a non-stable version of Symfony, use the `STABILITY` environment variable during the build. |
|
||||||
The value must be [a valid Composer stability option](https://getcomposer.org/doc/04-schema.md#minimum-stability). |
|
||||||
|
|
||||||
For instance, use the following command to use the development branch of Symfony: |
|
||||||
|
|
||||||
On Linux: |
|
||||||
|
|
||||||
STABILITY=dev docker compose up -d --wait |
|
||||||
|
|
||||||
On Windows: |
|
||||||
|
|
||||||
set STABILITY=dev && docker compose up -d --wait&set STABILITY= |
|
||||||
|
|
||||||
## Using custom HTTP ports |
|
||||||
|
|
||||||
Use the environment variables `HTTP_PORT`, `HTTPS_PORT` and/or `HTTP3_PORT` to adjust the ports to your needs, e.g. |
|
||||||
|
|
||||||
HTTP_PORT=8000 HTTPS_PORT=4443 HTTP3_PORT=4443 docker compose up -d --wait |
|
||||||
|
|
||||||
to access your application on [https://localhost:4443](https://localhost:4443). |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> Let's Encrypt only supports the standard HTTP and HTTPS ports. Creating a Let's Encrypt certificate for another port will not work, you have to use the standard ports or to configure Caddy to use another provider. |
|
||||||
|
|
||||||
|
|
||||||
## Caddyfile Options |
|
||||||
|
|
||||||
You can also customize the `Caddyfile` by using the following environment variables to inject options block, directive or configuration. |
|
||||||
|
|
||||||
> [!TIP] |
|
||||||
> All the following environment variables can be defined in your `.env` file at the root of the project to keep them persistent at each startup |
|
||||||
|
|
||||||
| Environment variable | Description | Default value | |
|
||||||
|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| |
|
||||||
| `CADDY_GLOBAL_OPTIONS` | the [global options block](https://caddyserver.com/docs/caddyfile/options#global-options), one per line | | |
|
||||||
| `CADDY_EXTRA_CONFIG` | the [snippet](https://caddyserver.com/docs/caddyfile/concepts#snippets) or the [named-routes](https://caddyserver.com/docs/caddyfile/concepts#named-routes) options block, one per line | | |
|
||||||
| `CADDY_SERVER_EXTRA_DIRECTIVES` | the [`Caddyfile` directives](https://caddyserver.com/docs/caddyfile/concepts#directives) | | |
|
||||||
| `CADDY_SERVER_LOG_OPTIONS` | the [server log options block](https://caddyserver.com/docs/caddyfile/directives/log), one per line | | |
|
||||||
| `SERVER_NAME` | the server name or address | `localhost` | |
|
||||||
| `FRANKENPHP_CONFIG` | a list of extra [FrankenPHP directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | `import worker.Caddyfile` | |
|
||||||
| `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt://mercure.db` | |
|
||||||
| `MERCURE_PUBLISHER_JWT_KEY` | the JWT key to use for publishers | | |
|
||||||
| `MERCURE_PUBLISHER_JWT_ALG` | the JWT algorithm to use for publishers | `HS256` | |
|
||||||
| `MERCURE_SUBSCRIBER_JWT_KEY` | the JWT key to use for subscribers | | |
|
||||||
| `MERCURE_SUBSCRIBER_JWT_ALG` | the JWT algorithm to use for subscribers | `HS256` | |
|
||||||
| `MERCURE_EXTRA_DIRECTIVES` | a list of extra [Mercure directives](https://mercure.rocks/docs/hub/config), one per line | | |
|
||||||
|
|
||||||
### Example of server name customize: |
|
||||||
|
|
||||||
SERVER_NAME="app.localhost" docker compose up -d --wait |
|
||||||
@ -1,110 +0,0 @@ |
|||||||
# Deploying in Production |
|
||||||
|
|
||||||
Symfony Docker provides Docker images, and a Docker Compose definition optimized for production usage. |
|
||||||
In this tutorial, we will learn how to deploy our Symfony application on a single server using Docker Compose. |
|
||||||
|
|
||||||
## Preparing a Server |
|
||||||
|
|
||||||
To deploy your application in production, you need a server. |
|
||||||
In this tutorial, we will use a virtual machine provided by DigitalOcean, but any Linux server can work. |
|
||||||
If you already have a Linux server with Docker Compose installed, you can skip straight to [the next section](#configuring-a-domain-name). |
|
||||||
|
|
||||||
Otherwise, use [this affiliate link](https://m.do.co/c/5d8aabe3ab80) to get $100 of free credit, create an account, then click on "Create a Droplet". |
|
||||||
Then, click on the "Marketplace" tab under the "Choose an image" section and search for the app named "Docker". |
|
||||||
This will provision an Ubuntu server with the latest versions of Docker and Docker Compose already installed! |
|
||||||
|
|
||||||
For test purposes, the cheapest plans will be enough, even though you might want at least 2GB of RAM to execute Docker Compose for the first time. For real production usage, you'll probably want to pick a plan in the "general purpose" section to fit your needs. |
|
||||||
|
|
||||||
 |
|
||||||
|
|
||||||
You can keep the defaults for other settings, or tweak them according to your needs. |
|
||||||
Don't forget to add your SSH key or create a password then press the "Finalize and create" button. |
|
||||||
|
|
||||||
Then, wait a few seconds while your Droplet is provisioning. |
|
||||||
When your Droplet is ready, use SSH to connect: |
|
||||||
|
|
||||||
```console |
|
||||||
ssh root@<droplet-ip> |
|
||||||
``` |
|
||||||
|
|
||||||
## Configuring a Domain Name |
|
||||||
|
|
||||||
In most cases, you'll want to associate a domain name with your site. |
|
||||||
If you don't own a domain name yet, you'll have to buy one through a registrar. |
|
||||||
|
|
||||||
Then create a DNS record of type `A` for your domain name pointing to the IP address of your server: |
|
||||||
|
|
||||||
```dns |
|
||||||
your-domain-name.example.com. IN A 207.154.233.113 |
|
||||||
``` |
|
||||||
|
|
||||||
Example with the DigitalOcean Domains service ("Networking" > "Domains"): |
|
||||||
|
|
||||||
 |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> Let's Encrypt, the service used by default by Symfony Docker to automatically generate a TLS certificate doesn't support using bare IP addresses. Using a domain name is mandatory to use Let's Encrypt. |
|
||||||
|
|
||||||
## Deploying |
|
||||||
|
|
||||||
Copy your project on the server using `git clone`, `scp`, or any other tool that may fit your need. |
|
||||||
If you use GitHub, you may want to use [a deploy key](https://docs.github.com/en/free-pro-team@latest/developers/overview/managing-deploy-keys#deploy-keys). |
|
||||||
Deploy keys are also [supported by GitLab](https://docs.gitlab.com/ee/user/project/deploy_keys/). |
|
||||||
|
|
||||||
Example with Git: |
|
||||||
|
|
||||||
```console |
|
||||||
git clone git@github.com:<username>/<project-name>.git |
|
||||||
``` |
|
||||||
|
|
||||||
Go into the directory containing your project (`<project-name>`), and start the app in production mode: |
|
||||||
|
|
||||||
```console |
|
||||||
SERVER_NAME=your-domain-name.example.com \ |
|
||||||
APP_SECRET=ChangeMe \ |
|
||||||
CADDY_MERCURE_JWT_SECRET=ChangeThisMercureHubJWTSecretKey \ |
|
||||||
docker compose -f compose.yaml -f compose.prod.yaml up -d --wait |
|
||||||
``` |
|
||||||
|
|
||||||
Be sure to replace `your-domain-name.example.com` with your actual domain name and to set the values of `APP_SECRET`, `CADDY_MERCURE_JWT_SECRET` to cryptographically secure random values. |
|
||||||
|
|
||||||
Your server is up and running, and a HTTPS certificate has been automatically generated for you. |
|
||||||
Go to `https://your-domain-name.example.com` and enjoy! |
|
||||||
|
|
||||||
> [!NOTE] |
|
||||||
> The worker mode of FrankenPHP is enabled by default in prod. To disable it, add the env var FRANKENPHP_CONFIG as empty to the compose.prod.yaml file. |
|
||||||
|
|
||||||
> [!CAUTION] |
|
||||||
> Docker can have a cache layer, make sure you have the right build for each deployment or rebuild your project with --no-cache option to avoid cache issue. |
|
||||||
|
|
||||||
## Disabling HTTPS |
|
||||||
|
|
||||||
Alternatively, if you don't want to expose an HTTPS server but only an HTTP one, run the following command: |
|
||||||
|
|
||||||
```console |
|
||||||
SERVER_NAME=:80 \ |
|
||||||
APP_SECRET=ChangeMe \ |
|
||||||
CADDY_MERCURE_JWT_SECRET=ChangeThisMercureHubJWTSecretKey \ |
|
||||||
docker compose -f compose.yaml -f compose.prod.yaml up -d --wait |
|
||||||
``` |
|
||||||
|
|
||||||
## Deploying on Multiple Nodes |
|
||||||
|
|
||||||
If you want to deploy your app on a cluster of machines, you can use [Docker Swarm](https://docs.docker.com/engine/swarm/stack-deploy/), |
|
||||||
which is compatible with the provided Compose files. |
|
||||||
To deploy on Kubernetes, take a look at [the Helm chart provided with API Platform](https://api-platform.com/docs/deployment/kubernetes/), which can be easily adapted for use with Symfony Docker. |
|
||||||
|
|
||||||
## Passing local environment variables to containers |
|
||||||
|
|
||||||
By default, `.env.local` and `.env.*.local` files are excluded from production images. |
|
||||||
If you want to pass them to your containers, you can use the [`env_file` attribute](https://docs.docker.com/compose/environment-variables/set-environment-variables/#use-the-env_file-attribute): |
|
||||||
|
|
||||||
```yaml |
|
||||||
# compose.prod.yml |
|
||||||
|
|
||||||
services: |
|
||||||
php: |
|
||||||
env_file: |
|
||||||
- .env.prod.local |
|
||||||
# ... |
|
||||||
``` |
|
||||||
@ -1,51 +0,0 @@ |
|||||||
# TLS Certificates |
|
||||||
|
|
||||||
## Trusting the Authority |
|
||||||
|
|
||||||
With a standard installation, the authority used to sign certificates generated in the Caddy container is not trusted by your local machine. |
|
||||||
You must add the authority to the trust store of the host : |
|
||||||
|
|
||||||
``` |
|
||||||
# Mac |
|
||||||
$ docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /tmp/root.crt && sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain /tmp/root.crt |
|
||||||
# Linux |
|
||||||
$ docker cp $(docker compose ps -q php):/data/caddy/pki/authorities/local/root.crt /usr/local/share/ca-certificates/root.crt && sudo update-ca-certificates |
|
||||||
# Windows |
|
||||||
$ docker compose cp php:/data/caddy/pki/authorities/local/root.crt %TEMP%/root.crt && certutil -addstore -f "ROOT" %TEMP%/root.crt |
|
||||||
``` |
|
||||||
|
|
||||||
## Using Custom TLS Certificates |
|
||||||
|
|
||||||
By default, Caddy will automatically generate TLS certificates using Let's Encrypt or ZeroSSL. |
|
||||||
But sometimes you may prefer using custom certificates. |
|
||||||
|
|
||||||
For instance, to use self-signed certificates created with [mkcert](https://github.com/FiloSottile/mkcert) do as follows: |
|
||||||
|
|
||||||
1. Locally install `mkcert` |
|
||||||
2. Create the folder storing the certs: |
|
||||||
`mkdir frankenphp/certs -p` |
|
||||||
3. Generate the certificates for your local host (example: "server-name.localhost"): |
|
||||||
`mkcert -cert-file frankenphp/certs/tls.pem -key-file frankenphp/certs/tls.key "server-name.localhost"` |
|
||||||
4. Add these lines to the `./compose.override.yaml` file about `CADDY_SERVER_EXTRA_DIRECTIVES` environment and volume for the `php` service : |
|
||||||
```diff |
|
||||||
php: |
|
||||||
environment: |
|
||||||
+ CADDY_SERVER_EXTRA_DIRECTIVES: "tls /etc/caddy/certs/tls.pem /etc/caddy/certs/tls.key" |
|
||||||
# ... |
|
||||||
volumes: |
|
||||||
+ - ./frankenphp/certs:/etc/caddy/certs:ro |
|
||||||
- ./public:/app/public:ro |
|
||||||
``` |
|
||||||
5. Restart your `php` service |
|
||||||
|
|
||||||
## Disabling HTTPS for Local Development |
|
||||||
|
|
||||||
To disable HTTPS, configure your environment to use HTTP by setting the following variables and starting the project with this command: |
|
||||||
|
|
||||||
```bash |
|
||||||
SERVER_NAME=http://localhost \ |
|
||||||
MERCURE_PUBLIC_URL=http://localhost/.well-known/mercure \ |
|
||||||
docker compose up --pull always -d --wait |
|
||||||
``` |
|
||||||
|
|
||||||
Ensure your application is accessible over HTTP by visiting `http://localhost` in your web browser. |
|
||||||
@ -1,9 +0,0 @@ |
|||||||
# Troubleshooting |
|
||||||
|
|
||||||
## Editing Permissions on Linux |
|
||||||
|
|
||||||
If you work on linux and cannot edit some of the project files right after the first installation, you can run `docker compose run --rm php chown -R $(id -u):$(id -g) .` to set yourself as owner of the project files that were created by the docker container. |
|
||||||
|
|
||||||
## TLS/HTTPS Issues |
|
||||||
|
|
||||||
See more in the [TLS section](tls.md) |
|
||||||
@ -1,15 +0,0 @@ |
|||||||
# Updating Your Project |
|
||||||
|
|
||||||
To import the changes made to the *Symfony Docker* template into your project, we recommend using |
|
||||||
[*template-sync*](https://github.com/coopTilleuls/template-sync): |
|
||||||
|
|
||||||
1. Run the script to synchronize your project with the latest version of the skeleton: |
|
||||||
|
|
||||||
```console |
|
||||||
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/dunglas/symfony-docker |
|
||||||
``` |
|
||||||
|
|
||||||
2. Resolve conflicts, if any |
|
||||||
3. Run `git cherry-pick --continue` |
|
||||||
|
|
||||||
For more advanced options, refer to [the documentation of *template sync*](https://github.com/coopTilleuls/template-sync#template-sync). |
|
||||||
@ -1,58 +0,0 @@ |
|||||||
# Using Xdebug |
|
||||||
|
|
||||||
The default development image is shipped with [Xdebug](https://xdebug.org/), |
|
||||||
a popular debugger and profiler for PHP. |
|
||||||
|
|
||||||
Because it has a significant performance overhead, the step-by-step debugger is disabled by default. |
|
||||||
It can be enabled by setting the `XDEBUG_MODE` environment variable to `debug`. |
|
||||||
|
|
||||||
On Linux and Mac: |
|
||||||
|
|
||||||
``` |
|
||||||
XDEBUG_MODE=debug docker compose up -d |
|
||||||
``` |
|
||||||
|
|
||||||
On Windows: |
|
||||||
|
|
||||||
``` |
|
||||||
set XDEBUG_MODE=debug&& docker compose up -d&set XDEBUG_MODE= |
|
||||||
``` |
|
||||||
|
|
||||||
## Debugging with Xdebug and PHPStorm |
|
||||||
|
|
||||||
First, [create a PHP debug remote server configuration](https://www.jetbrains.com/help/phpstorm/creating-a-php-debug-server-configuration.html): |
|
||||||
|
|
||||||
1. In the `Settings/Preferences` dialog, go to `PHP | Servers` |
|
||||||
2. Create a new server: |
|
||||||
* Name: `symfony` (or whatever you want to use for the variable `PHP_IDE_CONFIG`) |
|
||||||
* Host: `localhost` (or the one defined using the `SERVER_NAME` environment variable) |
|
||||||
* Port: `443` |
|
||||||
* Debugger: `Xdebug` |
|
||||||
* Check `Use path mappings` |
|
||||||
* Absolute path on the server: `/app` |
|
||||||
|
|
||||||
You can now use the debugger! |
|
||||||
|
|
||||||
1. In PHPStorm, open the `Run` menu and click on `Start Listening for PHP Debug Connections` |
|
||||||
2. Add the `XDEBUG_SESSION=PHPSTORM` query parameter to the URL of the page you want to debug, or use [other available triggers](https://xdebug.org/docs/step_debug#activate_debugger) |
|
||||||
|
|
||||||
Alternatively, you can use [the **Xdebug extension**](https://xdebug.org/docs/step_debug#browser-extensions) for your preferred web browser. |
|
||||||
|
|
||||||
3. On command line, we might need to tell PHPStorm which [path mapping configuration](https://www.jetbrains.com/help/phpstorm/zero-configuration-debugging-cli.html#configure-path-mappings) should be used, set the value of the PHP_IDE_CONFIG environment variable to `serverName=symfony`, where `symfony` is the name of the debug server configured higher. |
|
||||||
|
|
||||||
Example: |
|
||||||
|
|
||||||
```console |
|
||||||
XDEBUG_SESSION=1 PHP_IDE_CONFIG="serverName=symfony" php bin/console ... |
|
||||||
``` |
|
||||||
|
|
||||||
## Troubleshooting |
|
||||||
|
|
||||||
Inspect the installation with the following command. The Xdebug version should be displayed. |
|
||||||
|
|
||||||
```console |
|
||||||
$ docker compose exec php php --version |
|
||||||
|
|
||||||
PHP ... |
|
||||||
with Xdebug v3.x.x ... |
|
||||||
``` |
|
||||||
@ -1,64 +0,0 @@ |
|||||||
<?php |
|
||||||
|
|
||||||
declare(strict_types=1); |
|
||||||
|
|
||||||
namespace App\Command; |
|
||||||
|
|
||||||
use App\Entity\Article; |
|
||||||
use App\Enum\IndexStatusEnum; |
|
||||||
use Doctrine\ORM\EntityManagerInterface; |
|
||||||
use FOS\ElasticaBundle\Persister\ObjectPersisterInterface; |
|
||||||
use Symfony\Component\Console\Attribute\AsCommand; |
|
||||||
use Symfony\Component\Console\Command\Command; |
|
||||||
use Symfony\Component\Console\Input\InputInterface; |
|
||||||
use Symfony\Component\Console\Output\OutputInterface; |
|
||||||
|
|
||||||
#[AsCommand(name: 'articles:index', description: 'Persist selected articles to Elastic')] |
|
||||||
class IndexArticlesCommand extends Command |
|
||||||
{ |
|
||||||
private const BATCH_SIZE = 100; // Define batch size |
|
||||||
|
|
||||||
public function __construct(private readonly EntityManagerInterface $entityManager, private readonly ObjectPersisterInterface $itemPersister) |
|
||||||
{ |
|
||||||
parent::__construct(); |
|
||||||
} |
|
||||||
|
|
||||||
protected function execute(InputInterface $input, OutputInterface $output): int |
|
||||||
{ |
|
||||||
|
|
||||||
$articles = $this->entityManager->getRepository(Article::class)->findBy(['indexStatus' => IndexStatusEnum::TO_BE_INDEXED]); |
|
||||||
|
|
||||||
$batchCount = 0; |
|
||||||
$processedCount = 0; |
|
||||||
|
|
||||||
foreach ($articles as $item) { |
|
||||||
$batchCount++; |
|
||||||
|
|
||||||
// Collect batch of entities for indexing |
|
||||||
$batchItems[] = $item; |
|
||||||
|
|
||||||
// Process batch when limit is reached |
|
||||||
if ($batchCount >= self::BATCH_SIZE) { |
|
||||||
$this->flushAndPersistBatch($batchItems); |
|
||||||
$processedCount += $batchCount; |
|
||||||
$batchCount = 0; |
|
||||||
$batchItems = []; |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
// Process any remaining items |
|
||||||
if (!empty($batchItems)) { |
|
||||||
$this->flushAndPersistBatch($batchItems); |
|
||||||
$processedCount += count($batchItems); |
|
||||||
} |
|
||||||
|
|
||||||
$output->writeln("$processedCount items indexed in Elasticsearch."); |
|
||||||
return Command::SUCCESS; |
|
||||||
} |
|
||||||
|
|
||||||
private function flushAndPersistBatch(array $items): void |
|
||||||
{ |
|
||||||
// Persist batch to Elasticsearch |
|
||||||
$this->itemPersister->replaceMany($items); |
|
||||||
} |
|
||||||
} |
|
||||||
@ -1,30 +0,0 @@ |
|||||||
<?php |
|
||||||
|
|
||||||
namespace App\EventListener; |
|
||||||
|
|
||||||
use App\Entity\Article; |
|
||||||
use App\Enum\IndexStatusEnum; |
|
||||||
use Doctrine\ORM\EntityManagerInterface; |
|
||||||
use FOS\ElasticaBundle\Event\PostIndexPopulateEvent; |
|
||||||
|
|
||||||
class PopulateListener |
|
||||||
{ |
|
||||||
public function __construct( private readonly EntityManagerInterface $entityManager) |
|
||||||
{ |
|
||||||
} |
|
||||||
|
|
||||||
public function postIndexPopulate(PostIndexPopulateEvent $event): void |
|
||||||
{ |
|
||||||
$articles = $this->entityManager->getRepository(Article::class)->findBy(['indexStatus' => IndexStatusEnum::TO_BE_INDEXED]); |
|
||||||
|
|
||||||
foreach ($articles as $article) { |
|
||||||
if ($article instanceof Article) { |
|
||||||
$article->setIndexStatus(IndexStatusEnum::INDEXED); |
|
||||||
$this->entityManager->persist($article); |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
$this->entityManager->flush(); |
|
||||||
|
|
||||||
} |
|
||||||
} |
|
||||||
@ -1,27 +0,0 @@ |
|||||||
<?php |
|
||||||
|
|
||||||
namespace App\Provider; |
|
||||||
|
|
||||||
use App\Entity\Article; |
|
||||||
use App\Enum\IndexStatusEnum; |
|
||||||
use Doctrine\ORM\EntityManagerInterface; |
|
||||||
use FOS\ElasticaBundle\Provider\PagerfantaPager; |
|
||||||
use FOS\ElasticaBundle\Provider\PagerInterface; |
|
||||||
use FOS\ElasticaBundle\Provider\PagerProviderInterface; |
|
||||||
use Pagerfanta\Adapter\ArrayAdapter; |
|
||||||
use Pagerfanta\Pagerfanta; |
|
||||||
|
|
||||||
|
|
||||||
class ArticleProvider implements PagerProviderInterface |
|
||||||
{ |
|
||||||
|
|
||||||
public function __construct(private readonly EntityManagerInterface $entityManager) |
|
||||||
{ |
|
||||||
} |
|
||||||
|
|
||||||
public function provide(array $options = []): PagerInterface |
|
||||||
{ |
|
||||||
$articles = $this->entityManager->getRepository(Article::class)->findBy(['indexStatus' => IndexStatusEnum::TO_BE_INDEXED],['createdAt' => 'ASC'],200); |
|
||||||
return new PagerfantaPager(new Pagerfanta(new ArrayAdapter($articles))); |
|
||||||
} |
|
||||||
} |
|
||||||
@ -1,14 +0,0 @@ |
|||||||
<?php |
|
||||||
|
|
||||||
namespace App\Util; |
|
||||||
|
|
||||||
use App\Entity\Article; |
|
||||||
use App\Enum\IndexStatusEnum; |
|
||||||
|
|
||||||
class IndexableArticleChecker |
|
||||||
{ |
|
||||||
public static function isIndexable(Article $article): bool |
|
||||||
{ |
|
||||||
return $article->getIndexStatus() !== IndexStatusEnum::DO_NOT_INDEX; |
|
||||||
} |
|
||||||
} |
|
||||||
Loading…
Reference in new issue