Skip to content

Commit 17ea7b3

Browse files
author
Zuohuadong
committed
update
1 parent eefd04d commit 17ea7b3

104 files changed

Lines changed: 2756 additions & 13899 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at mahmoud@zalt.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### First off, thanks for taking the time to contribute!
2+
3+
For the contribution guide [click here](http://laradock.io/contributing/).

.github/ISSUE_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Info:
2+
- Docker version (`$ docker --version`):
3+
- Laradock commit (`$ git rev-parse HEAD`):
4+
- System info (Mac, PC, Linux):
5+
- System info disto/version:
6+
7+
### Issue:
8+
<!--- What seems to be wrong? -->
9+
_____
10+
11+
### Expected behavior:
12+
<!--- What should happen instead? -->
13+
_____
14+
15+
### Reproduce:
16+
<!--- How can we reproduce the error? -->
17+
_____
18+
19+
### Relevant Code:
20+
21+
```
22+
// place a code sample here
23+
```

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!--- Thank you for contributing to Laradock -->
2+
3+
##### I completed the 3 steps below:
4+
5+
- [] I've read the [Contribution Guide](http://laradock.io/contributing).
6+
- [] I've updated the **documentation**. (refer to [this](http://laradock.io/contributing/#update-the-documentation-site) for how to do so).
7+
- [] I enjoyed my time contributing and making developer's life easier :)

README-zh.md renamed to .github/README-zh.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,20 +64,23 @@ Laradock 努力简化创建开发环境过程。
6464
让我们了解使用它安装 `NGINX`, `PHP`, `Composer`, `MySQL``Redis`,然后运行 `Laravel`
6565

6666
1. 将 Laradock 放到你的 Laravel 项目中:
67-
6867
```bash
6968
git clone https://github.com/laradock/laradock.git
7069
```
7170

72-
2. 进入 Laradock 目录,然后运行这些容器。
71+
2. 进入 Laradock 目录
72+
```bash
73+
cp env-example .env
74+
```
7375

76+
3. 运行这些容器。
7477
```bash
7578
docker-compose up -d nginx mysql redis
7679
```
7780

78-
3. 打开你的 `.env` 文件,然后设置 `mysql``DB_HOST``redis``REDIS_HOST`
81+
4. 打开你的Laravel 项目的 `.env` 文件,然后设置 `mysql``DB_HOST``redis``REDIS_HOST`
7982

80-
4. 打开浏览器,访问 localhost:
83+
5. 打开浏览器,访问 localhost:
8184

8285
<a name="features"></a>
8386
### 特点
@@ -461,7 +464,7 @@ REDIS_HOST=redis
461464
],
462465
```
463466

464-
3 - 启用 Redis 缓存或者开启 Session 管理也在 `.env` 文件中用 `redis` 替换默认 `file` 设置 `CACHE_DRIVER` 和 `SESSION_DRIVER`
467+
3 - 启用 Redis 缓存或者开启 Session 管理也在 `.env` 文件中用 `redis` 替换默认 `file` 设置 `CACHE_DRIVER` 和 `SESSION_DRIVER`
465468

466469
```env
467470
CACHE_DRIVER=redis

.github/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<p align="center">
2+
<img src="https://s19.postimg.org/jblfytw9f/laradock-logo.jpg" alt="Laradock Logo"/>
3+
</p>
4+
5+
<p align="center">A Docker PHP development environment that facilitates running PHP Apps on Docker</p>
6+
7+
<p align="center">
8+
<a href="https://travis-ci.org/laradock/laradock"><img src="https://travis-ci.org/laradock/laradock.svg?branch=master" alt="Build status"></a>
9+
<a href="https://github.com/laradock/laradock/stargazers"><img src="https://img.shields.io/github/stars/laradock/laradock.svg" alt="GitHub stars"></a>
10+
<a href="https://github.com/laradock/laradock/network"><img src="https://img.shields.io/github/forks/laradock/laradock.svg" alt="GitHub forks"></a>
11+
<a href="https://github.com/laradock/laradock/issues"><img src="https://img.shields.io/github/issues/laradock/laradock.svg" alt="GitHub issues"></a>
12+
<a href="https://raw.githubusercontent.com/laradock/laradock/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="GitHub license"></a>
13+
<a href="http://laradock.io/contributing"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat" alt="contributions welcome"></a>
14+
</p>
15+
16+
<h4 align="center" style="color:#7d58c2">Use Docker First And Learn About It Later</h4>
17+
18+
<p align="center">
19+
<a href="https://zalt.me"><img src="http://forthebadge.com/images/badges/built-by-developers.svg" alt="forthebadge" width="240" ></a>
20+
</p>
21+
22+
23+
---
24+
25+
<p align="center">
26+
<a href="http://laradock.io">
27+
<img src="https://s19.postimg.org/ecnn9vdw3/Screen_Shot_2017-08-01_at_5.08.54_AM.png" width=300px" alt="Laradock Docs"/>
28+
</a>
29+
</p>
30+
31+
32+
## Credits
33+
34+
- [Mahmoud Zalt](https://github.com/Mahmoudz) @mahmoudz | [Twitter](https://twitter.com/Mahmoud_Zalt) | [Site](http://zalt.me)
35+
- [Bo-Yi Wu](https://github.com/appleboy) @appleboy | [Twitter](https://twitter.com/appleboy)
36+
- [Philippe Trépanier](https://github.com/philtrep) @philtrep
37+
- [Mike Erickson](https://github.com/mikeerickson) @mikeerickson
38+
- [Dwi Fahni Denni](https://github.com/zeroc0d3) @zeroc0d3
39+
- [Thor Erik](https://github.com/thorerik) @thorerik
40+
- [Winfried van Loon](https://github.com/winfried-van-loon) @winfried-van-loon
41+
- [TJ Miller](https://github.com/sixlive) @sixlive
42+
- [Yu-Lung Shao (Allen)](https://github.com/bestlong) @bestlong
43+
- [Milan Urukalo](https://github.com/urukalo) @urukalo
44+
- [Vince Chu](https://github.com/vwchu) @vwchu
45+
- Join Us.
46+
47+
## License
48+
49+
[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE)

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
/logs
33
/data
44
.env
5-
/.project
5+
/.project
6+
.docker-sync

.travis.yml

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,48 @@ services:
44
- docker
55

66
env:
7-
matrix:
8-
- PHP_VERSION=56
9-
- PHP_VERSION=70
10-
- PHP_VERSION=71
11-
- HUGO_VERSION=0.19
7+
matrix:
8+
- PHP_VERSION=56 BUILD_SERVICE="applications blackfire minio percona nginx caddy apache2 mysql mariadb phpmyadmin postgres postgres-postgis pgadmin neo4j mongo redis"
9+
- PHP_VERSION=70 BUILD_SERVICE="applications blackfire minio percona nginx caddy apache2 mysql mariadb phpmyadmin postgres postgres-postgis pgadmin neo4j mongo redis"
10+
- PHP_VERSION=71 BUILD_SERVICE="applications blackfire minio percona nginx caddy apache2 mysql mariadb phpmyadmin postgres postgres-postgis pgadmin neo4j mongo redis"
11+
12+
- PHP_VERSION=56 BUILD_SERVICE=workspace
13+
- PHP_VERSION=70 BUILD_SERVICE=workspace
14+
- PHP_VERSION=71 BUILD_SERVICE=workspace
15+
16+
- PHP_VERSION=56 BUILD_SERVICE=php-fpm
17+
- PHP_VERSION=70 BUILD_SERVICE=php-fpm
18+
- PHP_VERSION=71 BUILD_SERVICE=php-fpm
19+
20+
- PHP_VERSION=56 BUILD_SERVICE="php-worker hhvm"
21+
- PHP_VERSION=70 BUILD_SERVICE="php-worker hhvm"
22+
- PHP_VERSION=71 BUILD_SERVICE="php-worker hhvm"
23+
24+
- PHP_VERSION=56 BUILD_SERVICE=mssql
25+
- PHP_VERSION=70 BUILD_SERVICE=mssql
26+
- PHP_VERSION=71 BUILD_SERVICE=mssql
27+
28+
- PHP_VERSION=56 BUILD_SERVICE=rethinkdb
29+
- PHP_VERSION=70 BUILD_SERVICE=rethinkdb
30+
- PHP_VERSION=71 BUILD_SERVICE=rethinkdb
31+
32+
- PHP_VERSION=56 BUILD_SERVICE=aerospike
33+
- PHP_VERSION=70 BUILD_SERVICE=aerospike
34+
- PHP_VERSION=71 BUILD_SERVICE=aerospike
35+
36+
- PHP_VERSION=56 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog selenium jenkins proxy proxy2 balancer"
37+
- PHP_VERSION=70 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog selenium jenkins proxy proxy2 balancer"
38+
- PHP_VERSION=71 BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq adminer elasticsearch certbot mailhog selenium jenkins proxy proxy2 balancer"
39+
40+
- HUGO_VERSION=0.20.2
41+
42+
# Installing a newer Docker version
43+
before_install:
44+
- curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
45+
- sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
46+
- sudo apt-get update
47+
- sudo apt-get -y install docker-ce
48+
- docker version
1249

1350
script: ./travis-build.sh
1451

DOCUMENTATION/config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ title = "Laradock"
55
theme = "hugo-material-docs"
66
metadataformat = "yaml"
77
canonifyurls = true
8+
uglyurls = true
89
# Enable Google Analytics by entering your tracking id
910
googleAnalytics = "UA-37514928-9"
1011

DOCUMENTATION/content/contributing/index.md

Lines changed: 60 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ weight: 7
55
---
66

77

8-
Your contribution is more than welcome.
9-
10-
## I have a Question/Problem
8+
## Have a Question
119

1210
If you have questions about how to use Laradock, please direct your questions to the discussion on [Gitter](https://gitter.im/Laradock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Question`) And you can still seek help on Gitter for it.
1311

14-
## I found an Issue
12+
13+
14+
## Found an Issue
15+
1516
If have an issue or you found a typo in the documentation, you can help us by
16-
opnening an [Issue](https://github.com/laradock/laradock/issues).
17+
opening an [Issue](https://github.com/laradock/laradock/issues).
1718

1819
**Steps to do before opening an Issue:**
1920

@@ -23,18 +24,18 @@ opnening an [Issue](https://github.com/laradock/laradock/issues).
2324

2425
If your issue appears to be a bug, and hasn't been reported, then open a new issue.
2526

26-
*This Help us to maximize the effort we can spend fixing issues and adding new
27+
*This helps us maximize the effort we can spend fixing issues and adding new
2728
features, by not reporting duplicate issues.*
2829

2930

30-
## I want a Feature
31-
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Feature Suggestion`). If you would like to implement a new feature then consider submitting a Pull Request yourself.
3231

32+
## Want a Feature
33+
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Feature Suggestion`). If you would like to implement a new feature then consider submitting a Pull Request yourself.
3334

3435

3536

3637

37-
## I want to update the Documentation (Site)
38+
## Update the Documentation (Site)
3839

3940
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
4041

@@ -47,9 +48,8 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
4748
> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
4849
4950

50-
<br>
5151

52-
### To Host the website locally
52+
### Host the documentation locally
5353

5454
1. Install [Hugo](https://gohugo.io/) on your machine.
5555
2. Edit the `DOCUMENTATION/content`.
@@ -59,33 +59,70 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
5959

6060

6161

62-
## How to support new Software (Add new Container)
62+
## Support new Software (Add new Container)
6363

64-
* Create folder with the software name.
64+
* Fork the repo and clone the code.
6565

66-
* Add a `Dockerfile`, write your code there.
66+
* Create folder as the software name (example: `mysql` - `nginx`).
6767

68-
* You may add additional files in the software folder.
68+
* Add your `Dockerfile` in the folder "you may add additional files as well".
6969

7070
* Add the software to the `docker-compose.yml` file.
7171

72-
* Make sure you follow our commenting style.
72+
* Make sure you follow the same code/comments style.
73+
74+
* Add the environment variables to the `env-example` if you have any.
75+
76+
* **MOST IMPORTANTLY** updated the `Documentation`, add as much information.
7377

74-
* Add the software in the `Documentation`.
78+
* Submit a Pull Request, to the `master` branch.
7579

76-
## Edit existing Software (Edit a Container)
7780

78-
* Open the software (container) folder.
7981

80-
* Edit the files you want to update.
82+
## Edit supported Software (Edit a Container)
8183

82-
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
83-
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
84+
* Fork the repo and clone the code.
85+
86+
* Open the software (container) folder (example: `mysql` - `nginx`).
87+
88+
* Edit the files.
8489

8590
* Make sure to update the `Documentation` in case you made any changes.
8691

92+
* Submit a Pull Request, to the `master` branch.
93+
94+
95+
96+
97+
## Edit Base Image
98+
99+
* Open any dockerfile, copy the base image name (example: `FROM phusion/baseimage:latest`).
100+
101+
* Search for the image in the [Docker Hub](https://hub.docker.com/search/) and find the source..
102+
103+
*Most of the image in Laradock are offical images, these projects live in other repositories and maintainer by other orgnizations.*
104+
105+
**Note:** Laradock has two base images for (`Workspace` and `php-fpm`, mainly made to speed up the build time on your machine.
106+
107+
* Find the dockerfiles, edit them and submit a Pull Request.
108+
109+
* When updating a Laradock base image (`Workspace` or `php-fpm`), ask a project maintainer "Admin" to build a new image after your PR is merged.
110+
111+
**Note:** after the base image is updated, every dockerfile that uses that image, needs to update his base image tag to get the updated code.
112+
113+
114+
115+
116+
117+
118+
119+
120+
<br>
121+
122+
123+
87124

88-
## Pull Request
125+
## Submit Pull Request Instructions
89126

90127
### 1. Before Submitting a Pull Request (PR)
91128

0 commit comments

Comments
 (0)