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

Docs(qBitrr): update installation-notes.md #14091

Merged
merged 9 commits into from
Nov 5, 2023
Merged

Docs(qBitrr): update installation-notes.md #14091

merged 9 commits into from
Nov 5, 2023

Conversation

Tanguille
Copy link
Contributor

Description

Added some explanation since I failed to configure qBitrr properly following this installation-notes. I assume something changed upstream which added a .config directory inside the config directory which now both have config.toml but only the one in .config actually applying. However if @kqmaverick installs the chart he doesn't seem to get the .config directory while I did on 2 instances I tested. I guess some more testing is required on why this is happening.

⚒️ Fixes outdated installation-notes

⚙️ Type of change

  • ⚙️ Feature/App addition
  • 🪛 Bugfix
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🔃 Refactor of current code

🧪 How Has This Been Tested?

📃 Notes:

✔️ Checklist:

  • ⚖️ My code follows the style guidelines of this project
  • 👀 I have performed a self-review of my own code
  • #️⃣ I have commented my code, particularly in hard-to-understand areas
  • 📄 I have made corresponding changes to the documentation
  • ⚠️ My changes generate no new warnings
  • 🧪 I have added tests to this description that prove my fix is effective or that my feature works
  • ⬆️ I increased versions for any altered app according to semantic versioning

➕ App addition

If this PR is an app addition please make sure you have done the following.

  • 🪞 I have opened a PR on truecharts/containers adding the container to TrueCharts mirror repo.
  • 🖼️ I have added an icon in the Chart's root directory called icon.png

Tanguille and others added 5 commits September 9, 2023 15:41
Added Caution that the domain used  may not be a behind proxy because I had that exact issue after setting up wg-easy based on this guide.

Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
Signed-off-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>
Added some explanation since I failed to configure qBitrr properly following this installation-notes.

Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
@Tanguille Tanguille requested review from Ornias1993 and a team as code owners October 29, 2023 13:30
@kqmaverick
Copy link
Collaborator

The config.toml location changes based on a bluefin or cobia install. Any possible insights @stavros-k ?

Bluefin = /config/config.toml
Cobia = /config/.config/config.toml

@Tanguille
Copy link
Contributor Author

Do I adjust this PR to match #14103?

@kqmaverick
Copy link
Collaborator

Yes you can remove all the /.config stuff

The .config directory will no longer exists once #14103 is merged hence I adjusted the installation notes according to this.

Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
@stavros-k stavros-k merged commit 6d4ce9a into truecharts:master Nov 5, 2023
15 checks passed
@stavros-k
Copy link
Member

@all-contributors please add @Tanguille for docs

Copy link
Contributor

@stavros-k

I've put up a pull request to add @Tanguille! 🎉

stavros-k pushed a commit that referenced this pull request Nov 5, 2023
Adds @Tanguille as a contributor for doc.

This was requested by stavros-k [in this
comment](#14091 (comment))

[skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
StevenMcElligott added a commit to StevenMcElligott/TrueChartsCharts that referenced this pull request Nov 11, 2023
**Description**

Added some explanation since I failed to configure qBitrr properly
following this installation-notes. I assume something changed upstream
which added a `.config` directory inside the `config` directory which
now both have `config.toml` but only the one in `.config` actually
applying. However if @kqmaverick installs the chart he doesn't seem to
get the `.config` directory while I did on 2 instances I tested. I guess
some more testing is required on why this is happening.

⚒️ Fixes outdated installation-notes

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
I double checked with 2 instances and asked community feedback on their
experience.
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [X] ⚖️ My code follows the style guidelines of this project
- [X] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [X] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

---------

Signed-off-by: Tanguille <91473554+Tanguille@users.noreply.github.com>
Signed-off-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>
Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>
StevenMcElligott pushed a commit to StevenMcElligott/TrueChartsCharts that referenced this pull request Nov 11, 2023
Adds @Tanguille as a contributor for doc.

This was requested by stavros-k [in this
comment](truecharts#14091 (comment))

[skip ci]

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
@truecharts-admin
Copy link
Collaborator

This PR is locked to prevent necro-posting on closed PRs. Please create a issue or contact staff on discord if you want to further discuss this

@truecharts truecharts locked as resolved and limited conversation to collaborators Nov 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants