Merge pull request #1 from froxlor/fix/refactoring

Refator stunnel and docs; merge environment variables

Author: envoyr

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.gitignore

@@ -1,6 +1,7 @@
 /.idea
 /database
+/froxlor
 /redis
 .env
 docker-compose.yml
-froxlor.env
+froxlor.env

DEVELOPERS.md

@@ -0,0 +1,162 @@
+# Developer Guide
+
+This guide describes how to set up a local development environment for the froxlor container and how to mount 
+additional packages during development.
+
+## Directory Structure
+
+A typical local development setup may look like this:
+
+```text
+.
+├── container
+├── froxlor
+├── framework
+└── example-package
+```
+
+In this layout:
+
+* `container` contains the Docker setup.
+* `froxlor` contains the froxlor application.
+* `framework` contains the froxlor framework package.
+* `example-package` contains an additional package under development.
+
+## Docker Compose
+
+The following `docker-compose.yml` example can be used for local development.
+
+```yaml
+services:
+    froxlor:
+        image: hub.froxlor.io/froxlor/froxlor:latest
+        build: .
+        restart: unless-stopped
+        privileged: true
+        pid: "host"
+        depends_on:
+            db:
+                condition: service_healthy
+            redis:
+                condition: service_healthy
+            adminer:
+                condition: service_started
+        ports:
+            - "8000:8000"
+        # Use the environment and/or the env_file as you like
+        environment:
+            FROXLOR_DB_CONNECTION: mariadb
+            FROXLOR_DB_HOST: db
+            FROXLOR_DB_PORT: 3306
+            FROXLOR_DB_DATABASE: froxlor
+            FROXLOR_DB_USERNAME: froxlor
+            FROXLOR_DB_PASSWORD: CHANGEM3
+        env_file:
+            -   path: ../froxlor/.env
+                required: false
+        volumes:
+            - ../froxlor:/var/www/html/froxlor
+            - ../framework:/opt/froxlor/packages/framework
+    db:
+        image: mariadb:latest
+        restart: unless-stopped
+        environment:
+            MARIADB_ROOT_PASSWORD: CHANGEM3
+            MARIADB_DATABASE: froxlor
+            MARIADB_USER: froxlor
+            MARIADB_PASSWORD: CHANGEM3
+        healthcheck:
+            test: [ "CMD", "healthcheck.sh", "--connect", "--innodb_initialized" ]
+            start_period: 30s
+            interval: 10s
+            timeout: 5s
+            retries: 5
+        volumes:
+            - database:/var/lib/mysql
+    redis:
+        image: redis:latest
+        restart: unless-stopped
+        healthcheck:
+            test: [ "CMD", "redis-cli", "ping" ]
+            start_period: 5s
+            interval: 10s
+            timeout: 5s
+            retries: 5
+        volumes:
+            - redis:/data
+    adminer:
+        image: adminer:latest
+        restart: unless-stopped
+        ports:
+            - "8080:8080"
+        depends_on:
+            - db
+volumes:
+    database:
+    redis:
+```
+
+> [!WARNING]
+> This development setup runs the froxlor container in privileged mode and uses the host PID namespace. Use this 
+> configuration only in trusted local development environments.
+
+## Start the Development Environment
+
+Start all services with:
+
+```bash
+docker compose up -d
+```
+
+After the services have started, open froxlor in your browser:
+
+```text
+http://localhost:8000
+```
+
+Adminer is available at:
+
+```text
+http://localhost:8080
+```
+
+## Package Development
+
+Additional packages can be mounted into the container under `/opt/froxlor/packages`.
+
+For example, to develop an additional package named `example-package`, add it as a volume:
+
+```yaml
+services:
+  froxlor:
+    # ...
+    environment:
+        FROXLOR_DEV_REPOSITORIES: framework,example-package
+        FROXLOR_DEV_PACKAGES: froxlor/example-package
+    volumes:
+      - ../froxlor:/var/www/html/froxlor
+      - ../framework:/opt/froxlor/packages/framework
+      - ../example-package:/opt/froxlor/packages/example-package
+```
+
+## Helpful Commands
+
+Here you'll find a list of helpful commands that you might need to use sometimes because of certain edge cases.
+
+### Database migration and seeding
+
+If you mount the source code without an existing database, startup may fail because database initialization will not 
+run when the source code is present. To migrate and seed the database, run the following command:
+
+```shell
+docker compose run froxlor php artisan migrate:fresh --seed
+```
+
+### Usage of Composer
+
+Sometimes you may wish to use Composer without using froxlor's package management. This can easily be done with the
+following command:
+
+```shell
+docker compose run froxlor composer <...>
+```

Dockerfile

@@ -1,26 +1,31 @@
 FROM hub.froxlor.io/laravel/container:8.5-octane-minimal
 
-LABEL maintainer="froxlor team <team@froxlor.org>"
+LABEL maintainer="froxlor Team <team@froxlor.org>"
 LABEL org.opencontainers.image.title="froxlor Container"
 LABEL org.opencontainers.image.description="froxlor container image for Docker, Kubernetes, and other container platforms."
 LABEL org.opencontainers.image.source=https://github.com/froxlor/container
 LABEL org.opencontainers.image.licenses=LGPL-2.1-only
 
 # Set working directory inside container
+RUN git config --global --add safe.directory /var/www/html/froxlor
 WORKDIR /var/www/html/froxlor
 
 # Install openssl and stunnel for SSL termination
 RUN apk add --no-cache openssl stunnel
 
-# Expose ports
-EXPOSE 8443
+# Copy scripts
+COPY bin/ /opt/froxlor/bin/
 
-# Copy the entrypoint script
+# Copy entrypoint script
 COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 
 # Set entrypoint
 ENTRYPOINT ["/entrypoint.sh"]
 
+# Expose ports
+EXPOSE 8000
+EXPOSE 8443
+
 # Default command to run froxlor server
 CMD ["composer", "run", "serve"]