ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2025-02-20 17:33:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

REL-0.11 Configuration documentation

Browse Source
This commit is contained in:
cytopia 2017-06-20 12:15:32 +02:00
parent 5bd9d312b2
commit 947136a383
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
6 changed files with 133 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
docs/Configure.md
View File

@ -66,5 +66,106 @@ Configure |
---
## 1. Overview
## 2. Devilbox general settings
#### 2.1 Verbosity
| `.env` file variable name | Default | Note |
|---------------------------|---------|------|
| DEBUG_COMPOSE_ENTRYPOINT | `0` | Set it to `1` or `0` |
If set to `1`, it will show all executed commands during docker startup.
#### 2.2 Devilbox base path
| `.env` file variable name | Default | Note |
|---------------------------|---------|------|
| DEVILBOX_PATH | `.` | Relative or absolute path allowed |
This is the base path that will be prepended to all mount paths specified in `.env`.
You will usually not need to change this value..
#### 2.3 Host computer listening address
| `.env` file variable name | Default | Note |
|---------------------------|---------|------|
| LOCAL_LISTEN_ADDRESS | `127.0.0.1:` | Address for every service to listen on the Docker host.<br/>Pay attention to the **`:`** after the IP address |
This determines the Host address your webserver and all other daemons should listen on.
In case it is not `127.0.0.1` (because you are using a VirtualBox Docker setup) change it to the IP address of the VirtualBox host. Otherwise you will not need to change this value.
1. When you remove it completely, it will listen on all interfaces.
2. When you use specific address, you must add a **`:`** at the end.
## 3. Project settings
#### 3.1 Project domain
| `.env` file variable name | Default | Note |
|---------------------------|---------|------|
| TLD_SUFFIX | `loc` | Domain suffix for all your project. Can also be a subdomain such `work.loc` |
Each project will be served by `http://<project-folder>.<TLD_SUFFIX>`. If you want to change the default `loc` domain suffix to something else such as local, adjust this variable. Here are a few examples:
| Project Folder | TLD_SUFFIX | URL |
|----------------|------------|-----|
| my-cake | loc | http://my-cake.loc |
| my-cake | local | http://my-cake.local |
| my-cake | dev | http://my-cake.dev |
| my-cake | work.loc | http://my-cake.work.loc |
| test | foo | http://test.foo |
| project1 | bar | http://project1.bar |
The above examples should make it clear enough.
#### 3.2 Project path
| `.env` file variable name | Default | Note |
|---------------------------|---------|------|
| HOST_PATH_HTTPD_DATADIR | `./data/www` | Can be absolute or relative path. A relative path starts inside the devilbox git directory. |
This is the file system path on your host computer which will hold the Project Folders.
## 4. Container settings
#### 4.1 General
##### 4.1.1 Timezone
#### 4.2 PHP / HHVM
##### 4.2.1 User id
##### 4.2.2 Group id
##### 4.2.3 Xdebug
##### 4.2.4 php.ini
##### 4.2.5 HHVM
#### 4.3 Webserver
##### 4.3.1 Host port
#### 4.4 MySQL
##### 4.4.1 Root password
##### 4.4.2 General Log
##### 4.4.3 Host port
##### 4.4.4 Data path
##### 4.4.5 my.cnf
#### 4.5 PostgreSQL
##### 4.5.1 Root user
##### 4.5.2 Root password
##### 4.5.3 Host port
##### 4.5.4 Data path
#### 4.6 Redis
##### 4.6.1 Host port
#### 4.7 Memcached
##### 4.7.1 Host port
#### 4.8 MongoDB
##### 4.8.1 Host port
##### 4.8.2 Data path
#### 4.9 Bind
##### 4.9.1 Upstream resolver
##### 4.9.2 Host port
## 5. Intranet settings
#### 5.1 DNS check timeout
## 6. Host computer
#### 6.1 DNS
#### 6.2 /etc/hosts/

16
docs/Examples.md
View File

@ -36,7 +36,8 @@ The devilbox provides popular tools for setting up and managing major frameworks
| `drush` | [drush](http://www.drush.org/) | Drupal |
| `drupal` | [drupal-consol](https://drupalconsole.com) | Drupal |
| `git` | [git](https://git-scm.com) | Everything available on github and other git servers |
| `symfony` | [symfony installer](https://github.com/symfony/symfony-installer) | Symfony |
| `phalcon` | [phalcon devtools](https://github.com/phalcon/phalcon-devtools) | Phalcon |
| `symfony` | [symfony installer](https://github.com/symfony/symfony-installer) | Symfony |
| `wp` | [wp-cli](https://wp-cli.org/) | Wordpress |
@ -173,8 +174,9 @@ It will be ready in six simple steps:
2. Create a new VirtualHost directory
3. Install Symfony via `symfony`
4. Symlink web directory
5. Setup DNS record
6. Visit http://my-symfony.local/app.php in your browser
5. Enable Symfony prod (app.php)
6. Setup DNS record
7. Visit http://my-symfony.local in your browser
```shell
# 1. Enter the PHP container
@ -189,16 +191,20 @@ devilbox@php-7.0.20 in /shared/httpd $ symfony new symfony
# 4. Symlink web directory
devilbox@php-7.0.20 in /shared/httpd $ ln -s symfony/web htdocs
# 5. Enable Symfony production (app.php)
devilbox@php-7.0.20 in /shared/httpd $ cd symfony/web
devilbox@php-7.0.20 in /shared/httpd $ ln -s app.php index.php
```
**5. DNS record**
**6. DNS record**
If you do not have auto-DNS configured, you will need to add the following line to your Host computer's `/etc/hosts`:
```shell
127.0.0.1 my-symfony.local
```
**6. Open your browser**
**7. Open your browser**
Open your browser at http://my-symfony.local/app.php

11
docs/FAQ.md
View File

@ -18,13 +18,6 @@ FAQ
## FAQ
**How do I backup my MySQL database?**
1. Use phpMyAdmin
2. Use Adminer
3. use `mysqldump` from your host computer
4. use `mysqldump` from within the php container
**Why are mounted MySQL data directories separated by version?**
This is just a pre-caution. Imagine they would link to the same datadir. You start the devilbox with mysql 5.5, create a database and add some data. Now you decide to switch to mysql 5.7 and restart the devilbox. The newer mysql version will probably upgrade the data leaving it unable to start with older mysql versions.
@ -33,6 +26,10 @@ This is just a pre-caution. Imagine they would link to the same datadir. You sta
See: *Why are mounted MySQL data directories separated by version?*
**Why are mounted MongoDB data directories separated by version?**
See: *Why are mounted MySQL data directories separated by version?*
**Why do the user/group permissions of log/ or cfg/ directories show 1000?**
Uid and Gid are set to 1000 by default. You can alter them to match the uid/gid of your current user. Open the `.env` file and change the sections `NEW_UID` and `NEW_GID`. When you start up the devilbox, the php-container will use these values for its user.

2
docs/Quickstart.md
View File

@ -48,6 +48,7 @@ $ cp env-example .env
```shell
$ docker-compose stop
$ docker-compose rm
$ git fetch --all
$ git checkout "$(git describe --abbrev=0 --tags)"
```
@ -56,6 +57,7 @@ $ git checkout "$(git describe --abbrev=0 --tags)"
```shell
$ docker-compose stop
$ docker-compose rm
$ git fetch --all
$ git pull origin master
$ ./update-docker.sh

4
docs/README.md
View File

@ -109,6 +109,10 @@ The devilbox runs on all major operating systems. Below you can quickly check th
[osx-issues]: https://github.com/cytopia/devilbox/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22host%3Aosx%22
**How about FreeBSD?**
The devilbox has not been tested on FreeBSD yet. Current milestones include to make it rock-solid on the above listed operating systems. However, if you want it to run on FreeBSD open up an issue on Github and you will receive support making it work on FreeBSD.
## 4. Requirements
* **Internet connection** - only required during initial setup for cloning the devilbox repository and pulling the required docker container. Afterwards you can always work offline.

12
docs/Update.md
View File

@ -23,6 +23,7 @@ Update |
2. [Git master branch](#2-2-git-master-branch)
3. [Compare .env file](#3-compare-env-file)
4. [Pull new Docker container (Important!)](#4-pull-new-docker-container-important-)
5. [Remove anonymous volumes](#5-remove-anonymous-volumes)
---
@ -31,8 +32,9 @@ Update |
Shutdown, update and startup.
```shell
# Stop container and update git
# Stop container, remove deprecated volumes and update git
$ docker-compose down
$ docker-compose rm
$ git fetch --all
$ git pull origin master
@ -150,3 +152,11 @@ So instead of pulling everything manually, use the bundled update script to do t
```shell
$ ./update-docker.sh
```
## 5. Remove anonymous volumes
The devilbox is not yet at a feature-ready stable release and volumes mounts might change from release to release until version 1.0 will be released. This can cause errors during startup. To solve those issues after updating, you should remove all anonymouse volumes with the following command:
```shell
$ docker-compose rm
```