master - updated readme

Author: ionghitun

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Ion Ghițun
+Copyright (c) 2025 Ion Ghițun
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,18 +1,55 @@
-## Portainer with docker-compose
+# Portainer Docker Stack
 
-### Install notes
+This project provides a Docker Compose setup for running Portainer behind nginx and nginx-proxy.
 
-- copy `scripts/.env.example` to `scripts/.env` and edit it to match your settings
-- change other env variables to your needs
-- if necessary modify `scripts/nginx/custom.conf` to match you `DOMAIN_HOST`
-- run `sh scripts/start.sh` to start the project
-- run `sh scripts/stop.sh` to stop the project
-- run `sh scripts/build.sh` to build or rebuild the project
-- run `sh scripts/restart.sh` to restarts container
-- navigate to `DOMAIN_HOST` to see portainer info
+## Prerequisites
 
-## Dependencies
+- Docker Engine & Docker Compose
+- Git
+- Linux or Windows WSL2
+- A working nginx-proxy network (see [nginx-proxy setup](https://github.com/ionghitun/nginx-proxy))
 
-- `nginx-proxy` - https://github.com/ionghitun/nginx-proxy
+## Installation
 
-_Happy Coding!_
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/ionghitun/portainer.git
+   cd portainer
+   ```
+2. **Copy and configure environment variables**
+   ```bash
+   cp scripts/.env.example scripts/.env
+   # Edit other variables in scripts/.env as needed
+   ```
+3. **Update virtual host configuration**
+    - Modify `scripts/nginx/custom.conf` to match your `DOMAIN_HOST`.
+4. **Start the project**
+   ```bash
+   sh scripts/start.sh
+   ```
+5. **Access Portainer**
+    - Open your browser and navigate to your configured `DOMAIN_HOST` (e.g., https://portainer.dev.local).
+
+## Available scripts
+
+```bash
+./scripts/start.sh    # Start the containers
+./scripts/down.sh     # Stop the containers
+./scripts/build.sh    # Build or rebuild the containers
+./scripts/restart.sh  # Restart the containers
+```
+
+## Troubleshooting
+
+- **Docker Issues**: For older versions you might want to remove `COMPOSE_BAKE` from `.env`.
+- **Docker Compose Issues**: Please update and ensure you can use `docker compose`, not old version `docker-compose`
+
+## License
+
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions are welcome! Please open issues or submit pull requests following the repository guidelines.
+
+_Happy Coding_

scripts/.env.example

@@ -1,3 +1,9 @@
+#name of the stack
+COMPOSE_PROJECT_NAME=portainer
+
+#for better build performance
+COMPOSE_BAKE=true
+
 #images versions to use
 NGINX_VERSION=latest
 PORTAINER_VERSION=latest

scripts/build.sh

@@ -1,24 +1,29 @@
 #!/bin/sh
-echo "*** Rebuild start ***"
-
 cd scripts || exit
 
-# Prompt user for input
-echo "Want to update images before rebuild? (y/n) [default: y]: "
+echo "Want to update images before rebuilding? (y/n) [default: y]: "
 read UPDATE_IMAGES
 UPDATE_IMAGES=${UPDATE_IMAGES:-y}
 
-# Check user input in a POSIX-compatible way
 if [ "$UPDATE_IMAGES" = "y" ] || [ "$UPDATE_IMAGES" = "Y" ]; then
+    echo
+    echo "===== Updating image... ====="
+    echo
+
     NGINX_VERSION=$(grep -oP '^NGINX_VERSION=\K.*' .env)
     PORTAINER_VERSION=$(grep -oP '^PORTAINER_VERSION=\K.*' .env)
 
     docker pull "nginx:$NGINX_VERSION"
     docker pull "portainer/portainer-ce:$PORTAINER_VERSION"
 fi
 
-echo "*** Rebuilding application ***"
-docker compose -p portainer build --no-cache
-docker compose -p portainer up -d
+echo
+echo "===== Building and starting containers... ====="
+echo
+
+docker compose build --no-cache
+docker compose up -d
 
-echo "*** Rebuild ended ***"
+echo
+echo "===== Done! ====="
+echo

scripts/down.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+echo
+echo "===== Stopping... ====="
+echo
+
+cd scripts || exit
+docker compose down
+
+echo
+echo "===== Done! ====="
+echo

scripts/restart.sh

@@ -1,8 +1,11 @@
 #!/bin/sh
-echo "*** Restarting... ***"
+echo
+echo "===== Restarting... ====="
+echo
 
 cd scripts || exit
+docker compose restart
 
-docker compose -p portainer restart
-
-echo "*** Restarted ***"
+echo
+echo "===== Done! ====="
+echo

scripts/start.sh

@@ -1,8 +1,11 @@
 #!/bin/sh
-echo "*** Starting... ***"
+echo
+echo "===== Starting... ====="
+echo
 
 cd scripts || exit
+docker compose up -d
 
-docker compose -p portainer up -d
-
-echo "*** Started ***"
+echo
+echo "===== Done! ====="
+echo