User persistent docker-compose files

[fsackur]

Relates to #311

I create a docker-compose in the runtipi folder that mounts my /cellar volume:

# runtipi/docker-compose.filebrowser.yml
version: "3.7"
services:
  filebrowser:
    volumes:
      - /cellar:/srv/cellar

Filebrowser gets the volume:

PS ❯ $fb = docker inspect filebrowser | ConvertFrom-Json; $fb.Mounts | ft

Type   Source                                                                                         Destination   Mode   RW Propagation
----   ------                                                                                         -----------   ----   -- -----------
bind   /usr/bin/runtipi/app-data/filebrowser/data/db                                                  /database     rw   True rprivate
bind   /usr/bin/runtipi/app-data                                                                      /srv/app-data rw   True rprivate
bind   /cellar                                                                                        /srv/cellar   rw   True rprivate
bind   /usr/bin/runtipi/media                                                                         /srv/media    rw   True rprivate
volume /var/lib/docker/volumes/455f7ddd0802ea8527b3556a92b7bf8e26ab714eea27f7d9584528a1834d545d/_data /srv          z    True
bind   /usr/bin/runtipi/app-data/filebrowser/data/config                                              /config       rw   True rprivate

The web app shows my volume:

Note that my pihole app, whcih does not have a user docker-compose, is unaffected.

[meienberger]

This looks very useful thanks for your contribution. Will definitely include this in the next release.
May I ask you to start from the develop branch to avoid conflicts with the next release?

[fsackur]

Will do.

Question: do you think it would it be more user-friendly to have this structure:

runtipi
├───app-data
├───apps
└───user-config
    └───pihole
            app.env
            docker-compose.yml

That way the user can symlink user-config anywhere they like.

I did add the equivalent feature for app.env, I can include it in the PR.

[meienberger]

Will do.

Question: do you think it would it be more user-friendly to have this structure:

runtipi
├───app-data
├───apps
└───user-config
    └───pihole
            app.env
            docker-compose.yml

That way the user can symlink user-config anywhere they like.

I did add the equivalent feature for app.env, I can include it in the PR.

Would make sense yes so we can easily extend it to more override features in the future

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[fsackur]

Done!

Please note I didn't build the app - I just tested the script in my running installation. However, I'm able to configure:

• pihole address in user-config/pihole/app.env
• filebrowser mount in user-config/filebrowser/docker-compose.yml
• jellyfin mount in user-config/jellyfin/docker-compose.yml

[meienberger]

Tested locally works fine! If you have the time, could you add a section in the wiki explaining how to use this feature?