Skip to content

Commit

Permalink
Updating env variables
Browse files Browse the repository at this point in the history
  • Loading branch information
varrcan committed May 6, 2024
1 parent 3590c1f commit 499f4e7
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 48 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# docs

Node v16.9.1
Yarn 1.22.17
Node v18.18.2
Yarn 1.22.19
53 changes: 30 additions & 23 deletions docs/getting-started/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ The DL uses docker-compose configuration files, so you can override any variable
Used images:

- [Redis](https://hub.docker.com/_/redis) (alpine version)
- [MySQL](https://hub.docker.com/r/alterway/mysql) (alterway/mysql)
- [MySQL](https://hub.docker.com/_/mysql)
- [MariaDB](https://hub.docker.com/_/mariadb)
- [PostgreSQL](https://hub.docker.com/_/postgres)
- [Memcached](https://hub.docker.com/_/memcached)
- [Nginx](https://hub.docker.com/_/nginx) (alpine version)
- [php-fpm and apache2](https://github.com/orgs/local-deploy/repositories) (modified original images)
Expand All @@ -21,11 +23,11 @@ With the help of variables in the `.env` file, you can flexibly control the envi

### Main

| Variable | Required | Default value | Note |
|-------------------------|----------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| NETWORK_NAME | Yes | Generated from HOST_NAME | The name of the docker network. Generated from HOST_NAME without special characters |
| DOCUMENT_ROOT | Yes | /var/www/html | The root directory of the site where the `index.php` file is located. [^1] |
| HOST_NAME | No | Generated from name of the current directory | Site name or domain. Used to build a local URL [^2] |
| Variable | Required | Default value | Note |
|---------------|----------|----------------------------------------------|-------------------------------------------------------------------------------------|
| NETWORK_NAME | No | Generated from HOST_NAME | The name of the docker network. Generated from HOST_NAME without special characters |
| DOCUMENT_ROOT | No | /var/www/html | The root directory of the site where the `index.php` file is located. [^1] |
| HOST_NAME | No | Generated from name of the current directory | Site name or domain. Used to build a local URL [^2] |

### Deploy files and database

Expand All @@ -45,13 +47,13 @@ With the help of variables in the `.env` file, you can flexibly control the envi

If the script could not automatically determine access to the database on the server, write the settings to the env file manually

| Variable | Required | Default value | Note |
|--------------------|-----------|------------------|----------------|
| MYSQL_HOST_SRV | Нет | localhost | Host |
| MYSQL_PORT_SRV | Нет | 3306 | Port |
| MYSQL_DATABASE_SRV | Да | | Base name |
| MYSQL_LOGIN_SRV | Да | | User name |
| MYSQL_PASSWORD_SRV | Да | | User password |
| Variable | Required | Default value | Note |
|--------------------|----------|---------------|---------------|
| MYSQL_HOST_SRV | No | localhost | Host |
| MYSQL_PORT_SRV | No | 3306 | Port |
| MYSQL_DATABASE_SRV | Yes | | Base name |
| MYSQL_LOGIN_SRV | Yes | | User name |
| MYSQL_PASSWORD_SRV | Yes | | User password |

### PHP settings

Expand All @@ -67,16 +69,21 @@ If the script could not automatically determine access to the database on the se
| XDEBUG | No | off [^4] | To enable the XDebug module, use the `debug` option |
| XDEBUG_IDE_KEY | No | PHPSTORM | Key to be passed when initializing an XDebug session |
| XDEBUG_PORT | No | 9003 | XDebug port |
| PHP_INI_SOURCE | No | /dev/null | Relative link to php.ini file to completely override configuration <br/>(for example: `PHP_INI_SOURCE: .docker/php/php.ini`) |

### MySQL settings
### DB settings

| Variable | Required | Default value | Note |
|-------------------------|----------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| MYSQL_VERSION | No | | MySQL version. <br/>Available values: `5.7`, `8.0` |
| MYSQL_DATABASE | No | db | MySQL database name |
| MYSQL_USER | No | db | MySQL database username |
| MYSQL_PASSWORD | No | db | MySQL database user password |
| MYSQL_ROOT_PASSWORD | No | root | MySQL database root password |
If a value is specified, the database container will be raised.

Database name: `db`
Username: `db`
User password: `db`

| Variable | Required | Default value | Note |
|------------------|----------|---------------|------------------------------------------------------------------------------------------------|
| MYSQL_VERSION | No | | MySQL version. <br/>Available values: `5.7`, `8.0` |
| MARIADB_VERSION | No | | MariaDB version. <br/>Available values: [Supported tags](https://hub.docker.com/_/mariadb) |
| POSTGRES_VERSION | No | | PostgreSQL version. <br/>Available values: [Supported tags](https://hub.docker.com/_/postgres) |

### Additional containers

Expand Down Expand Up @@ -108,9 +115,9 @@ SERVER=127.0.0.1
HOST_NAME=site.com
DOCUMENT_ROOT=/var/www/html
## Avalible versions: 7.3-apache 7.4-apache 8.0-apache 8.1-apache 8.2-apache 7.3-fpm 7.4-fpm 8.0-fpm 8.1-fpm 8.2-fpm ##
PHP_VERSION=7.3-apache
PHP_VERSION=8.2-apache
## Avalible versions: 5.7 8.0 ##
MYSQL_VERSION=5.7
MYSQL_VERSION=8.0
## Deploy settings ##
EXCLUDED_TABLES=b_event_log,b_search_content_stem,b_search_content,b_search_content_text,b_search_content_title,b_search_phrase,b_search_suggest,b_perf_error
Expand Down
7 changes: 4 additions & 3 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ DL is a wrapper on top of Docker and docker-compose, no additional software or l
Supported OS:
- Linux (debian, ubuntu, linux mint, arch linux, manjaro, etc)
- macOS (beta)
[//]: # (- Windows &#40;via WSL2&#41;)
- Windows (via WSL2)

Supported architectures:
- x64
Expand All @@ -21,6 +21,7 @@ Supported frameworks and CMS:
- Bitrix
- Laravel
- WordPress
- And many others with manual settings

Supported SHELL:
- bash
Expand All @@ -33,8 +34,8 @@ Dependencies:
The docker compose (as plugin) supported

## Features
- Support for PHP versions (apache and php-fpm) 7.3, 7.4, 8.0, 8.1, 8.2
- Support for MySQL versions 5.7, 8.0
- Support for PHP versions (apache and php-fpm) 7.3, 7.4, 8.0, 8.1, 8.2, 8.3
- Support for MySQL, MariaDB and PostgreSQL
- Downloading the database and files from the production server
- Redis
- Memcached
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ DL использует конфигурационные файлы docker-compo
Используемые образы:

- [Redis](https://hub.docker.com/_/redis) (версия alpine)
- [MySQL](https://hub.docker.com/r/alterway/mysql) (alterway/mysql)
- [MySQL](https://hub.docker.com/_/mysql)
- [MariaDB](https://hub.docker.com/_/mariadb)
- [PostgreSQL](https://hub.docker.com/_/postgres)
- [Memcached](https://hub.docker.com/_/memcached)
- [Nginx](https://hub.docker.com/_/nginx) (версия alpine)
- [php-fpm и apache2](https://github.com/orgs/local-deploy/repositories) (модифицированные оригинальные образы)
Expand All @@ -21,11 +23,11 @@ DL использует конфигурационные файлы docker-compo

### Основные

| Переменная | Обязательная | Значение по умолчанию | Примечание |
|-------------------------|--------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| NETWORK_NAME | Да | Генерируется из HOST_NAME | Имя docker сети. Генерируется из HOST_NAME без спец символов |
| DOCUMENT_ROOT | Да | /var/www/html | Корневая директория сайта, в которой находится файл `index.php`. [^1] |
| HOST_NAME | Нет | Генерируется по имени текущей директории | Имя сайта или домен. Используется для построения локального URL. [^2] |
| Переменная | Обязательная | Значение по умолчанию | Примечание |
|---------------|--------------|------------------------------------------|-----------------------------------------------------------------------|
| NETWORK_NAME | Нет | Генерируется из HOST_NAME | Имя docker сети. Генерируется из HOST_NAME без спец символов |
| DOCUMENT_ROOT | Нет | /var/www/html | Корневая директория сайта, в которой находится файл `index.php`. [^1] |
| HOST_NAME | Нет | Генерируется по имени текущей директории | Имя сайта или домен. Используется для построения локального URL. [^2] |

### Деплой файлов и базы данных

Expand Down Expand Up @@ -57,7 +59,7 @@ DL использует конфигурационные файлы docker-compo

| Переменная | Обязательная | Значение по умолчанию | Примечание |
|-------------------------|--------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| PHP_VERSION | Да | | Версия PHP <br/>Доступные значения: `7.3-apache`, `7.4-apache`, `8.0-apache`, `8.1-apache`, `8.2-apache`, `7.3-fpm`, `7.4-fpm`, `8.0-fpm`, `8.1-fpm`, `8.2-fpm` |
| PHP_VERSION | Нет | | Версия PHP <br/>Доступные значения: `7.3-apache`, `7.4-apache`, `8.0-apache`, `8.1-apache`, `8.2-apache`, `7.3-fpm`, `7.4-fpm`, `8.0-fpm`, `8.1-fpm`, `8.2-fpm` |
| PHP_MEMORY_LIMIT | Нет | 256M | Лимит памяти PHP |
| PHP_POST_MAX_SIZE | Нет | 100M | Максимальный размер POST-запроса |
| PHP_UPLOAD_MAX_FILESIZE | Нет | 100M | Максимальный размер файла, разрешенный для загрузки |
Expand All @@ -67,16 +69,21 @@ DL использует конфигурационные файлы docker-compo
| XDEBUG | Нет | off [^4] | Для включения модуля XDebug, используйте параметр `debug` |
| XDEBUG_IDE_KEY | Нет | PHPSTORM | Ключ, который должен быть передан при инициализации сессии XDebug |
| XDEBUG_PORT | Нет | 9003 | Порт XDebug |
| PHP_INI_SOURCE | Нет | /dev/null | Относительная ссылка на файл php.ini для полного переопределения конфигурации <br/>(например: `PHP_INI_SOURCE: .docker/php/php.ini`) |

### Настройки MySQL
### Настройки базы данных

| Переменная | Обязательная | Значение по умолчанию | Примечание |
|-------------------------|--------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
| MYSQL_VERSION | Нет | | Версия MySQL. <br/>Доступные значения: `5.7`, `8.0` |
| MYSQL_DATABASE | Нет | db | Имя базы данных MySQL |
| MYSQL_USER | Нет | db | Имя пользователя базы данных MySQL |
| MYSQL_PASSWORD | Нет | db | Пароль пользователя базы данных MySQL |
| MYSQL_ROOT_PASSWORD | Нет | root | Пароль root-пользователя базы данных MySQL |
Если указано значение, будет поднят контейнер с базой данных.

Имя базы данных: `db`
Имя пользователя: `db`
Пароль пользователя: `db`

| Переменная | Обязательная | Значение по умолчанию | Примечание |
|------------------|--------------|-----------------------|-------------------------------------------------------------------------------------------------|
| MYSQL_VERSION | Нет | | Версия MySQL. <br/>Доступные значения: `5.7`, `8.0` |
| MARIADB_VERSION | Нет | | Версия MariaDB. <br/>Доступные значения: [Supported tags](https://hub.docker.com/_/mariadb) |
| POSTGRES_VERSION | Нет | | Версия PostgreSQL. <br/>Доступные значения: [Supported tags](https://hub.docker.com/_/postgres) |

### Дополнительные контейнеры

Expand Down Expand Up @@ -109,9 +116,9 @@ SERVER=127.0.0.1
HOST_NAME=site.com
DOCUMENT_ROOT=/var/www/html
## Avalible versions: 7.3-apache 7.4-apache 8.0-apache 8.1-apache 8.2-apache 7.3-fpm 7.4-fpm 8.0-fpm 8.1-fpm 8.2-fpm ##
PHP_VERSION=7.3-apache
PHP_VERSION=8.2-apache
## Avalible versions: 5.7 8.0 ##
MYSQL_VERSION=5.7
MYSQL_VERSION=8.0
## Deploy settings ##
EXCLUDED_TABLES=b_event_log,b_search_content_stem,b_search_content,b_search_content_text,b_search_content_title,b_search_phrase,b_search_suggest,b_perf_error
Expand Down
7 changes: 4 additions & 3 deletions i18n/ru/docusaurus-plugin-content-docs/current/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ DL является оберткой поверх Docker и docker-compose, ни
Поддерживаемые фреймворки и CMS:
- Bitrix
- Laravel
- WordPress
- WordPress
- И многие другие с ручной установкой параметров

Поддерживаемые SHELL:
- bash
Expand All @@ -33,8 +34,8 @@ DL является оберткой поверх Docker и docker-compose, ни
Поддерживается docker compose (как плагин)

## Особенности
- Поддержка версий PHP (apache и php-fpm) 7.3, 7.4, 8.0, 8.1, 8.2
- Поддержка MySQL версий 5.7, 8.0
- Поддержка версий PHP (apache и php-fpm) 7.3, 7.4, 8.0, 8.1, 8.2, 8.3
- Поддержка MySQL, MariaDB и PostgreSQL
- Скачивание базы данных и файлов с production-сервера
- Redis
- Memcached
Expand Down

0 comments on commit 499f4e7

Please sign in to comment.