Parcourir la source

readme updates

xcad2k il y a 4 ans
Parent
commit
6739050ff9
3 fichiers modifiés avec 15 ajouts et 15 suppressions
  1. 6 2
      README.md
  2. 7 8
      docker-compose/portainer/README.md
  3. 2 5
      docker-compose/traefik/README.md

+ 6 - 2
README.md

@@ -1,15 +1,19 @@
 # Boilerplates for Automation and Deployment
+
 These are my templates and configurations I use in various projects and deployment scenarios. They are based on automation and deployment tools such as [Ansible](https://github.com/xcad2k/boilerplates/tree/main/ansible), [Docker](https://github.com/xcad2k/boilerplates/tree/main/docker-compose), [Terraform](https://github.com/xcad2k/boilerplates/tree/main/terraform), and much more.
 
 I created them as free resources to be extended by you according to your specific use cases. If you're searching for detailed, in-depth tutorials on some tools or templates, check out my YouTube Channel: [The Digital Life](https://www.youtube.com/channel/UCZNhwA1B5YqiY1nLzmM0ZRg).
 
 ### Warning
-Please beware that products can change over time. I do my best to keep up with the latest changes and releases, but please understand that this won’t always be the case.
+
+⚠️ Please beware that products can change over time. I do my best to keep up with the latest changes and releases, but please understand that this won’t always be the case.
 
 ### Contribution and Support
-If you’d like to contribute to this project, reach out to me on social media or [Discord](https://discord.gg/bz2SN7d), or create a pull request for the necessary changes. 
+
+🤝 If you’d like to contribute to this project, reach out to me on social media or [Discord](https://discord.gg/bz2SN7d), or create a pull request for the necessary changes. 
 
 ## Sections
+
 [Ansible](https://github.com/xcad2k/boilerplates/tree/main/ansible) - IT automation tool to configure systems, deploy software, and orchestrate IT tasks.
 
 [Docker](https://github.com/xcad2k/boilerplates/tree/main/docker-compose) - Package applications as portable container images to run in any environment.

+ 7 - 8
docker-compose/portainer/README.md

@@ -1,9 +1,8 @@
-# Installing
+# Installation
 
 ## Manage local environment
 
 Allows Portainer to manage the local Docker Environment
-
 ```yaml
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
@@ -12,23 +11,23 @@ Allows Portainer to manage the local Docker Environment
 ## Data Persistence
 
 Storing Data in a `portainer-data` volume on docker
-
 ```yaml
     volumes:
       - portainer-data:/data
 ```
-
-# Best-Practices
+# Best-Practices & Post-Installation
 
 ### (Option 1): Upload custom certificates
 
 - [ ] Upload your custom certificates
 - [ ] Force HTTPS only
 - [ ] Expose Port `9443`
-
 ![Force HTTPS Only and Certificates](https://imagedelivery.net/yG07CmQlapjZ95zez0HJMA/5cf8fa46-d548-4f0b-570e-0caf8ee6d700/medium)
 
-
 ### (Option 2): Use a Reverse Proxy
 
-Use a Reverse Proxy to securely expose administrative services.
+- [] Use a Reverse Proxy to securely expose administrative services.
+
+# Additional Referfences
+
+[Official Portainer Documentation](https://docs.portainer.io/)

+ 2 - 5
docker-compose/traefik/README.md

@@ -1,7 +1,4 @@
-# Installing
-
-
-# Customization
+# Installation
 
 ## Data Persistence
 ... Storing Data in the `/etc/traefik` directory on the host, passing through...
@@ -24,7 +21,7 @@ tls:
 Replace the `/etc/traefik/certs/cert.pem` with your certificate file, and the `/etc/traefik/certs/cert-key.pem` with your certificate key.
 
 
-# Best-Practices
+# Best-Practices & Post-Installation
 
 ```yaml
 providers: