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

feat: 💥 new environment and volume var naming #1729

Merged
merged 122 commits into from
Sep 7, 2024
Merged

Conversation

nemchik
Copy link
Member

@nemchik nemchik commented Feb 19, 2024

Pull request

Purpose

  • Variable naming now tries to be <appname>_<section>_<varname> where <section> is new and mostly made up of either ENVIRONMENT or VOLUME
  • Nicer handling for VOLUME variables in scripts
  • Make the docker socket volume a variable for any app using it
  • Move global VPN variables to APPNAME_ prefixed variables
  • Azuracast has some breaking changes to variables to bring it more in-line with other app templates
  • Remove logging sections from all app templates (this simplifies the compose file and allows the user to configure a global default on their own or override individual apps easier)
  • Fixed an incorrectly used variable in AMD
  • Add Doplarr
  • Add FireflyIII
  • Add ports, vars, and tun device for Gluetun
  • Add Kitana
  • Remove unused password variable from Limnoria
  • Rename (and migrate) minecraft servers to remove _ from appnames
  • Deprecate Ouroboros
  • Add Overseerr
  • Add Petio
  • Deprecate Samba
  • Adjust wireguard server var naming slightly

Requirements
Check all boxes as they are completed

@nemchik nemchik requested review from a team as code owners February 19, 2024 02:35
@github-actions github-actions bot added ci Automatic label apps Automatic label docs Automatic label core Automatic label repo Automatic label labels Feb 19, 2024
@nemchik nemchik force-pushed the variable-naming branch 4 times, most recently from 1e4f054 to 76dc44d Compare February 19, 2024 03:13
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
nemchik and others added 9 commits February 22, 2024 20:46
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Fix `PLEX_ENVIRONMENT_CLAIM` TO `PLEX_ENVIRONMENT_PLEX_CLAIM`
Add the missing `gluetun` variables and ports, set to the defaults listed in the gluetun wiki.
CLHatch and others added 4 commits April 26, 2024 17:22
Change sorting of variables to sort using lower case, so that `_` sorts to the top.  This will allow using variables starting with `_` in other variable definitions, such as `VAR="This expands ${_VAR2}"`.

A variable must be defined BEFORE being expanded in another variable.
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
nemchik and others added 19 commits April 28, 2024 16:40
Remove extra newline at end of `.env.example`, add the newline in the app headings instead.

Fix up naming of variables slightly.

Select a heading format instead of the heading itself when looping between `BUILTIN` and `USER_DEFINED` headings.
Disable shellcheck error for variable in printf format string
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Signed-off-by: Eric Nemchik <eric@nemchik.com>
Co-authored-by: Eric Nemchik <eric@nemchik.com>
Co-authored-by: Eric Nemchik <eric@nemchik.com>
Remove `APPFOLDER` variable.
Remove commented `debug` line.
Add "APPNAME" headings in `.env`, and move the "migrate" logic into `appvars_create.sh`
@nemchik nemchik marked this pull request as ready for review September 7, 2024 22:42
@CLHatch CLHatch merged commit 370cc61 into master Sep 7, 2024
19 checks passed
@CLHatch CLHatch deleted the variable-naming branch September 7, 2024 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apps Automatic label ci Automatic label core Automatic label docs Automatic label repo Automatic label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants