4lt/docker-compose-cookbooks
1
0
Fork 0
mirror of https://github.com/nickyeoman/docker-compose-cookbooks.git synced 2026-09-03 18:36:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleaned up readme and documentation

Browse Source
This commit is contained in:
nick
2024-07-21 18:35:02 -07:00
parent 2bd83096a8
commit 68cee73585
6 changed files with 118 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -10
View File
@@ -1,25 +1,30 @@
# Nick Yeoman's Collection of Docker compose files
<div align="center">
<img src="_assets/heading.svg" alt="Description of SVG" width="800"/>
</div>
Author: [Nick Yeoman](https://www.nickyeoman.com/).
👤 Author: [Nick Yeoman](https://www.nickyeoman.com/).
These cookbooks are created with the intent of using Docker's extend feature. This way, you can run multiple containers in different domains but still have only one file to update.
## 🤔 Assumptions
These compose files make a few assumptions:
1. You are only running on one host.
2. You are using Nginx Proxy Manager (although most have redundant port access).
3. Volumes are stored in the project folder under "data", git ignored and backed up externally.
## 📚 Workflow
The intended workflow is as follows:
1. Clone the repository locally ```git clone git@github.com:nickyeoman/docker-compose-cookbooks.git /git-repos/docker-compose-cookbooks```
2. Create a project directory, usually by domain ```mkdir /projects/domainname-com```
3. Create a .env file in the project directory ```touch .env```
4. Add the COOKBOOK Variable to the project's env file: ```COOKBOOK=/git-repos/docker-compose-cookbooks```
5. Create a .gitignore file in the project directory and ignore "data/"
6. Create a docker-compose.yml file in the project directory with the external code given in the README file in the container folder.
1. Clone the cookbook repository locally ```git clone git@github.com:nickyeoman/docker-compose-cookbooks.git /git-repos/docker-compose-cookbooks```
2. Change to the directory ```cd /git-repos/docker-compose-cookbooks```
3. Run the helper cli wizard: ```bash helper.bash```
4. Commit the new project to git.
## Example
You will likely want to override a number of things in the project folder, such as networks.
## 🔍 Example Result
Here is an example of how your project's docker-compose file might look:
@@ -39,4 +44,10 @@ services:
- .env
networks:
- proxy
```
```
with the .env file:
```text
COOKBOOK=/git-repos/docker-compose-cookbooks
```