diff --git a/CONTEXT.md b/CONTEXT.md new file mode 100644 index 000000000..3ce0b3616 --- /dev/null +++ b/CONTEXT.md @@ -0,0 +1,36 @@ +# Project Context & Configuration + +## 🛠️ Environment & Tech Stack +- **Containerization:** **Podman** + + +## Directory Structure & Key Files +- `CONTEXT.md`, this file +- `README.md` of the WebGUI project +- `distribution/docker-compose.yml` Current orchestration +- `Dockerfile` - the Dockerfile of the WebGUI container +- the custom folder contains all files related to custom modules add to WebGUI +- the distribution folder contains +- - `nginx/nginx.conf` - configuration file for nginx in seperate pod +- - `share/create.sql` - the create database file so mariadb can function as a database service for WebGUI +- - `webgui/entrypoint` - the script that runs when the WebGUI service starts +- - `webgui/modperl.pl` - an apache2 webserver configuration script used by WebGUI +- - `webgui/webgui.conf` - an apache2 webserver configuration file for WebGUI +- - `webgui/www.example.com/conf` - an example configuration file for a specific domain to use WebGUI +- the `docs` folder is part of the WebGUI system, it contains +- - the changelogs, the upgrade scripts, several database dumps and descriptive files +- the `etc` contains the configuration files for the domains that use WebGUI +- the `lib` folder contains all the WebGUI code +- the `sbin` folder contains WebGUI helper scripts +- the `share` folder contains several files for the WebGUI service and the nginx reverse proxy service to work in conjunction +- the `t` folder contains WebGUI tests +- the `www` folder contains static files served by WebGUI + + +### 1. Current project goals +- part of this repository is WebGUI, as described in README.md +- right now, we are not concerned with changeing the WebGUI codebase +- currently the only goal is to optimize the build process of WebGUI in a podman pod and +- the orchestration so the WebGUI service runs well configured with +- mariadb database service and +- nginx reverse proxy \ No newline at end of file diff --git a/distribution/webgui/entrypoint b/distribution/webgui/entrypoint index 64e5c7ff7..9a0c73aec 100644 --- a/distribution/webgui/entrypoint +++ b/distribution/webgui/entrypoint @@ -1,6 +1,6 @@ #!/bin/bash -# script that runs when the docker container starts +# script that runs when the podman container starts echo "Starting WebGUI entrypoint script with:" perl -Ilib sbin/wgd ls echo "Starting WebGUI entrypoint script..."