dev: clean and add README.md

This commit is contained in:
mcolonna 2025-07-31 00:13:54 +02:00
parent f189d44da2
commit 1ddf316c87
2 changed files with 18 additions and 1 deletions

17
README.md Normal file
View file

@ -0,0 +1,17 @@
# inception
a project for the 42 school. it's a docker compose that builds and runs a wordpress website.
# how to use
- copy env_template to env and change the values as you want.
- DOMAIN is the domain used in the SSL certificate used (that will be self-signed).
you can use whatever
- VOLUMES_PATH is the path where the volumes (all the website's data) will be saved. you probably want to set an absolute path
- you might have problems reading/writing in that path if you're not root
- build and run the docker using `$ make`
- connect to https://localhost:4433/ with your favorite browser
- it will show a warning as the SSL certificate is not valid. it's normal, it's a self-signed certificate. ignore
- if it's your first time running it, it will ask you to configure the wordpress website. do that
- you have your wordpress website :)
- you can stop the docker wherever you want using ctrl-C on the terminal
- to run it again, just use `$ make` again

View file

@ -1,4 +1,4 @@
DOMAIN=mcolonna.42.fr DOMAIN=example.com
DATABASE_PWD=[insert_cool_password_here] DATABASE_PWD=[insert_cool_password_here]
DATABASE_PWD_ROOT=[insert_other_cool_password_here] DATABASE_PWD_ROOT=[insert_other_cool_password_here]
VOLUMES_PATH=[insert_absolute_path] VOLUMES_PATH=[insert_absolute_path]