Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mcombeau/inception

A 42 school project about Docker and Docker-Compose: create a small docker network with separate containers for NginX, Wordpress and MariaDB.
https://github.com/mcombeau/inception

42-inception 42born2code 42cursus 42school configuration docker docker-compose dockerfile mariadb nginx wordpress

Last synced: 2 months ago
JSON representation

A 42 school project about Docker and Docker-Compose: create a small docker network with separate containers for NginX, Wordpress and MariaDB.

Host: GitHub
URL: https://github.com/mcombeau/inception
Owner: mcombeau
Created: 2023-06-03T12:05:40.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-10-16T14:55:24.000Z (over 1 year ago)
Last Synced: 2023-10-17T05:54:18.715Z (over 1 year ago)
Topics: 42-inception, 42born2code, 42cursus, 42school, configuration, docker, docker-compose, dockerfile, mariadb, nginx, wordpress
Language: Shell
Homepage: https://www.codequoi.com/
Size: 42 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Inception

inception 42 project badge

A 42 project aimed at learning Docker and Docker-compose. This project asks us to create a small network of 3 Docker containers, one containing Nginx, one containing Wordpress and the third containing MariaDB. All three must work together over the Docker network to display a local website.

> This project has been archived in the state it was in at the time of evaluation.

## Status
Finished 06/10/2023. Grade: 100%

## Usage

Launching this project requires a bit of setup:

* Clone this repository and `cd` into it.
* In the `srcs` folder, there is an `ExampleEnvFile` that must be filled out and saved into `srcs/.env`
* The Makefile has a `login` variable that should be edited to reflect your 42 school login

Once these steps are complete, you can use `make` to build and launch the docker containers.

The website should be viewable at the adresses `https://localhost` or `http://login.42.fr` (replacing your login with the value in the Makefile variable).

## Project Notes

### Viewing Docker Images, Containers, Volumes and Networks

* Show Docker images: `docker images`
* Show Docker containers: `docker ps` (add `-a` option to view stopped/exited containers)
* Show Docker volumes: `docker volume ls` (`docker volume inspect ` to view more information about the volume)
* Show Docker networks: `docker network ls`

### Useful Commands for Debugging Docker Containers
* Show logs: `docker-compose logs` (add `--follow ` option to only see that container's logs)
* Run a container in interactive mode: `docker run -it `
* Execute a command inside a running container: `docker exec `
* Execute a command inside a running container in interactive mode: `docker exec -it `
* Execute an interactive shell inside a running container: `docker exec -it sh` (This shows that Docker containers are not secure, since we can easily get a shell as root)

### Dockerfile Basic Commands
* `FROM`: Downloads an image to use as the container's base. Here we are using Alpine:3.18.
* `RUN`: Runs the specified command during the building process. Useful for installing binaries for later use.
* `COPY`: Copy a file from host machine to the future docker container. Useful for loading custom configuration files.
* `EXPOSE`: Expose a port so that it is accessible from outside the Docker network.
* `ENTRYPOINT [ "command", "args"]`: The command to run at conainer startup.

### Useful Resources

Docker:

* [Docker Curriculum](https://docker-curriculum.com/)
* [Dockerfile Reference](https://docs.docker.com/engine/reference/builder/)
* [How to Debug a Docker Compose Build](https://www.matthewsetter.com/basic-docker-compose-debugging/)

Alpine Linux:

* [Alpine Linux](https://www.alpinelinux.org/)

Nginx:

* [NGINX Configuration Beginner's Guide](https://nginx.org/en/docs/beginners_guide.html)
* [OpenSSL Man Page](https://www.openssl.org/docs/man1.0.2/man1/openssl-req.html)
* [Generate Self-Signed SSL Certificate with OpenSSL](https://stackoverflow.com/a/10176685)

MariaDB:

* [How do I find the MySQL my.cnf location](https://stackoverflow.com/a/2485758)
* [How to Install and Configure Mariadb](https://www.rootusers.com/how-to-install-and-configure-mariadb/)
* [Configuring MariaDB with Option Files](https://mariadb.com/kb/en/configuring-mariadb-with-option-files/)
* [MariaDB Server System Variables](https://mariadb.com/kb/en/server-system-variables/)
* [Configuring MariaDB for Remote Client Access](https://mariadb.com/kb/en/configuring-mariadb-for-remote-client-access/)
* [How to Allow Remote Access to MariaDB in Ubuntu Linux](https://geekrewind.com/allow-remote-access-to-mariadb-database-server-on-ubuntu-18-04/)

WordPress:

* [PHP](https://www.php.net/)
* [Installing WordPress with curl and WP-CLI](https://make.wordpress.org/cli/handbook/guides/installing/)
* [WP-CLI Commands](https://developer.wordpress.org/cli/commands/)
* [WP-CLI Overview](https://jparks.work/index.php?title=Wp-cli)

---
Made by mcombeau: [email protected] | LinkedIn: [mcombeau](https://www.linkedin.com/in/mia-combeau-86653420b/) | Website: [codequoi.com](https://www.codequoi.com)