https://github.com/phlearning/inception
Ce projet a pour but d'approfondir vos connaissances en vous faisant utiliser Docker. Vous allez virtualiser plusieurs images Docker en les créant dans votre nouvelle machine virtuelle personnelle.
https://github.com/phlearning/inception
Last synced: 5 months ago
JSON representation
Ce projet a pour but d'approfondir vos connaissances en vous faisant utiliser Docker. Vous allez virtualiser plusieurs images Docker en les créant dans votre nouvelle machine virtuelle personnelle.
- Host: GitHub
- URL: https://github.com/phlearning/inception
- Owner: phlearning
- Created: 2024-02-13T13:33:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T09:09:46.000Z (about 2 years ago)
- Last Synced: 2025-07-24T14:03:18.945Z (12 months ago)
- Language: Dockerfile
- Size: 1.86 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ft_inception
## Table of Contents
- [ft\_inception](#ft_inception)
- [Table of Contents](#table-of-contents)
- [About ](#about-)
- [What is docker ?](#what-is-docker-)
- [Setup Details](#setup-details)
- [Getting Started ](#getting-started-)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Usage ](#usage-)
- [Make commands](#make-commands)
- [Acknowledgements ](#acknowledgements-)
This project aims to broaden your knowledge of system administration by using Docker. You will virtualize several Docker images, creating them in your new personal virtual machine. **We cannot pull ready-made Docker images**
> *"You also have to write your own Dockerfiles, one per service. The Dockerfiles must be called in your docker-compose.yml by your Makefile. It means you have to build yourself the Docker images of your project. It is then forbidden to pull ready-made Docker images, as well as using services such as DockerHub(Alpine/Debian being excluded from this rule)."* - from the subject
### What is docker ?
- Docker is a platform that enables developers to create, deploy, and run applications in isolated environments called containers.
- Containers package an application and its dependencies, ensuring consistency across different development and production environments.
- By using Docker, developers can easily manage application components, streamline workflows, and improve scalability and performance through efficient resource utilization.
### Setup Details
- NGINX Container: Must support TLSv1.2 or TLSv1.3 only.
- WordPress Container: Includes WordPress and php-fpm, configured and installed (without NGINX).
- MariaDB Container: MariaDB only (without NGINX).
- Volumes:
- One for the WordPress database.
- One for the WordPress website files.
- Networking: Create a Docker network to connect all containers.
- Container Management: Containers must restart automatically in case of a crash.
> PS: You should never actually put an environment file (.env) in public or in your github. As it is usually filled with your api keys or access information.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
* Docker
* Go to https://docs.docker.com/get-docker/ and follow the instructions corresponding to your OS.
* Make (to launch Makefile)
* Either Mac or Linux (if not then there is a need to change the home path in the makefile)
### Installing
1. Clone the repo
```
git clone https://github.com/phlearning/inception.git
```
2. Download docker and docker compose if needed (https://docs.docker.com/get-docker/)
3. Adjust the Makefile
- Change the login var to your computer's user
```
To get your user for the makefile:
`echo ${HOME}`
You should get something like this:
`/home/pvong` - the pvong here is my user
Or you can just do:
`echo ${USER}`
```
4. Change the `.env` file to your liking
- Note: If you want to run locally change the domains to localhost in the .env file. If not then adjust your `/etc/hosts`
- If you are in a Virtual Machine you can safely adjust the `/etc/hosts` file to reroute `127.0.0.1` to your domain specified in the .env file.
5. Launch with `make` in the cli while inside the project folder.
1. Use `make` to launch the application
2. Open your web browser and navigate to `https://localhost:443/` or the domain specified (https://domain:443/), I insist on the https as there is no redirection from http to https in my nginx config. You should now see a wordpress website.
3. Adjust the `.env` file if you wish to change the user and admin access.
### Make commands
- `make`: Create the folders, build the images and run the containers.
- `make run-detached`: Run the containers while still accessing the terminal.
- `make down`: To stop and remove the containers.
- `make stop`: To stop the containers, use `make run` to rerun if needed.
- `make clear`: To delete any containers, images, docker networks and volumes.
- `make clean`: To prune any containers and images not in use or named after the given var NAME in the makefile (inception)
- `make fclean`: Similar to make clean but also clean the volumes.
- `make delete-volumes`: To clean only the volumes.
- `make status`: To check the status of the containers, images, volumes and network.
## Acknowledgements
- Help throughout the whole project:
- [FXC-ai](https://github.com/FXC-ai/Inception)'s help (helped in person 🏆)
- [Killian-Morin](https://github.com/Killian-Morin/42-Inception)'s help (do take a look at their readme for the sources)
- https://tuto.grademe.fr/inception/ (🌟 recommend to start with this)
- https://github.com/vbachele/Inception (🐐 really good)
- Docker:
- https://docs.docker.com/
- https://www.youtube.com/watch?v=gAkwW2tuIqE
- Nginx:
- https://docs.nginx.com/
- http://nginx.org/en/docs/beginners_guide.html
- MariaDB:
- https://mariadb.com/kb/en/training-tutorials/
- Wordpress:
- Refer to https://github.com/vbachele/Inception