mirror of
https://github.com/cytopia/devilbox.git
synced 2025-05-29 05:34:24 +00:00
Clean out sphinx errors
This commit is contained in:
parent
b7b215b6f1
commit
65497cb9d8
1
.gitignore
vendored
1
.gitignore
vendored
@ -80,6 +80,7 @@ docker-compose.override.yml
|
|||||||
/docs/_build/
|
/docs/_build/
|
||||||
/docs/make.bat
|
/docs/make.bat
|
||||||
/docs/Makefile
|
/docs/Makefile
|
||||||
|
*.rst.todo
|
||||||
|
|
||||||
# Keep folders
|
# Keep folders
|
||||||
!.keepme
|
!.keepme
|
||||||
|
8
docs/_static/css/custom.css
vendored
8
docs/_static/css/custom.css
vendored
@ -8,7 +8,13 @@
|
|||||||
.wy-side-nav-search {
|
.wy-side-nav-search {
|
||||||
background-color: #343131;
|
background-color: #343131;
|
||||||
}
|
}
|
||||||
|
.codeblock,
|
||||||
|
pre.literal-block,
|
||||||
|
.rst-content .literal-block,
|
||||||
|
.rst-content pre.literal-block,
|
||||||
|
div[class^='highlight'] {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
/*
|
/*
|
||||||
div.rtd-pro.rtd-pro-footer {
|
div.rtd-pro.rtd-pro-footer {
|
||||||
display: none;
|
display: none;
|
||||||
|
@ -97,10 +97,10 @@ that will always use this file:
|
|||||||
host> vi ./bash/vim.sh
|
host> vi ./bash/vim.sh
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
:name: ./bash/vim.sh
|
:name: ./bash/vim.sh
|
||||||
:caption: ./bash/vim.sh
|
:caption: ./bash/vim.sh
|
||||||
|
|
||||||
alias vim='vim -u /etc/bashrc-devilbox.d/.vimrc
|
alias vim='vim -u /etc/bashrc-devilbox.d/.vimrc
|
||||||
|
|
||||||
Whenever you start ``vim`` inside any PHP container, it will automatically use the provided vim
|
Whenever you start ``vim`` inside any PHP container, it will automatically use the provided vim
|
||||||
configuration file.
|
configuration file.
|
||||||
|
@ -1,3 +0,0 @@
|
|||||||
****
|
|
||||||
BIND
|
|
||||||
****
|
|
@ -1,3 +0,0 @@
|
|||||||
*****************
|
|
||||||
Devilbox Intranet
|
|
||||||
*****************
|
|
@ -1,3 +0,0 @@
|
|||||||
*********
|
|
||||||
Memcached
|
|
||||||
*********
|
|
@ -1,3 +0,0 @@
|
|||||||
*******
|
|
||||||
MongoDB
|
|
||||||
*******
|
|
@ -1,3 +0,0 @@
|
|||||||
*****
|
|
||||||
MySQL
|
|
||||||
*****
|
|
@ -1,5 +0,0 @@
|
|||||||
***
|
|
||||||
PHP
|
|
||||||
***
|
|
||||||
|
|
||||||
Environment variables
|
|
@ -1,3 +0,0 @@
|
|||||||
*****
|
|
||||||
Redis
|
|
||||||
*****
|
|
@ -1,57 +0,0 @@
|
|||||||
.. _configuration_webserver:
|
|
||||||
|
|
||||||
**********
|
|
||||||
Web server
|
|
||||||
**********
|
|
||||||
|
|
||||||
This page lists a general overview about the bundled web server - its features,
|
|
||||||
where it comes from, how it is built and what configuration is possible.
|
|
||||||
|
|
||||||
|
|
||||||
**Table of Contents**
|
|
||||||
|
|
||||||
.. contents:: :local:
|
|
||||||
|
|
||||||
|
|
||||||
Features
|
|
||||||
========
|
|
||||||
|
|
||||||
Auto-virtual hosts
|
|
||||||
------------------
|
|
||||||
|
|
||||||
File permission problem
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
Custom global configuration
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
Custom vhost configuration
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
|
|
||||||
Information
|
|
||||||
===========
|
|
||||||
|
|
||||||
Dockerfile
|
|
||||||
----------
|
|
||||||
|
|
||||||
Github
|
|
||||||
------
|
|
||||||
|
|
||||||
Dockerhub
|
|
||||||
---------
|
|
||||||
|
|
||||||
Build process
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Configuration
|
|
||||||
=============
|
|
||||||
|
|
||||||
.env file
|
|
||||||
---------
|
|
||||||
|
|
||||||
apache.conf / nginx.conf
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
vhost-gen
|
|
||||||
---------
|
|
@ -50,12 +50,6 @@ host is ready to be served with your custom domain.
|
|||||||
:caption: Maintenance
|
:caption: Maintenance
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
maintenance/install
|
|
||||||
maintenance/update
|
|
||||||
maintenance/uninstall
|
|
||||||
maintenance/start-the-devilbox
|
|
||||||
maintenance/add-service-to-running-devilbox
|
|
||||||
maintenance/remove-service-from-running-devilbox
|
|
||||||
maintenance/backup-and-restore-mysql
|
maintenance/backup-and-restore-mysql
|
||||||
maintenance/backup-and-restore-pgsql
|
maintenance/backup-and-restore-pgsql
|
||||||
maintenance/backup-and-restore-mongo
|
maintenance/backup-and-restore-mongo
|
||||||
@ -69,16 +63,11 @@ host is ready to be served with your custom domain.
|
|||||||
tutorials/add-your-own-docker-image
|
tutorials/add-your-own-docker-image
|
||||||
tutorials/overwrite-existing-docker-image
|
tutorials/overwrite-existing-docker-image
|
||||||
tutorials/adding-subdomains
|
tutorials/adding-subdomains
|
||||||
tutorials/configure-database-in-your-project
|
|
||||||
tutorials/change-document-root
|
|
||||||
tutorials/change-container-versions
|
tutorials/change-container-versions
|
||||||
tutorials/work-inside-the-container
|
tutorials/work-inside-the-container
|
||||||
tutorials/enable-xdebug
|
tutorials/enable-xdebug
|
||||||
tutorials/customize-vhost
|
|
||||||
tutorials/custom-apache-modules
|
tutorials/custom-apache-modules
|
||||||
tutorials/custom-environment-variables
|
tutorials/custom-environment-variables
|
||||||
tutorials/password-protect-intranet
|
|
||||||
tutorials/disable-intranet
|
|
||||||
tutorials/static-code-analysis
|
tutorials/static-code-analysis
|
||||||
|
|
||||||
|
|
||||||
@ -148,9 +137,6 @@ host is ready to be served with your custom domain.
|
|||||||
:caption: Advanced
|
:caption: Advanced
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
advanced/technical
|
|
||||||
advanced/hacking
|
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: Support
|
:caption: Support
|
||||||
@ -158,6 +144,5 @@ host is ready to be served with your custom domain.
|
|||||||
|
|
||||||
support/faq
|
support/faq
|
||||||
support/troubleshooting
|
support/troubleshooting
|
||||||
support/contributing
|
|
||||||
support/blogs-videos-and-use-cases
|
support/blogs-videos-and-use-cases
|
||||||
support/artwork
|
support/artwork
|
||||||
|
@ -23,7 +23,7 @@ Backup
|
|||||||
|
|
||||||
There are many different options to backup your MySQL database including some for the command line
|
There are many different options to backup your MySQL database including some for the command line
|
||||||
and some for using the Web interface. The recommended and fastest method is to use
|
and some for using the Web interface. The recommended and fastest method is to use
|
||||||
``mysqldump-secure``, as it will also add info files (*.info) to each database recording checksums,
|
``mysqldump-secure``, as it will also add info files (\*.info) to each database recording checksums,
|
||||||
dump date, dump options as well as the server version it came from.
|
dump date, dump options as well as the server version it came from.
|
||||||
|
|
||||||
|
|
||||||
@ -39,26 +39,26 @@ To have your backups in place is just three commands away:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Enter the PHP container
|
# Enter the PHP container
|
||||||
host> ./shell.sh
|
host> ./shell.sh
|
||||||
|
|
||||||
# Run mysqldump-secure
|
# Run mysqldump-secure
|
||||||
devilbox@php-7.1.6 in /shared/httpd $ mysqldump-secure
|
devilbox@php-7.1.6 in /shared/httpd $ mysqldump-secure
|
||||||
|
|
||||||
[INFO] (OPT): Logging enabled
|
[INFO] (OPT): Logging enabled
|
||||||
[INFO] (OPT): MySQL SSL connection disabled
|
[INFO] (OPT): MySQL SSL connection disabled
|
||||||
[INFO] (OPT): Compression enabled
|
[INFO] (OPT): Compression enabled
|
||||||
[INFO] (OPT): Encryption disabled
|
[INFO] (OPT): Encryption disabled
|
||||||
[INFO] (OPT): Deletion disabled
|
[INFO] (OPT): Deletion disabled
|
||||||
[INFO] (OPT): Nagios log disabled
|
[INFO] (OPT): Nagios log disabled
|
||||||
[INFO] (OPT): Info files enabled
|
[INFO] (OPT): Info files enabled
|
||||||
[INFO] (SQL): 1/3 Skipping: information_schema (DB is ignored)
|
[INFO] (SQL): 1/3 Skipping: information_schema (DB is ignored)
|
||||||
[INFO] (SQL): 2/3 Dumping: mysql (0.66 MB) 1 sec (0.13 MB)
|
[INFO] (SQL): 2/3 Dumping: mysql (0.66 MB) 1 sec (0.13 MB)
|
||||||
[INFO] (SQL): 3/3 Skipping: performance_schema (DB is ignored)
|
[INFO] (SQL): 3/3 Skipping: performance_schema (DB is ignored)
|
||||||
[OK] Finished successfully
|
[OK] Finished successfully
|
||||||
|
|
||||||
List backups
|
List backups
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
@ -67,31 +67,31 @@ Let's see where to find the backups inside the PHP container:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Enter the PHP container
|
# Enter the PHP container
|
||||||
host> ./shell.sh
|
host> ./shell.sh
|
||||||
|
|
||||||
# Show directory output
|
# Show directory output
|
||||||
devilbox@php-7.1.6 in /shared/httpd $ ls -l /shared/backups/mysql/
|
devilbox@php-7.1.6 in /shared/httpd $ ls -l /shared/backups/mysql/
|
||||||
|
|
||||||
-rw-r--r-- 1 devilbox 136751 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz
|
-rw-r--r-- 1 devilbox 136751 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz
|
||||||
-rw-r--r-- 1 devilbox 2269 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz.info
|
-rw-r--r-- 1 devilbox 2269 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz.info
|
||||||
|
|
||||||
|
|
||||||
Let's do the same again and see where to find the backups in the Devilbox git directory
|
Let's do the same again and see where to find the backups in the Devilbox git directory
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Show directory output
|
# Show directory output
|
||||||
host> ls -l backups/mysql/
|
host> ls -l backups/mysql/
|
||||||
|
|
||||||
-rw-r--r-- 1 cytopia 136751 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz
|
-rw-r--r-- 1 cytopia 136751 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz
|
||||||
-rw-r--r-- 1 cytopia 2269 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz.info
|
-rw-r--r-- 1 cytopia 2269 Jun 17 13:31 2017-06-17_13-31__mysql.sql.gz.info
|
||||||
|
|
||||||
``*.info`` files
|
``*.info`` files
|
||||||
^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^
|
||||||
@ -101,86 +101,85 @@ occured during backups. Let's have a look at one of them:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
host> cat ./backups/mysql/2017-06-17_13-31__mysql.sql.gz.info
|
host> cat ./backups/mysql/2017-06-17_13-31__mysql.sql.gz.info
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: 2017-06-17_13-31__mysql.sql.gz.info
|
:caption: 2017-06-17_13-31__mysql.sql.gz.info
|
||||||
:caption: 2017-06-17_13-31__mysql.sql.gz.info
|
|
||||||
|
|
||||||
; mysqldump-secure backup record
|
; mysqldump-secure backup record
|
||||||
; Do not alter this file!
|
; Do not alter this file!
|
||||||
; Creation of this file can be turned off via config file.
|
; Creation of this file can be turned off via config file.
|
||||||
|
|
||||||
; ============================================================
|
; ============================================================
|
||||||
; = Local system information
|
; = Local system information
|
||||||
; ============================================================
|
; ============================================================
|
||||||
[mysqldump-secure]
|
[mysqldump-secure]
|
||||||
version = /usr/local/bin/mysqldump-secure (0.16.3)
|
version = /usr/local/bin/mysqldump-secure (0.16.3)
|
||||||
vdate = 2016-08-18
|
vdate = 2016-08-18
|
||||||
config = /etc/mysqldump-secure.conf
|
config = /etc/mysqldump-secure.conf
|
||||||
|
|
||||||
[system]
|
[system]
|
||||||
uname = Linux 4.4.0-79-generic
|
uname = Linux 4.4.0-79-generic
|
||||||
hostname =
|
hostname =
|
||||||
user = devilbox
|
user = devilbox
|
||||||
group = devilbox
|
group = devilbox
|
||||||
|
|
||||||
[tools]
|
[tools]
|
||||||
mysqldump = /usr/bin/mysqldump (10.14 Distrib 5.5.52-MariaDB) [for Linux (x86_64)]
|
mysqldump = /usr/bin/mysqldump (10.14 Distrib 5.5.52-MariaDB) [for Linux (x86_64)]
|
||||||
mysql = /usr/bin/mysql (15.1 Distrib 5.5.52-MariaDB) [for Linux (x86_64) using readline 5.1]
|
mysql = /usr/bin/mysql (15.1 Distrib 5.5.52-MariaDB) [for Linux (x86_64) using readline 5.1]
|
||||||
compressor = /usr/bin/gzip (gzip 1.5)
|
compressor = /usr/bin/gzip (gzip 1.5)
|
||||||
encryptor = Not used
|
encryptor = Not used
|
||||||
|
|
||||||
; ============================================================
|
; ============================================================
|
||||||
; = Database / File information
|
; = Database / File information
|
||||||
; ============================================================
|
; ============================================================
|
||||||
[database]
|
[database]
|
||||||
db_name = mysql
|
db_name = mysql
|
||||||
db_size = 687326 Bytes (0.66 MB)
|
db_size = 687326 Bytes (0.66 MB)
|
||||||
tbl_cnt = 30
|
tbl_cnt = 30
|
||||||
|
|
||||||
[file]
|
[file]
|
||||||
file_path = /shared/backups/mysql
|
file_path = /shared/backups/mysql
|
||||||
file_name = 2017-06-17_13-31__mysql.sql.gz
|
file_name = 2017-06-17_13-31__mysql.sql.gz
|
||||||
file_size = 136751 Bytes (0.13 MB)
|
file_size = 136751 Bytes (0.13 MB)
|
||||||
file_chmod = 0644
|
file_chmod = 0644
|
||||||
file_owner = devilbox
|
file_owner = devilbox
|
||||||
file_group = devilbox
|
file_group = devilbox
|
||||||
file_mtime = 1497699116 (2017-06-17 13:31:56 CEST [+0200])
|
file_mtime = 1497699116 (2017-06-17 13:31:56 CEST [+0200])
|
||||||
file_md5 = 8d1a6c38f81c691bc4b490e7024a4f72
|
file_md5 = 8d1a6c38f81c691bc4b490e7024a4f72
|
||||||
file_sha = 11fb85282ea866dfc69d29dc02a0418bebfea30e7e566c3c588a50987aceac2f
|
file_sha = 11fb85282ea866dfc69d29dc02a0418bebfea30e7e566c3c588a50987aceac2f
|
||||||
|
|
||||||
; ============================================================
|
; ============================================================
|
||||||
; = Dump procedure information
|
; = Dump procedure information
|
||||||
; ============================================================
|
; ============================================================
|
||||||
[mysqldump]
|
[mysqldump]
|
||||||
encrypted = 0
|
encrypted = 0
|
||||||
compressed = 1
|
compressed = 1
|
||||||
arguments = --opt --default-character-set=utf8 --events --triggers --routines --hex-blob --complete-insert --extended-insert --compress --lock-tables --skip-quick
|
arguments = --opt --default-character-set=utf8 --events --triggers --routines --hex-blob --complete-insert --extended-insert --compress --lock-tables --skip-quick
|
||||||
duration = 1 sec
|
duration = 1 sec
|
||||||
|
|
||||||
[compression]
|
[compression]
|
||||||
compressor = gzip
|
compressor = gzip
|
||||||
arguments = -9 --stdout
|
arguments = -9 --stdout
|
||||||
|
|
||||||
[encryption]
|
[encryption]
|
||||||
encryptor =
|
encryptor =
|
||||||
algorithm =
|
algorithm =
|
||||||
pubkey =
|
pubkey =
|
||||||
|
|
||||||
; ============================================================
|
; ============================================================
|
||||||
; = Server information
|
; = Server information
|
||||||
; ============================================================
|
; ============================================================
|
||||||
[connection]
|
[connection]
|
||||||
protocol = mysql via TCP/IP
|
protocol = mysql via TCP/IP
|
||||||
secured = No SSL
|
secured = No SSL
|
||||||
arguments = --defaults-file=/etc/mysqldump-secure.cnf
|
arguments = --defaults-file=/etc/mysqldump-secure.cnf
|
||||||
|
|
||||||
[server]
|
[server]
|
||||||
hostname = 001b3750b549
|
hostname = 001b3750b549
|
||||||
port = 3306
|
port = 3306
|
||||||
replica = master
|
replica = master
|
||||||
version = MariaDB 10.1.23-MariaDB MariaDB Server
|
version = MariaDB 10.1.23-MariaDB MariaDB Server
|
||||||
|
|
||||||
|
|
||||||
mysqldump
|
mysqldump
|
||||||
@ -192,14 +191,14 @@ example which shows you how to do that from within the PHP container:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Enter the PHP container
|
# Enter the PHP container
|
||||||
host> ./shell.sh
|
host> ./shell.sh
|
||||||
|
|
||||||
# Start the backup
|
# Start the backup
|
||||||
devilbox@php-7.1.6 in /shared/httpd $ mysqldump -h mysql -u root -p my_db_name > /shared/backups/mysql/my_db_name.sql
|
devilbox@php-7.1.6 in /shared/httpd $ mysqldump -h mysql -u root -p my_db_name > /shared/backups/mysql/my_db_name.sql
|
||||||
|
|
||||||
To find out more about the configuration and options of mysqldump, visit its project page under:
|
To find out more about the configuration and options of mysqldump, visit its project page under:
|
||||||
https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html
|
https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html
|
||||||
@ -238,14 +237,14 @@ binary. Here are a few examples for different file types:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Enter the PHP container
|
# Enter the PHP container
|
||||||
host> ./shell.sh
|
host> ./shell.sh
|
||||||
|
|
||||||
# Start the import
|
# Start the import
|
||||||
devilbox@php-7.1.6 in /shared/httpd $ mysql -h mysql -u root -p my_db_name < /shared/backups/mysql/my_db_name.sql
|
devilbox@php-7.1.6 in /shared/httpd $ mysql -h mysql -u root -p my_db_name < /shared/backups/mysql/my_db_name.sql
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -254,14 +253,14 @@ binary. Here are a few examples for different file types:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Enter the PHP container
|
# Enter the PHP container
|
||||||
host> ./shell.sh
|
host> ./shell.sh
|
||||||
|
|
||||||
# Start the import
|
# Start the import
|
||||||
devilbox@php-7.1.6 in /shared/httpd $ zcat /shared/backups/mysql/my_db_name.sql.gz | mysql -h mysql -u root -p my_db_name
|
devilbox@php-7.1.6 in /shared/httpd $ zcat /shared/backups/mysql/my_db_name.sql.gz | mysql -h mysql -u root -p my_db_name
|
||||||
|
|
||||||
|
|
||||||
``*.sql.tar.gz`` file
|
``*.sql.tar.gz`` file
|
||||||
@ -269,14 +268,14 @@ binary. Here are a few examples for different file types:
|
|||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
# Navigate to the Devilbox directory
|
# Navigate to the Devilbox directory
|
||||||
host> cd path/to/devilbox
|
host> cd path/to/devilbox
|
||||||
|
|
||||||
# Enter the PHP container
|
# Enter the PHP container
|
||||||
host> ./shell.sh
|
host> ./shell.sh
|
||||||
|
|
||||||
# Start the import
|
# Start the import
|
||||||
devilbox@php-7.1.6 in /shared/httpd $ tar xzOf /shared/backups/mysql/my_db_name.sql.tar.gz | mysql -h mysql -u root -p my_db_name
|
devilbox@php-7.1.6 in /shared/httpd $ tar xzOf /shared/backups/mysql/my_db_name.sql.tar.gz | mysql -h mysql -u root -p my_db_name
|
||||||
|
|
||||||
|
|
||||||
phpMyAdmin
|
phpMyAdmin
|
||||||
|
@ -34,16 +34,15 @@ Additionally to the specific configurations for each operating system and Docker
|
|||||||
probably also want to add the following to your ini file:
|
probably also want to add the following to your ini file:
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
|
||||||
|
|
||||||
xdebug.default_enable=1
|
xdebug.default_enable=1
|
||||||
xdebug.remote_enable=1
|
xdebug.remote_enable=1
|
||||||
xdebug.remote_handler=dbgp
|
xdebug.remote_handler=dbgp
|
||||||
xdebug.remote_port=9000
|
xdebug.remote_port=9000
|
||||||
xdebug.remote_autostart=1
|
xdebug.remote_autostart=1
|
||||||
xdebug.idekey="PHPSTORM"
|
xdebug.idekey="PHPSTORM"
|
||||||
xdebug.remote_log=/var/log/php/xdebug.log
|
xdebug.remote_log=/var/log/php/xdebug.log
|
||||||
|
|
||||||
.. seealso:: https://xdebug.org/docs/all_settings
|
.. seealso:: https://xdebug.org/docs/all_settings
|
||||||
|
|
||||||
@ -94,20 +93,19 @@ Keep the exact path of ``/var/log/php/xdebug.log``. You will then have the log f
|
|||||||
in the Devilbox log directory of the PHP version for which you have configured Xdebug.
|
in the Devilbox log directory of the PHP version for which you have configured Xdebug.
|
||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
You can set the value of ``xdebug.idekey`` to whatever you like, however it is important
|
You can set the value of ``xdebug.idekey`` to whatever you like, however it is important
|
||||||
to remember what value you have set. Throughout the examples in this tutorial it is assumed,
|
to remember what value you have set. Throughout the examples in this tutorial it is assumed,
|
||||||
that the value is ``PHPSTORM``.
|
that the value is ``PHPSTORM``.
|
||||||
|
|
||||||
|
|
||||||
Linux
|
Linux
|
||||||
-----
|
-----
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
:emphasize-lines: 1
|
||||||
:emphasize-lines: 1
|
|
||||||
|
|
||||||
xdebug.remote_connect_back=1
|
xdebug.remote_connect_back=1
|
||||||
|
|
||||||
|
|
||||||
MacOS (Docker for Mac)
|
MacOS (Docker for Mac)
|
||||||
@ -116,32 +114,29 @@ MacOS (Docker for Mac)
|
|||||||
Docker 18.03.0-ce+ and Docker compose 1.20.1+
|
Docker 18.03.0-ce+ and Docker compose 1.20.1+
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
:emphasize-lines: 1
|
||||||
:emphasize-lines: 1
|
|
||||||
|
|
||||||
xdebug.remote_host=host.docker.internal
|
xdebug.remote_host=host.docker.internal
|
||||||
xdebug.remote_connect_back=0
|
xdebug.remote_connect_back=0
|
||||||
|
|
||||||
Docker 17.12.0-ce+ and Docker compose 1.18.0+
|
Docker 17.12.0-ce+ and Docker compose 1.18.0+
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
:emphasize-lines: 1
|
||||||
:emphasize-lines: 1
|
|
||||||
|
|
||||||
xdebug.remote_host=docker.for.mac.host.internal
|
xdebug.remote_host=docker.for.mac.host.internal
|
||||||
xdebug.remote_connect_back=0
|
xdebug.remote_connect_back=0
|
||||||
|
|
||||||
Docker 17.06.0-ce+ and Docker compose 1.14.0+
|
Docker 17.06.0-ce+ and Docker compose 1.14.0+
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
:emphasize-lines: 1
|
||||||
:emphasize-lines: 1
|
|
||||||
|
|
||||||
xdebug.remote_host=docker.for.mac.localhost
|
xdebug.remote_host=docker.for.mac.localhost
|
||||||
xdebug.remote_connect_back=0
|
xdebug.remote_connect_back=0
|
||||||
|
|
||||||
If you have older versions, upgrade.
|
If you have older versions, upgrade.
|
||||||
|
|
||||||
@ -150,8 +145,8 @@ MacOS (Docker Toolbox)
|
|||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
This is a legacy solution, upgrade to Docker for Mac
|
This is a legacy solution, upgrade to Docker for Mac
|
||||||
https://docs.docker.com/toolbox
|
https://docs.docker.com/toolbox
|
||||||
|
|
||||||
|
|
||||||
Windows (Docker for Windows)
|
Windows (Docker for Windows)
|
||||||
@ -160,22 +155,20 @@ Windows (Docker for Windows)
|
|||||||
Docker 18.03.0-ce+ and Docker compose 1.20.1+
|
Docker 18.03.0-ce+ and Docker compose 1.20.1+
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
:emphasize-lines: 1
|
||||||
:emphasize-lines: 1
|
|
||||||
|
|
||||||
xdebug.remote_host=docker.for.win.host.internal
|
xdebug.remote_host=docker.for.win.host.internal
|
||||||
xdebug.remote_connect_back=0
|
xdebug.remote_connect_back=0
|
||||||
|
|
||||||
Docker 17.06.0-ce+ and Docker compose 1.14.0+
|
Docker 17.06.0-ce+ and Docker compose 1.14.0+
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
:emphasize-lines: 1
|
||||||
:emphasize-lines: 1
|
|
||||||
|
|
||||||
xdebug.remote_host=docker.for.win.host.localhost
|
xdebug.remote_host=docker.for.win.host.localhost
|
||||||
xdebug.remote_connect_back=0
|
xdebug.remote_connect_back=0
|
||||||
|
|
||||||
If you have older versions, upgrade.
|
If you have older versions, upgrade.
|
||||||
|
|
||||||
@ -184,8 +177,8 @@ Windows (Docker Toolbox)
|
|||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
This is a legacy solution, upgrade to Docker for Windows
|
This is a legacy solution, upgrade to Docker for Windows
|
||||||
https://docs.docker.com/toolbox
|
https://docs.docker.com/toolbox
|
||||||
|
|
||||||
|
|
||||||
Configure your IDE
|
Configure your IDE
|
||||||
@ -206,8 +199,8 @@ setting up your IDE config.
|
|||||||
The path inside the PHP Docker container is always ``/shared/httpd``.
|
The path inside the PHP Docker container is always ``/shared/httpd``.
|
||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
Even though your path in ``.env`` for :ref:`env_httpd_datadir` might be relative (e.g. ``./data/www``),
|
Even though your path in ``.env`` for :ref:`env_httpd_datadir` might be relative (e.g. ``./data/www``),
|
||||||
you need to get the actualy absolute path of it, when setting up your IDE.
|
you need to get the actualy absolute path of it, when setting up your IDE.
|
||||||
|
|
||||||
IDE key
|
IDE key
|
||||||
^^^^^^^
|
^^^^^^^
|
||||||
@ -230,27 +223,25 @@ Atom
|
|||||||
For Atom, you need to provide a different ``xdebug.idekey`` in your php.ini file ``xdebug.ini``:
|
For Atom, you need to provide a different ``xdebug.idekey`` in your php.ini file ``xdebug.ini``:
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
:name: xdebug.ini
|
:caption: xdebug.ini
|
||||||
:caption: xdebug.ini
|
|
||||||
|
|
||||||
xdebug.idekey=xdebug.atom
|
xdebug.idekey=xdebug.atom
|
||||||
|
|
||||||
|
|
||||||
Linux
|
Linux
|
||||||
^^^^^^
|
^^^^^^
|
||||||
.. code-block:: json
|
.. code-block:: js
|
||||||
:name: launch.json
|
:caption: launch.json
|
||||||
:caption: launch.json
|
:emphasize-lines: 6
|
||||||
:emphasize-lines: 6
|
|
||||||
|
|
||||||
"php-debug":
|
"php-debug":
|
||||||
{
|
{
|
||||||
ServerPort: 9000
|
ServerPort: 9000
|
||||||
PathMaps: [
|
PathMaps: [
|
||||||
"remotepath;localpath"
|
"remotepath;localpath"
|
||||||
"/shared/httpd;/home/cytopia/repo/devilbox/data/www"
|
"/shared/httpd;/home/cytopia/repo/devilbox/data/www"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
MacOS (Docker for Mac)
|
MacOS (Docker for Mac)
|
||||||
^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^
|
||||||
@ -315,19 +306,18 @@ Sublime Text 3
|
|||||||
Linux
|
Linux
|
||||||
^^^^^^
|
^^^^^^
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
:name: Xdebug-sublime-settings
|
:caption: Xdebug-sublime-settings
|
||||||
:caption: Xdebug-sublime-settings
|
:emphasize-lines: 3,6
|
||||||
:emphasize-lines: 3,6
|
|
||||||
|
|
||||||
{
|
{
|
||||||
"path_mapping": {
|
"path_mapping": {
|
||||||
"/shared/httpd" : "/home/cytopia/repo/devilbox/data/www"
|
"/shared/httpd" : "/home/cytopia/repo/devilbox/data/www"
|
||||||
},
|
},
|
||||||
"url": "",
|
"url": "",
|
||||||
"ide_key": "PHPSTORM",
|
"ide_key": "PHPSTORM",
|
||||||
"host": "0.0.0.0",
|
"host": "0.0.0.0",
|
||||||
"port": 9000
|
"port": 9000
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
MacOS (Docker for Mac)
|
MacOS (Docker for Mac)
|
||||||
@ -356,30 +346,29 @@ Visual Studio Code
|
|||||||
Linux
|
Linux
|
||||||
^^^^^^
|
^^^^^^
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
:name: launch.json
|
:caption: launch.json
|
||||||
:caption: launch.json
|
:emphasize-lines: 9,10
|
||||||
:emphasize-lines: 9,10
|
|
||||||
|
|
||||||
{
|
{
|
||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
{
|
{
|
||||||
"name": "Listen for Xbebug",
|
"name": "Listen for Xbebug",
|
||||||
"type": "php",
|
"type": "php",
|
||||||
"request": "launch",
|
"request": "launch",
|
||||||
"port": 9000,
|
"port": 9000,
|
||||||
"serverSourceRoot": "/shared/httpd",
|
"serverSourceRoot": "/shared/httpd",
|
||||||
"localSourceRoot": "/home/cytopia/repo/devilbox/data/www"
|
"localSourceRoot": "/home/cytopia/repo/devilbox/data/www"
|
||||||
}, {
|
}, {
|
||||||
"name": "Launch currently open script",
|
"name": "Launch currently open script",
|
||||||
"type": "php",
|
"type": "php",
|
||||||
"request": "launch",
|
"request": "launch",
|
||||||
"program": "${file}",
|
"program": "${file}",
|
||||||
"cwd": "${fileDirname}",
|
"cwd": "${fileDirname}",
|
||||||
"port": 9000
|
"port": 9000
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
MacOS (Docker for Mac)
|
MacOS (Docker for Mac)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user