docs(redmine): Add How-To for Custom Theme (#15120)

**Description** Had to create a branch since initial docs file had spaces ⚒️ Fixes #  **⚙️ Type of change** - [X] ⚙️ 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 - [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` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: Dennis <dennis.yaskevich@proton.me> Co-authored-by: Dennis <dennis.yaskevich@proton.me>
2023-11-24 13:50:20 -05:00
parent 9dea0cee6d
commit 10c6e0335e
7 changed files with 117 additions and 0 deletions
@@ -0,0 +1,117 @@
+# How to install the custom theme with PVC storage
+
+This tutorial explains installing the [PurpleMine2](https://github.com/mrliptontea/PurpleMine2) theme for the Redmine app installed from the TrueCharts catalog.
+
+## Setup configuration
+
+Default configuration with PVC storage
+
+Add additional app storage as PVC with Mount path `/usr/src/redmine/public/themes`
+
+![image](img/image1.png)
+
+You might also want to add `/usr/src/redmine/plugins` folder as PVC mount. This is the folder where you need to unzip your plugins if you want to use some.
+
+As of the time of writing the app is not running normally when created with settings RunAsUser 568 RunAsGroup 568
+
+![image](img/image2.png)
+
+changing the configuration to RunAsUser 999 RunAsGroup 999 solves the issue. Check this ticket for details
+
+https://github.com/truecharts/charts/issues/15079
+
+Click on Save. Wait for the app to deploy.
+
+Open the app. Login with default credentials
+
+- `User: admin`
+- `Password: admin`
+
+You will be prompted to change the password.
+
+Go to `Administration->Settings->Display`. See that the only available theme is Default.
+
+## Mount PVC volumes using HeavyScript
+
+Now you can close the Redmine webpage and open the TrueNAS shell.
+
+We will need to mount the PVC volumes using the HevyScript. If you don't have HeavyScript installed simply run this command to install it
+
+```
+sudo curl -s https://raw.githubusercontent.com/Heavybullets8/heavy_script/main/functions/deploy.sh | bash && source "$HOME/.bashrc" 2>/dev/null && source "$HOME/.zshrc" 2>/dev/null
+```
+
+More details on what it does here: https://github.com/Heavybullets8/heavy_script
+
+then run
+
+```
+sudo heavyscript
+```
+
+Application Options -> Mount Unmount PVC storage -> Mount -> Redmine
+
+Would you like to mount anything else? (y/N): n
+
+## Use Moonlight Commander to copy the themes into the mounted volume
+
+Now the redmine themes folder is available as the system path and we need to copy the theme files there.
+
+I have already SMB Share setup so I copy the files into the SMB share. You can use Filebrowser app to upload the theme as well.
+
+So I'm downloading the theme from https://github.com/mrliptontea/PurpleMine2
+
+And Unzip it to my SMB share folder.
+
+Now in TrueNas shell I use
+```
+sudo mc
+```
+
+To launch the moonlight commander app. I navigate to my SMB share and to the mounted PVC path and copy the files over
+
+![image](img/image3.png)
+
+## Change permissions of the themes files
+
+Now we need to exit moonlight commander and navigate to the mounted themes folder in console using
+
+```
+cd /mnt/mounted_pvc/redmine/redmine-persist-list-0
+ls - la
+```
+
+![image](img/image4.png)
+
+I also copied the standard Redmine themes alternate and classic to this folder
+
+But you can see that all of the copied files are owned by my user and the group root. This means the Redmine will not be able to access the files.
+
+Chage the owner of the files with the following command
+
+```
+sudo chown -R root:apps PurpleMine2-master
+sudo chmod -R 775 PurpleMine2-master 
+```
+
+Repeat this commands for every theme folder you copied. And double check that owner have been changed and the permissions applied
+
+![image](img/image5.png)
+
+## Unmount volumes and launch the app
+
+Now you can unmount the volume using HeavyScript command
+
+```
+sudo heavyscript pvc --unmount redmine
+```
+
+Now run the application using `sudo heavyscript` Application Options -> Start Application -> Redmine
+
+## Apply the theme
+
+Open the Redmine web page. Sign in with your new password for Admin.
+
+Go to Administration -> Settings -> Display. Pick the newly added theme
+
+![image](img/image6.png)