Update z1/README.md
This commit is contained in:
parent
fc1533410a
commit
da9ad67534
18
z1/README.md
18
z1/README.md
@ -1,7 +1,7 @@
|
|||||||
# DOCKER APP DOCUMENTATION
|
# DOCKER APP DOCUMENTATION
|
||||||
## AUTHOR : Somangsu MUkherjee
|
## AUTHOR : Somangsu Mukherjee
|
||||||
|
|
||||||
1. Conditions for Deployment
|
**1. Conditions for Deployment**
|
||||||
|
|
||||||
The application requires the following software:
|
The application requires the following software:
|
||||||
|
|
||||||
@ -10,7 +10,7 @@ The application requires the following software:
|
|||||||
- Bash shell (for .sh scripts) or PowerShell/CMD (Windows)
|
- Bash shell (for .sh scripts) or PowerShell/CMD (Windows)
|
||||||
- Internet connection (to download Docker images)
|
- Internet connection (to download Docker images)
|
||||||
|
|
||||||
2. Application Description
|
**2. Application Description**
|
||||||
|
|
||||||
This is a simple multi-container web application.
|
This is a simple multi-container web application.
|
||||||
|
|
||||||
@ -23,7 +23,7 @@ Retrieve and display all stored names
|
|||||||
|
|
||||||
The application demonstrates communication between multiple services using Docker.
|
The application demonstrates communication between multiple services using Docker.
|
||||||
|
|
||||||
3. Virtual Networks and Volumes
|
**3. Virtual Networks and Volumes**
|
||||||
Virtual Network
|
Virtual Network
|
||||||
|
|
||||||
Docker Compose automatically creates a virtual network for communication between services.
|
Docker Compose automatically creates a virtual network for communication between services.
|
||||||
@ -37,7 +37,7 @@ pgdata is used for persistent database storage
|
|||||||
It is mounted to /var/lib/postgresql/data inside the PostgreSQL container
|
It is mounted to /var/lib/postgresql/data inside the PostgreSQL container
|
||||||
This ensures that data is preserved even if containers are stopped or restarted
|
This ensures that data is preserved even if containers are stopped or restarted
|
||||||
|
|
||||||
4. Container Configuration
|
**4. Container Configuration**
|
||||||
Frontend
|
Frontend
|
||||||
Image: nginx:latest
|
Image: nginx:latest
|
||||||
Port: 8080 (mapped to container port 80)
|
Port: 8080 (mapped to container port 80)
|
||||||
@ -73,7 +73,7 @@ Purpose: Web interface for managing the PostgreSQL database which stores all the
|
|||||||
| adminer | Web interface for managing the database |
|
| adminer | Web interface for managing the database |
|
||||||
|
|
||||||
|
|
||||||
6. Application Control
|
**6. Application Control**
|
||||||
|
|
||||||
Prepare Application:
|
Prepare Application:
|
||||||
To prepare the application, the command ./prepare-app.sh is run in wsl which builds images and prepares the environment for execution.
|
To prepare the application, the command ./prepare-app.sh is run in wsl which builds images and prepares the environment for execution.
|
||||||
@ -87,7 +87,7 @@ to stop all the currently running containers without deleting data, ./stop-app.s
|
|||||||
Remove Application
|
Remove Application
|
||||||
./remove-app.sh stops all containers and removes volumes, networks, and all resources.
|
./remove-app.sh stops all containers and removes volumes, networks, and all resources.
|
||||||
|
|
||||||
7. Accessing the Application
|
**7. Accessing the Application**
|
||||||
Main Web Application can be accessed on any browser locally running on http://localhost:8080
|
Main Web Application can be accessed on any browser locally running on http://localhost:8080
|
||||||
|
|
||||||
The database Interface (Adminer) can be accessed similarly at http://localhost:8081
|
The database Interface (Adminer) can be accessed similarly at http://localhost:8081
|
||||||
@ -100,14 +100,14 @@ Username: user
|
|||||||
Password: password
|
Password: password
|
||||||
Database: mydb
|
Database: mydb
|
||||||
|
|
||||||
8. Used Resources
|
**8. Used Resources**
|
||||||
Docker official documentation
|
Docker official documentation
|
||||||
Docker Compose documentation
|
Docker Compose documentation
|
||||||
Node.js documentation
|
Node.js documentation
|
||||||
PostgreSQL documentation
|
PostgreSQL documentation
|
||||||
Nginx documentation
|
Nginx documentation
|
||||||
|
|
||||||
9. Use of Artificial Intelligence
|
**9. Use of Artificial Intelligence**
|
||||||
|
|
||||||
Artificial intelligence tools such as chatGPT and Claude were used as a support tool during development for understanding docker concepts and debugging scripts. Some configuration issues were also fixed by referring to AI. All implementation, testing, and integration were performed independently.
|
Artificial intelligence tools such as chatGPT and Claude were used as a support tool during development for understanding docker concepts and debugging scripts. Some configuration issues were also fixed by referring to AI. All implementation, testing, and integration were performed independently.
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user