Skip to content

Commit d3bca8d

Browse files
committed
docs: explain how this is intended to be used
1 parent ec8775a commit d3bca8d

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

.gitignore

Whitespace-only changes.

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# docker-php
2+
3+
Docker PHP is a collection of services and containers intended to be pulled into a project as a submodule or subtree. It contains all the services necessary to serve a modern Laravel application for development purposes. It's very similar to what Laravel Sail provides but is further configured to suit my personal needs and preferences and comes with a dedicated Nginx container to run your application in.
4+
5+
Additionally, this repository contains a production ready FrankenPHP container that is preconfigured to automatically request SSL certificates using a Cloudflare DNS challenge. See the `frankenphp/` subdirectory.
6+
7+
## Configuration
8+
9+
1. Run `git submodule add https://github.com/99linesofcode/docker-php.git docker` from your application root;
10+
1. Copy the `docker-compose.yml` to the application root;
11+
1. Configure the environment variables defined in the `.env.example` file in your `.env` in the application root;
12+
1. Run `docker compose up -d` to spin up your development environment.
13+
14+
Almost all the relevant configuration is done in/from the `docker-compose.yml` file. By default the devcontainer is disabled.
15+
16+
## Contributing to docker-base
17+
18+
Thank you for considering contributing to docker-base. Please review our [Contribution Guidelines](https://github.com/99linesofcode/.github/blob/main/.github/CONTRIBUTING.md).
19+
20+
## Code of Conduct
21+
22+
In order to ensure that the community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/99linesofcode/.github?tab=coc-ov-file).
23+
24+
## Security Vulnerabilities
25+
26+
Please review [our security policy](https://github.com/99linesofcode/.github?tab=security-ov-file) on how to report security vulnerabilities.
27+
28+
## License
29+
30+
docker-base is open-sourced software licensed under the [MIT license](https://github.com/99linesofcode/docker-base?tab=MIT-1-ov-file)

0 commit comments

Comments
 (0)