Skip to content

Commit 542b0be

Browse files
committed
docs: update documentation
1 parent b36bab5 commit 542b0be

20 files changed

+272
-475
lines changed

README.md

Lines changed: 39 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,53 @@
11
# spaceonfire/nginx-php-fpm
22

3-
Alpine-based docker image with NGINX and PHP-FPM. This is a fork of [`richarvey/nginx-php-fpm`](https://gitlab.com/ric_harvey/nginx-php-fpm) image.
3+
`spaceonfire/nginx-php-fpm` - Docker образ, основанный на Alpine Linux, с установленными Nginx и PHP-FPM.
44

5-
## Overview
5+
## Обзор
66

7-
This is a Dockerfile/image to build a container for nginx and php-fpm, with the ability to pull website code from git when the container is created, as well as allowing the container to push and pull changes to the code to and from git. The container also has the ability to update templated files with variables passed to docker in order to update your code and settings. There is support for lets encrypt SSL configurations, custom nginx configs, core nginx/PHP variable overrides for running preferences, X-Forwarded-For headers and UID mapping for local volume support.
7+
Данный Docker образ позволяет докеризировать любое приложение на PHP. `spaceonfire/nginx-php-fpm`
8+
из коробки предоставляет набор различных пресетов, покрывающих потребность запуска различных веб-приложений
9+
на PHP. Доступны настройки для простых PHP приложений, а также веб-приложений на WordPress, Laravel и 1С-Битрикс.
810

9-
If you have improvements or suggestions please open an issue or pull request on the GitHub project page.
11+
Если у вас есть улучшения или предложения, пожалуйста,
12+
не стесняйтесь открывать issue илл pull request на странице проекта GitHub.
1013

11-
### Versioning
12-
| Docker Tag | Git Release | Nginx Version | PHP Version | Alpine Version |
13-
|-----|-------|-----|--------|--------|
14-
| latest/1.5.7 | Master Branch |1.14.0 | 7.2.10 | 3.7 |
14+
### Версии ПО в образе
1515

16-
For other tags please see: [versioning](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/versioning.md)
16+
| Docker Tag | Git Release | Nginx Version | PHP Version | Alpine Version |
17+
| ------------ | ------------- | ------------- | ----------- | -------------- |
18+
| latest/1.3.3 | Master Branch | 1.14.0 | 7.2.10 | 3.7 |
1719

18-
### Links
19-
- [https://gitlab.com/ric_harvey/nginx-php-fpm](https://gitlab.com/ric_harvey/nginx-php-fpm)
20-
- [https://registry.hub.docker.com/u/richarvey/nginx-php-fpm/](https://registry.hub.docker.com/u/richarvey/nginx-php-fpm/)
20+
## Быстрый старт
21+
22+
Спуллить образ с Docker Hub:
2123

22-
## Quick Start
23-
To pull from docker hub:
24-
```
25-
docker pull richarvey/nginx-php-fpm:latest
26-
```
27-
### Running
28-
To simply run the container:
2924
```
30-
sudo docker run -d richarvey/nginx-php-fpm
25+
docker pull spaceonfire/nginx-php-fpm:latest
3126
```
32-
To dynamically pull code from git when starting:
27+
28+
### Запуск простого PHP приложения
29+
30+
Чтобы запустить ваше простое PHP приложение, не требующее особых правил роутинга, в директории с исходным кодом выполните:
31+
3332
```
34-
docker run -d -e 'GIT_EMAIL=email_address' -e 'GIT_NAME=full_name' -e 'GIT_USERNAME=git_username' -e 'GIT_REPO=github.com/project' -e 'GIT_PERSONAL_TOKEN=<long_token_string_here>' richarvey/nginx-php-fpm:latest
33+
docker run -d -v `pwd`:/var/www/html -p 80:8080 spaceonfire/nginx-php-fpm:latest
3534
```
3635

37-
You can then browse to ```http://<DOCKER_HOST>``` to view the default install files. To find your ```DOCKER_HOST``` use the ```docker inspect``` to get the IP address (normally 172.17.0.2)
38-
39-
For more detailed examples and explanations please refer to the documentation.
40-
## Documentation
41-
42-
- [Building from source](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/building.md)
43-
- [Versioning](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/versioning.md)
44-
- [Config Flags](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/config_flags.md)
45-
- [Git Auth](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/git_auth.md)
46-
- [Personal Access token](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/git_auth.md#personal-access-token)
47-
- [SSH Keys](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/git_auth.md#ssh-keys)
48-
- [Git Commands](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/git_commands.md)
49-
- [Push](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/git_commands.md#push-code-to-git)
50-
- [Pull](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/git_commands.md#pull-code-from-git-refresh)
51-
- [Repository layout / webroot](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/repo_layout.md)
52-
- [webroot](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/repo_layout.md#src--webroot)
53-
- [User / Group Identifiers](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/UID_GID_Mapping.md)
54-
- [Custom Nginx Config files](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/nginx_configs.md)
55-
- [REAL IP / X-Forwarded-For Headers](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/nginx_configs.md#real-ip--x-forwarded-for-headers)
56-
- [Scripting and Templating](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/scripting_templating.md)
57-
- [Environment Variables](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/scripting_templating.md#using-environment-variables--templating)
58-
- [Lets Encrypt Support](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/lets_encrypt.md)
59-
- [Setup](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/lets_encrypt.md#setup)
60-
- [Renewal](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/lets_encrypt.md#renewal)
61-
- [PHP Modules](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/php_modules.md)
62-
- [Xdebug](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/xdebug.md)
63-
- [Logging and Errors](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/logs.md)
64-
65-
## Guides
66-
- [Running in Kubernetes](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/guides/kubernetes.md)
67-
- [Using Docker Compose](https://gitlab.com/ric_harvey/nginx-php-fpm/blob/master/docs/guides/docker_compose.md)
36+
После запуска контейнера вы можете открыть в браузере `http://localhost:8080/`.
37+
38+
Для более подробных примеров обратитесь к документации и гидам.
39+
40+
## Документация
41+
42+
- [Архитектура образа](./docs/architecture.md)
43+
- [Конфигурация](./docs/configure.md)
44+
- [Пресеты](./docs/presets.md)
45+
- [Идентификаторы пользователя / группы](./docs/uid_gid_mapping.md)
46+
- [Настройка Nginx](./docs/nginx_configuration.md)
47+
- [PHP модули](./docs/php_modules.md)
48+
- [Xdebug](./docs/xdebug.md)
49+
- [Логи и ошибки](./docs/logs.md)
50+
51+
## Гиды
52+
53+
- [Docker Compose](./docs/guides/docker_compose.md)

docs/architecture.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Архитектура образа
2+
3+
Мы используем **supervisor** для запуска процессов Nginx и PHP-FPM внутри контейнера. Помимо этого в образе
4+
установлено ПО, которое может быть полезно широкому кругу проектов на PHP, например, mysql-client, ssmtp,
5+
cron, composer, certbot, git, openssh-client и др.
6+
7+
## Файловая система
8+
9+
| Путь | Значение |
10+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
11+
| `/etc/supervisord.conf` | Главный конфиг supervisor |
12+
| `/etc/supervisor/conf.d/` | В данной директории вы можете размещать конфиги для запуска собственных процессов в supervisor |
13+
| `/etc/nginx` | Директория конфигурации Nginx |
14+
| `/etc/nginx/vhost.common.d` | В данной директории вы можете размещать свои файлы для расширения конфигурации виртуального сервера в Nginx |
15+
| `/usr/local/etc/php/conf.d/` | Директория конфигурации PHP-FPM |
16+
| `/etc/ssmtp` | Директория конфигурации sSMTP, файлы конфигурации создаются автоматически ([подробнее](./configure.md)) |
17+
| `/opt/spaceonfire` | Директория скриптов, конфигураций, пресетов и прочего для образа |
18+
| `/var/www/html` | Корневая директория веб-сервера по-умолчанию |
19+
| `/var/www/html/scripts` | В данной директории вы можете разместить скрипты, которые необходимо выполнить перед запуском сервера. Используйте номера в качестве префикса для контроля порядка выполнения скриптов (`00,01,..,99`) |

docs/building.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/config_flags.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

0 commit comments

Comments
 (0)