Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Refactor docker-compose to simplify installation experience #160

Merged
merged 20 commits into from
Oct 29, 2024

Conversation

ppawlowski
Copy link
Contributor

Description

This pull request refactors the 'main' docker compose file used for FlowFuse installation on self-hosted environments. Additionally, it introduces:

  • .env.example file for persistent configuration
  • docker-compose-tls.override.yml file for TLS management

Included changes should be merged together with FlowFuse/flowfuse#4665

Related Issue(s)

FlowFuse/flowfuse#4633

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production

Labels

  • Includes a DB migration? -> add the area:migration label

Copy link
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The upgrade instructions are going to be interesting with the changes to named volumes over local directories.

How will an exisiting user upgrade and keep using the local directories or copy them to the named volumes?

docker-compose.yml Show resolved Hide resolved
@ppawlowski
Copy link
Contributor Author

The upgrade instructions are going to be interesting with the changes to named volumes over local directories.

How will an exisiting user upgrade and keep using the local directories or copy them to the named volumes?

I added upgrade instructions which I tested beforehand. Feel free to verify them on your end as well.

@ppawlowski ppawlowski marked this pull request as draft October 22, 2024 20:43
@ppawlowski ppawlowski requested a review from hardillb October 23, 2024 12:03
@ppawlowski ppawlowski marked this pull request as ready for review October 23, 2024 12:03
Copy link
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Only question, where is TLS_ENABLED set? I only see it mentioned in the docker-compose.yml but not anywhere else

@ppawlowski
Copy link
Contributor Author

Only question, where is TLS_ENABLED set? I only see it mentioned in the docker-compose.yml but not anywhere else

Added to .env.example to avoid confusion.

@ppawlowski ppawlowski requested a review from hardillb October 27, 2024 19:11
@ppawlowski
Copy link
Contributor Author

@hardillb I've extended compose file and added the possibility to configure smtp settings. Please review one more time.

@ppawlowski ppawlowski merged commit 4b6ad4c into main Oct 29, 2024
@ppawlowski ppawlowski deleted the chore-main-compose-refactor branch October 29, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants