linuxserver / docker-bookstack

A Docker container for the BookStack documentation wiki
GNU General Public License v3.0
725 stars 105 forks source link

Implemented dynamic substitution of environment variables for S3 storage configuration #208

Closed caporro closed 4 months ago

caporro commented 4 months ago

linuxserver.io



Description:

This commit introduces support for configuring S3 storage directly through environment variables, streamlining the process of integrating S3 as the storage backend for the application. By leveraging environment variables, users can now dynamically set S3-related configuration parameters such as the S3 bucket name, access key, secret key, region, and endpoint. This enhancement simplifies the deployment and configuration process, making it more flexible and adaptable to various deployment environments. The implementation ensures that these configurations can be easily managed without hardcoding values, providing a secure and scalable way to manage storage settings. This change is particularly beneficial for cloud-native deployments where environment variables are a standard method for configuration.

Benefits of this PR and context:

How Has This Been Tested?

Source / References:

LinuxServer-CI commented 4 months ago
I am a bot, here are the test results for this PR: https://ci-tests.linuxserver.io/lspipepr/bookstack/v24.02-pkg-18067041-dev-b993f98f36a405daedac8b2af86b665c06fb4728-pr-208/index.html https://ci-tests.linuxserver.io/lspipepr/bookstack/v24.02-pkg-18067041-dev-b993f98f36a405daedac8b2af86b665c06fb4728-pr-208/shellcheck-result.xml Tag Passed
amd64-v24.02-pkg-18067041-dev-b993f98f36a405daedac8b2af86b665c06fb4728-pr-208
arm64v8-v24.02-pkg-18067041-dev-b993f98f36a405daedac8b2af86b665c06fb4728-pr-208
ssddanbrown commented 4 months ago

Not sure why this PR is needed, you should be able to just add these to the docker environment anyway, or add them to the .env file yourself.

caporro commented 4 months ago

You're absolutely right, upon further reflection on your explanation and the current operation of the entrypoint, I realize that my proposal does not substantially add value to the existing configuration process. The ability to directly set environment variables through Docker or manually modify the .env file indeed covers the need for configuration in an already effective and flexible way.

I appreciate the time you took to review my pull request and I apologize for the misunderstanding. Thank you for providing further clarification on how the Docker image's environment configuration works. I will be more careful in my future contributions.