Skip to content

USER_DOC.md

Latest commit

 

History

History
195 lines (124 loc) · 2.9 KB

USER_DOC.md

File metadata and controls

195 lines (124 loc) · 2.9 KB

USER DOCUMENTATION

Overview

This document explains how to use and operate the Inception infrastructure from a user or administrator perspective.

The project provides a containerized web infrastructure running on a virtual machine, composed of multiple independent services managed with Docker Compose.

Provided Services

WordPress Website

  • Main application
  • Served securely over HTTPS
  • Backed by a MariaDB database
  • Uses Redis for caching

Adminer

  • Web-based database administration tool
  • Allows inspection and management of the MariaDB database

Static Website

  • Simple static page served from a dedicated NGINX container
  • Independent from WordPress

FTP Server

  • Provides file access to WordPress files
  • Useful for uploading or managing content

Monitoring

  • Prometheus provides a web interface to observe system and container metrics
  • Node Exporter collects host metrics internally

Starting and Stopping the Project

Start the infrastructure

From the root of the project:

make

This command builds all Docker images and starts the containers.

Stop the infrastructure

To stop all running containers without deleting data:

make down

Full cleanup (optional)

To remove containers, images, and stored data:

make fclean

⚠️ This will delete all persistent data.

Accessing the Services

WordPress

  • URL:

    https://mohhusse.42.fr

Adminer

  • URL:

    http://localhost:8080

  • Database server: mariadb

Static Website

  • URL:

    http://localhost:8081

FTP Server

  • Host: localhost
  • Port: 21
  • Mode: Passive
  • Username: ftpuser
  • Password: ftppassword
  • Accessible directory: WordPress root files

Monitoring (Prometheus)

  • URL:

    http://localhost:9090

Prometheus provides system and container metrics for monitoring purposes.

Data Storage

All persistent data is stored on the host machine under:

/home/$USER/data

WordPress files

/home/$USER/data/wordpress

MariaDB database

/home/$USER/data/mariadb

These directories remain intact across container restarts.

Checking Service Status

To see running containers:

docker compose ps

To view logs for a specific service:

docker logs <service_name>

Example:

docker logs wordpress

Notes

  • NGINX is the only HTTPS entrypoint.
  • Internal services (MariaDB, Redis, Node Exporter) are not exposed publicly.
  • FTP and Adminer are bonus services and use separate ports.
  • Monitoring is read-only and does not affect application behavior.

Troubleshooting

If a service is not accessible:

  1. Ensure containers are running using docker compose ps

  2. Check logs using docker logs

  3. Restart the stack if needed:

    make down
make