avesit/filesender repository overview

⁠filesender-phpfpm

• Introduction⁠
• Dependencies⁠
• Environment Variables⁠
• Deployment⁠
  • simplesamlphp⁠

⁠Introduction

Docker⁠ image of filesender⁠ ran within php-fpm⁠, especially tuned for consumption into Kubernetes. All images are based off of debian⁠ stable.

This is a follow-up of ualibraries⁠. Automated builds will be available at Docker hub.

This release⁠ of filesender can use simplesamlphp⁠ or shibboleth-sp⁠ for authentication. Questions directly related on using or configuring filesender should get posted to it's mailinglist⁠.

This docker image is not meant to run on its own, as it has some dependencies missing. Especially, this image only provides PHP-FPM with simplesamlphp and filesender installed.

⁠Dependencies

This container image of filesender requires the following dependencies:

⁠Environmental dependencies

1. An (external) IP address
2. A (public) DNS entry
3. Sufficient storage capacity to store uploaded files for their lifetime`

⁠External services

1. An smtp⁠ server to send emails. For example a third party SMTP service or a company email server could be used.
2. A reverse proxy⁠ that can handle FPM. Haproxy or Nginx would be suitable candidates
3. An SSL certificate⁠ to make the service available via https/ssl
4. A database engine⁠ to store application data in. Currently supported is mysql/pgsql.

All dependencies are provided using the helm⁠ chart located in TODO

⁠Environment Variables

The following environment variables control the container setup:

⁠Configuration

The following table lists the configurable parameters of the container and their default values.

These variables are set using the setup.sh⁠ script, which runs in the filesender-phpfpm docker container the first time it starts up from the location /setup.sh.